com.esri.arcgis.system
Interface IRESTOperation

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoRESTOperation

public interface IRESTOperation
extends Serializable

REST operation metadata object.

Product Availability

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

Method Summary

String	getName() Operation name.
String	getOutputFormats() Supported output formats, separated by comma.
String	getParameters() Operation parameters, separated by comma.
String	getRequiredCapability() Required capability for the operation.
boolean	isPostOnly() Denotes POST-only operations.
void	setName(String name) Operation name.
void	setOutputFormats(String outputFormats) Supported output formats, separated by comma.
void	setParameters(String parameters) Operation parameters, separated by comma.
void	setPostOnly(boolean value) Denotes POST-only operations.
void	setRequiredCapability(String capability) Required capability for the operation.
IJSONObject	toJSONObject() Converts operation object to JSON representation.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Operation 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.

getParameters

String getParameters()
                     throws IOException,
                            AutomationException

Operation parameters, separated by comma.

Product Availability

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

Returns:

The parameters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputFormats

String getOutputFormats()
                        throws IOException,
                               AutomationException

Supported output formats, separated by comma.

Product Availability

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

Returns:

The outputFormats

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 operation.

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.

isPostOnly

boolean isPostOnly()
                   throws IOException,
                          AutomationException

Denotes POST-only operations.

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.

toJSONObject

IJSONObject toJSONObject()
                         throws IOException,
                                AutomationException

Converts operation 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.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Operation 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.

setParameters

void setParameters(String parameters)
                   throws IOException,
                          AutomationException

Operation parameters, separated by comma.

Product Availability

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

Parameters:

parameters - The parameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputFormats

void setOutputFormats(String outputFormats)
                      throws IOException,
                             AutomationException

Supported output formats, separated by comma.

Product Availability

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

Parameters:

outputFormats - The outputFormats (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 operation.

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.

setPostOnly

void setPostOnly(boolean value)
                 throws IOException,
                        AutomationException

Denotes POST-only operations.

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.