com.esri.arcgis.system

Interface IRESTResource

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CoRESTResource, IRESTResourceProxy

public interface IRESTResource
extends java.io.Serializable

COM Interface 'IRESTResource'. Generated 9/21/2023 10:01:45 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description: 'REST resource metadata object.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDb5561ea3_2950_4e21_9e4f_b1003b2a1baf
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	addOperation(IRESTOperation o) Adds child operation.
void	addResource(IRESTResource r) Adds child resource.
IRESTOperation	findChildOperation(java.lang.String name) Finds child operation, non-recursive.
IRESTResource	findChildResource(java.lang.String name) Finds child resource, non-recursive.
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.
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(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.

Field Detail

IIDb5561ea3_2950_4e21_9e4f_b1003b2a1baf

static final int IIDb5561ea3_2950_4e21_9e4f_b1003b2a1baf

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

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

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

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCollection

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

Specifies collection resource.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDefaultCollection

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

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

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStatic

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

This flag marks resources that do not change over time.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsETag

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.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRequiredCapability

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

Required capability for the resource.

Returns:

The capability

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

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

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsCollection

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

Specifies collection resource.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsDefaultCollection

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.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsStatic

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

This flag marks resources that do not change over time.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsETag

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.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRequiredCapability

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

Required capability for the resource.

Parameters:

capability - The capability (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toJSONObject

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

Converts resource object to JSON representation.

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

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

Adds child resource.

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

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

Adds child operation.

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

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

Finds child resource, non-recursive.

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

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

Finds child operation, non-recursive.

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

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

Returns enumerator for immediate child resources.

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

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

Returns enumerator for operations.

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.