com.esri.arcgis.system
Class CoRESTResource

java.lang.Object
  com.esri.arcgis.system.CoRESTResource

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IRESTResource, Serializable

public class CoRESTResource
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRESTResource

IRESTResource coclass

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

CoRESTResource()
Constructs a CoRESTResource using ArcGIS Engine.

CoRESTResource(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CoRESTResource theCoRESTResource = (CoRESTResource) obj;

Method Summary

void	addOperation(IRESTOperation o) Adds child operation.
void	addResource(IRESTResource r) Adds child resource.
boolean	equals(Object o) Compare this object with another
IRESTOperation	findChildOperation(String name) Finds child operation, non-recursive.
IRESTResource	findChildResource(String name) Finds child resource, non-recursive.
static String	getClsid() getClsid.
String	getName() Resource name.
IEnumRESTOperation	getOperations() Returns enumerator for operations.
String	getRequiredCapability() Required capability for the resource.
IEnumRESTResource	getResources() Returns enumerator for immediate child resources.
int	hashCode() the hashcode for this object
boolean	isCollection() Specifies collection resource.
boolean	isDefaultCollection() Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.
boolean	isStatic() This flag marks resources that do not change over time.
boolean	isSupportsETag() This flag is only for a root level resource.
void	setIsCollection(boolean value) Specifies collection resource.
void	setIsDefaultCollection(boolean value) Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.
void	setIsStatic(boolean value) This flag marks resources that do not change over time.
void	setName(String name) Resource name.
void	setRequiredCapability(String capability) Required capability for the resource.
void	setSupportsETag(boolean value) This flag is only for a root level resource.
IJSONObject	toJSONObject() Converts resource object to JSON representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

CoRESTResource

public CoRESTResource()
               throws IOException,
                      UnknownHostException

Constructs a CoRESTResource using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CoRESTResource

public CoRESTResource(Object obj)
               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CoRESTResource theCoRESTResource = (CoRESTResource) obj;

Construct a CoRESTResource using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to CoRESTResource.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

Resource name. Used in IRESTRequestHandler's schema generation and url parsing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getName in interface IRESTResource

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCollection

public boolean isCollection()
                     throws IOException,
                            AutomationException

Specifies collection resource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isCollection in interface IRESTResource

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDefaultCollection

public boolean isDefaultCollection()
                            throws IOException,
                                   AutomationException

Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isDefaultCollection in interface IRESTResource

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStatic

public boolean isStatic()
                 throws IOException,
                        AutomationException

This flag marks resources that do not change over time.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isStatic in interface IRESTResource

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsETag

public boolean isSupportsETag()
                       throws IOException,
                              AutomationException

This flag is only for a root level resource. If this flag is true, IRRH implementation supports ETag.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSupportsETag in interface IRESTResource

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequiredCapability

public String getRequiredCapability()
                             throws IOException,
                                    AutomationException

Required capability for the resource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getRequiredCapability in interface IRESTResource

Returns:

The capability

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Resource name. Used in IRESTRequestHandler's schema generation and url parsing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setName in interface IRESTResource

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsCollection

public void setIsCollection(boolean value)
                     throws IOException,
                            AutomationException

Specifies collection resource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setIsCollection in interface IRESTResource

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDefaultCollection

public void setIsDefaultCollection(boolean value)
                            throws IOException,
                                   AutomationException

Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setIsDefaultCollection in interface IRESTResource

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsStatic

public void setIsStatic(boolean value)
                 throws IOException,
                        AutomationException

This flag marks resources that do not change over time.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setIsStatic in interface IRESTResource

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsETag

public void setSupportsETag(boolean value)
                     throws IOException,
                            AutomationException

This flag is only for a root level resource. If this flag is true, IRRH implementation supports ETag.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSupportsETag in interface IRESTResource

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequiredCapability

public void setRequiredCapability(String capability)
                           throws IOException,
                                  AutomationException

Required capability for the resource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setRequiredCapability in interface IRESTResource

Parameters:

capability - The capability (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toJSONObject

public IJSONObject toJSONObject()
                         throws IOException,
                                AutomationException

Converts resource object to JSON representation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

toJSONObject in interface IRESTResource

Returns:

A reference to a com.esri.arcgis.system.IJSONObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addResource

public void addResource(IRESTResource r)
                 throws IOException,
                        AutomationException

Adds child resource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addResource in interface IRESTResource

Parameters:

r - A reference to a com.esri.arcgis.system.IRESTResource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addOperation

public void addOperation(IRESTOperation o)
                  throws IOException,
                         AutomationException

Adds child operation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addOperation in interface IRESTResource

Parameters:

o - A reference to a com.esri.arcgis.system.IRESTOperation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findChildResource

public IRESTResource findChildResource(String name)
                                throws IOException,
                                       AutomationException

Finds child resource, non-recursive.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

findChildResource in interface IRESTResource

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.system.IRESTResource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findChildOperation

public IRESTOperation findChildOperation(String name)
                                  throws IOException,
                                         AutomationException

Finds child operation, non-recursive.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

findChildOperation in interface IRESTResource

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.system.IRESTOperation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResources

public IEnumRESTResource getResources()
                               throws IOException,
                                      AutomationException

Returns enumerator for immediate child resources.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getResources in interface IRESTResource

Returns:

A reference to a com.esri.arcgis.system.IEnumRESTResource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperations

public IEnumRESTOperation getOperations()
                                 throws IOException,
                                        AutomationException

Returns enumerator for operations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getOperations in interface IRESTResource

Returns:

A reference to a com.esri.arcgis.system.IEnumRESTOperation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.