com.esri.arcgis.system
Interface IJobDefinition

All Superinterfaces:

Serializable

public interface IJobDefinition
extends Serializable

Provides access to properties of job definition.

Product Availability

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

Method Summary

byte[]	getBinaryRequest() Request message in binary format.
String	getCapabilities() Required capabilities of job processor.
int	getRequestFormat() Format of request.
void	getRESTRequest(String[] pResourceName, String[] pRperationName, String[] pRperationInput, String[] pOutputFormat, String[] pRequestProperties) Request message in REST format.
String	getStringRequest() Request message in SOAP format.
boolean	isRESTFormat() REST Format of request.
void	setBinaryRequest(byte[] ppVal) Request message in binary format.
void	setCapabilities(String pVal) Required capabilities of job processor.
void	setRESTRequest(String resourceName, String operationName, String operationInput, String outputFormat, String requestProperties) Request message in REST format.
void	setStringRequest(String pVal) Request message in SOAP format.

Method Detail

getRequestFormat

int getRequestFormat()
                     throws IOException,
                            AutomationException

Format of request.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriAGSInternetMessageFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStringRequest

String getStringRequest()
                        throws IOException,
                               AutomationException

Request message in SOAP format.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStringRequest

void setStringRequest(String pVal)
                      throws IOException,
                             AutomationException

Request message in SOAP format.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinaryRequest

byte[] getBinaryRequest()
                        throws IOException,
                               AutomationException

Request message in binary format.

Product Availability

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

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBinaryRequest

void setBinaryRequest(byte[] ppVal)
                      throws IOException,
                             AutomationException

Request message in binary format.

Product Availability

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

Parameters:

ppVal - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCapabilities

String getCapabilities()
                       throws IOException,
                              AutomationException

Required capabilities of job processor.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCapabilities

void setCapabilities(String pVal)
                     throws IOException,
                            AutomationException

Required capabilities of job processor.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRESTFormat

boolean isRESTFormat()
                     throws IOException,
                            AutomationException

REST Format of request.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRESTRequest

void getRESTRequest(String[] pResourceName,
                    String[] pRperationName,
                    String[] pRperationInput,
                    String[] pOutputFormat,
                    String[] pRequestProperties)
                    throws IOException,
                           AutomationException

Request message in REST format.

Product Availability

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

Parameters:

pResourceName - The pResourceName (out: use single element array)

pRperationName - The pRperationName (out: use single element array)

pRperationInput - The pRperationInput (out: use single element array)

pOutputFormat - The pOutputFormat (out: use single element array)

pRequestProperties - The pRequestProperties (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRESTRequest

void setRESTRequest(String resourceName,
                    String operationName,
                    String operationInput,
                    String outputFormat,
                    String requestProperties)
                    throws IOException,
                           AutomationException

Request message in REST format.

Product Availability

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

Parameters:

resourceName - The resourceName (in)

operationName - The operationName (in)

operationInput - The operationInput (in)

outputFormat - The outputFormat (in)

requestProperties - The requestProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.