com.esri.arcgis.system

Class CoRESTOperation

java.lang.Object

com.esri.arcgis.system.CoRESTOperation

All Implemented Interfaces:

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

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

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

Description 'IRESTOperation 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.IRESTOperation

IID, IID2853ca57_ae88_4b5d_ada3_4cf6f938a0e0, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
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() Operation name.
java.lang.String	getOutputFormats() Supported output formats, separated by comma.
java.lang.String	getParameters() Operation parameters, separated by comma.
java.lang.String	getRequiredCapability() Required capability for the operation.
int	hashCode() the hashcode for this object
boolean	isPostOnly() Denotes POST-only operations.
void	release() Release this COM object reference
void	setName(java.lang.String name) Operation name.
void	setOutputFormats(java.lang.String outputFormats) Supported output formats, separated by comma.
void	setParameters(java.lang.String parameters) Operation parameters, separated by comma.
void	setPostOnly(boolean value) Denotes POST-only operations.
void	setRequiredCapability(java.lang.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

Constructor Detail

CoRESTOperation

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

Constructs a CoRESTOperation using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CoRESTOperation

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

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

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

Specified by:

getName in interface IRESTOperation

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameters

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

Operation parameters, separated by comma.

Specified by:

getParameters in interface IRESTOperation

Returns:

The parameters

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputFormats

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

Supported output formats, separated by comma.

Specified by:

getOutputFormats in interface IRESTOperation

Returns:

The outputFormats

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

Specified by:

getRequiredCapability in interface IRESTOperation

Returns:

The capability

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPostOnly

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

Denotes POST-only operations.

Specified by:

isPostOnly in interface IRESTOperation

Returns:

The value

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 operation object to JSON representation.

Specified by:

toJSONObject in interface IRESTOperation

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.

setName

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

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

Specified by:

setName in interface IRESTOperation

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParameters

public void setParameters(java.lang.String parameters)
                   throws java.io.IOException,
                          AutomationException

Operation parameters, separated by comma.

Specified by:

setParameters in interface IRESTOperation

Parameters:

parameters - The parameters (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputFormats

public void setOutputFormats(java.lang.String outputFormats)
                      throws java.io.IOException,
                             AutomationException

Supported output formats, separated by comma.

Specified by:

setOutputFormats in interface IRESTOperation

Parameters:

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

Specified by:

setRequiredCapability in interface IRESTOperation

Parameters:

capability - The capability (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPostOnly

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

Denotes POST-only operations.

Specified by:

setPostOnly in interface IRESTOperation

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.