com.esri.arcgis.system
Interface IRESTResource

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoRESTResource

public interface IRESTResource
extends Serializable

REST resource metadata object.

Product Availability

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

Method Summary

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

Method Detail

getName

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.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCollection

boolean isCollection()
                     throws IOException,
                            AutomationException

Specifies collection resource.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDefaultCollection

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.

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStatic

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.

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsETag

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.

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequiredCapability

String getRequiredCapability()
                             throws IOException,
                                    AutomationException

Required capability for the resource.

Product Availability

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

Returns:

The capability

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

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.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsCollection

void setIsCollection(boolean value)
                     throws IOException,
                            AutomationException

Specifies collection resource.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDefaultCollection

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.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsStatic

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.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsETag

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.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequiredCapability

void setRequiredCapability(String capability)
                           throws IOException,
                                  AutomationException

Required capability for the resource.

Product Availability

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

Parameters:

capability - The capability (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toJSONObject

IJSONObject toJSONObject()
                         throws IOException,
                                AutomationException

Converts resource object to JSON representation.

Product Availability

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

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

void addResource(IRESTResource r)
                 throws IOException,
                        AutomationException

Adds child resource.

Product Availability

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

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

void addOperation(IRESTOperation o)
                  throws IOException,
                         AutomationException

Adds child operation.

Product Availability

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

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

IRESTResource findChildResource(String name)
                                throws IOException,
                                       AutomationException

Finds child resource, non-recursive.

Product Availability

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

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

IRESTOperation findChildOperation(String name)
                                  throws IOException,
                                         AutomationException

Finds child operation, non-recursive.

Product Availability

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

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

IEnumRESTResource getResources()
                               throws IOException,
                                      AutomationException

Returns enumerator for immediate child resources.

Product Availability

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

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

IEnumRESTOperation getOperations()
                                 throws IOException,
                                        AutomationException

Returns enumerator for operations.

Product Availability

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

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.