com.esri.arcgis.system
Class CoRESTOperation

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

All Implemented Interfaces:

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

public class CoRESTOperation
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRESTOperation

IRESTOperation coclass

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CoRESTOperation()
Constructs a CoRESTOperation using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

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

CoRESTOperation

public CoRESTOperation()
                throws IOException,
                       UnknownHostException

Constructs a CoRESTOperation using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CoRESTOperation

public CoRESTOperation(Object obj)
                throws IOException

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

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

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

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public String getParameters()
                     throws IOException,
                            AutomationException

Operation parameters, separated by comma.

Product Availability

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

Specified by:

getParameters in interface IRESTOperation

Returns:

The parameters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputFormats

public String getOutputFormats()
                        throws IOException,
                               AutomationException

Supported output formats, separated by comma.

Product Availability

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

Specified by:

getOutputFormats in interface IRESTOperation

Returns:

The outputFormats

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

Product Availability

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

Specified by:

getRequiredCapability in interface IRESTOperation

Returns:

The capability

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPostOnly

public boolean isPostOnly()
                   throws IOException,
                          AutomationException

Denotes POST-only operations.

Product Availability

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

Specified by:

isPostOnly in interface IRESTOperation

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toJSONObject

public IJSONObject toJSONObject()
                         throws IOException,
                                AutomationException

Converts operation object to JSON representation.

Product Availability

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

Specified by:

toJSONObject in interface IRESTOperation

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

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

Specified by:

setName in interface IRESTOperation

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameters

public void setParameters(String parameters)
                   throws IOException,
                          AutomationException

Operation parameters, separated by comma.

Product Availability

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

Specified by:

setParameters in interface IRESTOperation

Parameters:

parameters - The parameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputFormats

public void setOutputFormats(String outputFormats)
                      throws IOException,
                             AutomationException

Supported output formats, separated by comma.

Product Availability

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

Specified by:

setOutputFormats in interface IRESTOperation

Parameters:

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

Product Availability

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

Specified by:

setRequiredCapability in interface IRESTOperation

Parameters:

capability - The capability (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPostOnly

public void setPostOnly(boolean value)
                 throws IOException,
                        AutomationException

Denotes POST-only operations.

Product Availability

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

Specified by:

setPostOnly in interface IRESTOperation

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.