com.esri.arcgis.system

Class CoRESTResource

java.lang.Object

com.esri.arcgis.system.CoRESTResource

All Implemented Interfaces:

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

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

COM Class 'CoRESTResource'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'IRESTResource coclass' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.system.IRESTResource

IID, IIDb5561ea3_2950_4e21_9e4f_b1003b2a1baf, xxDummy

Constructor Summary

Constructors

Constructor and Description
CoRESTResource() Constructs a CoRESTResource using ArcGIS Engine.
CoRESTResource(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. CoRESTResource theCoRESTResource = (CoRESTResource) obj;

Method Summary

Modifier and Type	Method and Description
void	addOperation(IRESTOperation o) Adds child operation.
void	addResource(IRESTResource r) Adds child resource.
boolean	equals(java.lang.Object o) Compare this object with another
IRESTOperation	findChildOperation(java.lang.String name) Finds child operation, non-recursive.
IRESTResource	findChildResource(java.lang.String name) Finds child resource, non-recursive.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getName() Resource name.
IEnumRESTOperation	getOperations() Returns enumerator for operations.
java.lang.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	release() Release this COM object reference
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(java.lang.String name) Resource name.
void	setRequiredCapability(java.lang.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

Constructor Detail

CoRESTResource

public CoRESTResource()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a CoRESTResource using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CoRESTResource

public CoRESTResource(java.lang.Object obj)
               throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

getName in interface IRESTResource

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCollection

public boolean isCollection()
                     throws java.io.IOException,
                            AutomationException

Specifies collection resource.

Specified by:

isCollection in interface IRESTResource

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDefaultCollection

public boolean isDefaultCollection()
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

isDefaultCollection in interface IRESTResource

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStatic

public boolean isStatic()
                 throws java.io.IOException,
                        AutomationException

This flag marks resources that do not change over time.

Specified by:

isStatic in interface IRESTResource

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsETag

public boolean isSupportsETag()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

isSupportsETag in interface IRESTResource

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequiredCapability

public java.lang.String getRequiredCapability()
                                       throws java.io.IOException,
                                              AutomationException

Required capability for the resource.

Specified by:

getRequiredCapability in interface IRESTResource

Returns:

The capability

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

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

Specified by:

setName in interface IRESTResource

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsCollection

public void setIsCollection(boolean value)
                     throws java.io.IOException,
                            AutomationException

Specifies collection resource.

Specified by:

setIsCollection in interface IRESTResource

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDefaultCollection

public void setIsDefaultCollection(boolean value)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

setIsDefaultCollection in interface IRESTResource

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsStatic

public void setIsStatic(boolean value)
                 throws java.io.IOException,
                        AutomationException

This flag marks resources that do not change over time.

Specified by:

setIsStatic in interface IRESTResource

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsETag

public void setSupportsETag(boolean value)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setSupportsETag in interface IRESTResource

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequiredCapability

public void setRequiredCapability(java.lang.String capability)
                           throws java.io.IOException,
                                  AutomationException

Required capability for the resource.

Specified by:

setRequiredCapability in interface IRESTResource

Parameters:

capability - The capability (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toJSONObject

public IJSONObject toJSONObject()
                         throws java.io.IOException,
                                AutomationException

Converts resource object to JSON representation.

Specified by:

toJSONObject in interface IRESTResource

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addResource

public void addResource(IRESTResource r)
                 throws java.io.IOException,
                        AutomationException

Adds child resource.

Specified by:

addResource in interface IRESTResource

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addOperation

public void addOperation(IRESTOperation o)
                  throws java.io.IOException,
                         AutomationException

Adds child operation.

Specified by:

addOperation in interface IRESTResource

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findChildResource

public IRESTResource findChildResource(java.lang.String name)
                                throws java.io.IOException,
                                       AutomationException

Finds child resource, non-recursive.

Specified by:

findChildResource in interface IRESTResource

Parameters:

name - The name (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findChildOperation

public IRESTOperation findChildOperation(java.lang.String name)
                                  throws java.io.IOException,
                                         AutomationException

Finds child operation, non-recursive.

Specified by:

findChildOperation in interface IRESTResource

Parameters:

name - The name (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResources

public IEnumRESTResource getResources()
                               throws java.io.IOException,
                                      AutomationException

Returns enumerator for immediate child resources.

Specified by:

getResources in interface IRESTResource

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperations

public IEnumRESTOperation getOperations()
                                 throws java.io.IOException,
                                        AutomationException

Returns enumerator for operations.

Specified by:

getOperations in interface IRESTResource

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.