Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geoprocessing
Class GPServerLP

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPServerLP
All Implemented Interfaces:
IGPServer, IGPServer2, IAGSServerObject, IAGSServerObject2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable
public class GPServerLP
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerObject2, IAGSServerObject, IGPServer, IGPServer2

COM Class 'GPServerLP'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'GP Server LAN Proxy.' 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.gisclient.IAGSServerObject2
IID, IID2e07daa3_6dec_4dc3_a7ed_2f29e2ecfe4a, xxDummy
 
Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerObject
IID7c25fb69_eac4_433c_b08c_7ae39e83ffbd
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPServer
IID, IID234f4a93_8516_4247_914c_57c59f1d3f5f, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPServer2
IID, IID27909bc6_7ad1_4f5a_8e90_1bb8b95a569f, xxDummy
 
Constructor Summary
GPServerLP()
          Constructs a GPServerLP using ArcGIS Engine.
GPServerLP(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPServerLP theGPServerLP = (GPServerLP) obj;
 
Method Summary
 void cancelJob(java.lang.String jobID)
          Cancels the specified job.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IGPResult execute(java.lang.String toolName, IGPValues values, IGPResultOptions pOptions)
          Executes the specified tool with the supplied values and options and returns the results.
 IGPResult execute(java.lang.String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues)
          Executes the specified tool with the supplied values and options and returns the results.
static java.lang.String getClsid()
          getClsid.
 int getExecutionType()
          Indicates if the geoprocessing server is synchronous or asynchronous.
 IName getFullName()
          The AGSServerConnectionName object associated with the server object.
 int getHttpTimeout()
          The maximum time in seconds to wait for a response from the server (Internet only).
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IPropertySet getJobEnvironmentValues(java.lang.String jobID)
          Returns the enviornment values for the job.
 IGPValues getJobInputValues(java.lang.String jobID, IStringArray parameterNames)
          Returns the input values for the job.
 IJobMessages getJobMessages(java.lang.String jobID)
          Returns the messages of the specified job.
 IGPResult getJobResult(java.lang.String jobID, IStringArray parameterNames, IGPResultOptions pOptions)
          Returns the results of the specified job.
 IEnvelope getJobResultMapExtent(java.lang.String jobID)
          Returns the extent for the job.
 IGPResultOptions getJobResultOptions(java.lang.String jobID)
          Returns the result options for the job.
 int getJobStatus(java.lang.String jobID)
          Returns the status of the specified job.
 java.lang.String getJobToolName(java.lang.String jobID)
          Returns the tool name for the job.
 java.lang.String getResultMapServerName()
          Indicates if there is an associated map server to draw the results and the name of the map server.
 IGDSData getResultWorkspace(java.lang.String jobID, int transportType)
          Returns a zip file of the results workspace.
 IGPToolInfos getTaskInfos()
          Returns the tool information of the available tasks.
 IStringArray getTaskNames()
          Returns the names of the available tasks.
 IGPToolInfo getToolInfo(java.lang.String toolName)
          Returns the tool information of the specified tool name.
 IGPToolInfos getToolInfos()
          Returns the tool information of the available tools.
 IStringArray getToolNames()
          Returns the names of the available tools.
 int hashCode()
          the hashcode for this object
 void release()
          Release a GPServerLP.
 void setHttpTimeout(int secs)
          The maximum time in seconds to wait for a response from the server (Internet only).
 java.lang.String submitJob(java.lang.String toolName, IGPValues values)
          Submits the specified tool with the supplied values and options and returns the job id.
 java.lang.String submitJob(java.lang.String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues)
          Submits the specified tool with the supplied values and options and returns the job id.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GPServerLP

public GPServerLP()
           throws java.io.IOException,
                  java.net.UnknownHostException
Constructs a GPServerLP using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPServerLP

public GPServerLP(java.lang.Object obj)
           throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPServerLP theGPServerLP = (GPServerLP) obj;

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

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()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a GPServerLP.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
The AGSServerConnectionName object associated with the server object.

Specified by:
getFullName in interface IAGSServerObject2
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHttpTimeout

public void setHttpTimeout(int secs)
                    throws java.io.IOException,
                           AutomationException
The maximum time in seconds to wait for a response from the server (Internet only).

Specified by:
setHttpTimeout in interface IAGSServerObject2
Parameters:
secs - The secs (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHttpTimeout

public int getHttpTimeout()
                   throws java.io.IOException,
                          AutomationException
The maximum time in seconds to wait for a response from the server (Internet only).

Specified by:
getHttpTimeout in interface IAGSServerObject2
Returns:
The secs
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolNames

public IStringArray getToolNames()
                          throws java.io.IOException,
                                 AutomationException
Returns the names of the available tools.

Specified by:
getToolNames in interface IGPServer
Specified by:
getToolNames in interface IGPServer2
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolInfos

public IGPToolInfos getToolInfos()
                          throws java.io.IOException,
                                 AutomationException
Returns the tool information of the available tools.

Specified by:
getToolInfos in interface IGPServer
Specified by:
getToolInfos in interface IGPServer2
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPToolInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolInfo

public IGPToolInfo getToolInfo(java.lang.String toolName)
                        throws java.io.IOException,
                               AutomationException
Returns the tool information of the specified tool name.

Specified by:
getToolInfo in interface IGPServer
Specified by:
getToolInfo in interface IGPServer2
Parameters:
toolName - The toolName (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPToolInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTaskNames

public IStringArray getTaskNames()
                          throws java.io.IOException,
                                 AutomationException
Returns the names of the available tasks.

Specified by:
getTaskNames in interface IGPServer
Specified by:
getTaskNames in interface IGPServer2
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTaskInfos

public IGPToolInfos getTaskInfos()
                          throws java.io.IOException,
                                 AutomationException
Returns the tool information of the available tasks.

Specified by:
getTaskInfos in interface IGPServer
Specified by:
getTaskInfos in interface IGPServer2
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPToolInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResultMapServerName

public java.lang.String getResultMapServerName()
                                        throws java.io.IOException,
                                               AutomationException
Indicates if there is an associated map server to draw the results and the name of the map server.

Specified by:
getResultMapServerName in interface IGPServer
Specified by:
getResultMapServerName in interface IGPServer2
Returns:
The mapServerName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public IGPResult execute(java.lang.String toolName,
                         IGPValues values,
                         IGPResultOptions pOptions)
                  throws java.io.IOException,
                         AutomationException
Executes the specified tool with the supplied values and options and returns the results.

Specified by:
execute in interface IGPServer
Parameters:
toolName - The toolName (in)
values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)
pOptions - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

submitJob

public java.lang.String submitJob(java.lang.String toolName,
                                  IGPValues values)
                           throws java.io.IOException,
                                  AutomationException
Submits the specified tool with the supplied values and options and returns the job id.

Specified by:
submitJob in interface IGPServer
Parameters:
toolName - The toolName (in)
values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)
Returns:
The jobID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobStatus

public int getJobStatus(java.lang.String jobID)
                 throws java.io.IOException,
                        AutomationException
Returns the status of the specified job.

Specified by:
getJobStatus in interface IGPServer
Specified by:
getJobStatus in interface IGPServer2
Parameters:
jobID - The jobID (in)
Returns:
A com.esri.arcgis.system.esriJobStatus constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobMessages

public IJobMessages getJobMessages(java.lang.String jobID)
                            throws java.io.IOException,
                                   AutomationException
Returns the messages of the specified job.

Specified by:
getJobMessages in interface IGPServer
Specified by:
getJobMessages in interface IGPServer2
Parameters:
jobID - The jobID (in)
Returns:
A reference to a com.esri.arcgis.system.IJobMessages
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobResult

public IGPResult getJobResult(java.lang.String jobID,
                              IStringArray parameterNames,
                              IGPResultOptions pOptions)
                       throws java.io.IOException,
                              AutomationException
Returns the results of the specified job.

Specified by:
getJobResult in interface IGPServer
Specified by:
getJobResult in interface IGPServer2
Parameters:
jobID - The jobID (in)
parameterNames - A reference to a com.esri.arcgis.system.IStringArray (in)
pOptions - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cancelJob

public void cancelJob(java.lang.String jobID)
               throws java.io.IOException,
                      AutomationException
Cancels the specified job.

Specified by:
cancelJob in interface IGPServer
Specified by:
cancelJob in interface IGPServer2
Parameters:
jobID - The jobID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExecutionType

public int getExecutionType()
                     throws java.io.IOException,
                            AutomationException
Indicates if the geoprocessing server is synchronous or asynchronous.

Specified by:
getExecutionType in interface IGPServer
Specified by:
getExecutionType in interface IGPServer2
Returns:
A com.esri.arcgis.geoprocessing.esriExecutionType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResultWorkspace

public IGDSData getResultWorkspace(java.lang.String jobID,
                                   int transportType)
                            throws java.io.IOException,
                                   AutomationException
Returns a zip file of the results workspace.

Specified by:
getResultWorkspace in interface IGPServer
Specified by:
getResultWorkspace in interface IGPServer2
Parameters:
jobID - The jobID (in)
transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public IGPResult execute(java.lang.String toolName,
                         IGPValues values,
                         IGPResultOptions options,
                         IPropertySet envValues)
                  throws java.io.IOException,
                         AutomationException
Executes the specified tool with the supplied values and options and returns the results.

Specified by:
execute in interface IGPServer2
Parameters:
toolName - The toolName (in)
values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)
options - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)
envValues - A reference to a com.esri.arcgis.system.IPropertySet (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPResult
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

submitJob

public java.lang.String submitJob(java.lang.String toolName,
                                  IGPValues values,
                                  IGPResultOptions options,
                                  IPropertySet envValues)
                           throws java.io.IOException,
                                  AutomationException
Submits the specified tool with the supplied values and options and returns the job id.

Specified by:
submitJob in interface IGPServer2
Parameters:
toolName - The toolName (in)
values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)
options - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)
envValues - A reference to a com.esri.arcgis.system.IPropertySet (in)
Returns:
The jobID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobToolName

public java.lang.String getJobToolName(java.lang.String jobID)
                                throws java.io.IOException,
                                       AutomationException
Returns the tool name for the job.

Specified by:
getJobToolName in interface IGPServer2
Parameters:
jobID - The jobID (in)
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobInputValues

public IGPValues getJobInputValues(java.lang.String jobID,
                                   IStringArray parameterNames)
                            throws java.io.IOException,
                                   AutomationException
Returns the input values for the job.

Specified by:
getJobInputValues in interface IGPServer2
Parameters:
jobID - The jobID (in)
parameterNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPValues
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobResultOptions

public IGPResultOptions getJobResultOptions(java.lang.String jobID)
                                     throws java.io.IOException,
                                            AutomationException
Returns the result options for the job.

Specified by:
getJobResultOptions in interface IGPServer2
Parameters:
jobID - The jobID (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobEnvironmentValues

public IPropertySet getJobEnvironmentValues(java.lang.String jobID)
                                     throws java.io.IOException,
                                            AutomationException
Returns the enviornment values for the job.

Specified by:
getJobEnvironmentValues in interface IGPServer2
Parameters:
jobID - The jobID (in)
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJobResultMapExtent

public IEnvelope getJobResultMapExtent(java.lang.String jobID)
                                throws java.io.IOException,
                                       AutomationException
Returns the extent for the job.

Specified by:
getJobResultMapExtent in interface IGPServer2
Parameters:
jobID - The jobID (in)
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD