com.esri.arcgis.system

Interface IRESTOperation

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CoRESTOperation, IRESTOperationProxy

public interface IRESTOperation
extends java.io.Serializable

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

Description: 'REST operation 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	IID2853ca57_ae88_4b5d_ada3_4cf6f938a0e0
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.
boolean	isPostOnly() Denotes POST-only operations.
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.

Field Detail

IID2853ca57_ae88_4b5d_ada3_4cf6f938a0e0

static final int IID2853ca57_ae88_4b5d_ada3_4cf6f938a0e0

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

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

getParameters

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

Operation parameters, separated by comma.

Returns:

The parameters

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputFormats

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

Supported output formats, separated by comma.

Returns:

The outputFormats

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

Returns:

The capability

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPostOnly

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

Denotes POST-only operations.

Returns:

The value

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

setName

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

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

setParameters

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

Operation parameters, separated by comma.

Parameters:

parameters - The parameters (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputFormats

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

Supported output formats, separated by comma.

Parameters:

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

Parameters:

capability - The capability (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPostOnly

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

Denotes POST-only operations.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.