com.esri.arcgis.search
Class DSCStatus

java.lang.Object
  com.esri.arcgis.search.DSCStatus

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IDSCStatus, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class DSCStatus
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDSCStatus, IXMLSerialize, IPersistStream, IPersist, IXMLVersionSupport, Externalizable

Data source status object.

See Also:

Serialized Form

Constructor Summary

DSCStatus()
Constructs a DSCStatus using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getJobID() Job ID of the Data Source.
int	getJobStatus() JobStatus of the Data Source.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getPath() Catalog Path of Data Source.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setJobID(String jobID) Job ID of the Data Source.
void	setJobStatus(int jobID) JobStatus of the Data Source.
void	setPath(String path) Catalog Path of Data Source.
void	writeExternal(ObjectOutput out)

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

DSCStatus

public DSCStatus()
          throws IOException,
                 UnknownHostException

Constructs a DSCStatus using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DSCStatus

public DSCStatus(Object obj)
          throws IOException

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

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

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

getPath

public String getPath()
               throws IOException,
                      AutomationException

Catalog Path of Data Source.

Specified by:

getPath in interface IDSCStatus

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(String path)
             throws IOException,
                    AutomationException

Catalog Path of Data Source.

Specified by:

setPath in interface IDSCStatus

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobID

public String getJobID()
                throws IOException,
                       AutomationException

Job ID of the Data Source.

Specified by:

getJobID in interface IDSCStatus

Returns:

The jobID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobID

public void setJobID(String jobID)
              throws IOException,
                     AutomationException

Job ID of the Data Source.

Specified by:

setJobID in interface IDSCStatus

Parameters:

jobID - The jobID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobStatus

public int getJobStatus()
                 throws IOException,
                        AutomationException

JobStatus of the Data Source.

Specified by:

getJobStatus in interface IDSCStatus

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobStatus

public void setJobStatus(int jobID)
                  throws IOException,
                         AutomationException

JobStatus of the Data Source.

Specified by:

setJobStatus in interface IDSCStatus

Parameters:

jobID - A com.esri.arcgis.system.esriJobStatus constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException