com.esri.arcgis.search
Class IndexingStatus

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

All Implemented Interfaces:

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

public class IndexingStatus
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIndexingStatus, IXMLSerialize, IPersistStream, IPersist, Externalizable

Indexing Status object.

See Also:

Serialized Form

Constructor Summary

IndexingStatus()
Constructs a IndexingStatus using ArcGIS Engine.

IndexingStatus(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IndexingStatus theIndexingStatus = (IndexingStatus) 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.
int	getIndexingType() Indicates the indexing type.
int	getItemsIndexed() Indicators whether items are indexed.
String	getNextFullIndexingStartTime() Next Full indexing start time.
String	getNextIncrementalIndexingStartTime() Next Incremetal indexing start time.
int	getNextIndexingType() Indicates next indexing type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getStartTime() Index start time.
int	getTimeUsed() Time used for indexing.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isRunning() Indicates if the index tasks is running.
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	setIndexingType(int indexingType) Indicates the indexing type.
void	setIsRunning(boolean pValid) Indicates if the index tasks is running.
void	setItemsIndexed(int itemsIndexed) Indicators whether items are indexed.
void	setNextFullIndexingStartTime(String nextFullIndexingStartTime) Next Full indexing start time.
void	setNextIncrementalIndexingStartTime(String nextIncremetalIndexingStartTime) Next Incremetal indexing start time.
void	setNextIndexingType(int indexingType) Indicates next indexing type.
void	setStartTime(String startTime) Index start time.
void	setTimeUsed(int timeUsed) Time used for indexing.
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

IndexingStatus

public IndexingStatus()
               throws IOException,
                      UnknownHostException

Constructs a IndexingStatus using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IndexingStatus

public IndexingStatus(Object obj)
               throws IOException

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

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

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

getIndexingType

public int getIndexingType()
                    throws IOException,
                           AutomationException

Indicates the indexing type.

Specified by:

getIndexingType in interface IIndexingStatus

Returns:

A com.esri.arcgis.search.esriIndexingType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexingType

public void setIndexingType(int indexingType)
                     throws IOException,
                            AutomationException

Indicates the indexing type.

Specified by:

setIndexingType in interface IIndexingStatus

Parameters:

indexingType - A com.esri.arcgis.search.esriIndexingType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunning

public boolean isRunning()
                  throws IOException,
                         AutomationException

Indicates if the index tasks is running.

Specified by:

isRunning in interface IIndexingStatus

Returns:

The pValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsRunning

public void setIsRunning(boolean pValid)
                  throws IOException,
                         AutomationException

Indicates if the index tasks is running.

Specified by:

setIsRunning in interface IIndexingStatus

Parameters:

pValid - The pValid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTime

public String getStartTime()
                    throws IOException,
                           AutomationException

Index start time.

Specified by:

getStartTime in interface IIndexingStatus

Returns:

The startTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

public void setStartTime(String startTime)
                  throws IOException,
                         AutomationException

Index start time.

Specified by:

setStartTime in interface IIndexingStatus

Parameters:

startTime - The startTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeUsed

public int getTimeUsed()
                throws IOException,
                       AutomationException

Time used for indexing.

Specified by:

getTimeUsed in interface IIndexingStatus

Returns:

The timeUsed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeUsed

public void setTimeUsed(int timeUsed)
                 throws IOException,
                        AutomationException

Time used for indexing.

Specified by:

setTimeUsed in interface IIndexingStatus

Parameters:

timeUsed - The timeUsed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemsIndexed

public void setItemsIndexed(int itemsIndexed)
                     throws IOException,
                            AutomationException

Indicators whether items are indexed.

Specified by:

setItemsIndexed in interface IIndexingStatus

Parameters:

itemsIndexed - The itemsIndexed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemsIndexed

public int getItemsIndexed()
                    throws IOException,
                           AutomationException

Indicators whether items are indexed.

Specified by:

getItemsIndexed in interface IIndexingStatus

Returns:

The itemsIndexed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextFullIndexingStartTime

public String getNextFullIndexingStartTime()
                                    throws IOException,
                                           AutomationException

Next Full indexing start time.

Specified by:

getNextFullIndexingStartTime in interface IIndexingStatus

Returns:

The nextFullIndexingStartTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNextFullIndexingStartTime

public void setNextFullIndexingStartTime(String nextFullIndexingStartTime)
                                  throws IOException,
                                         AutomationException

Next Full indexing start time.

Specified by:

setNextFullIndexingStartTime in interface IIndexingStatus

Parameters:

nextFullIndexingStartTime - The nextFullIndexingStartTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextIncrementalIndexingStartTime

public String getNextIncrementalIndexingStartTime()
                                           throws IOException,
                                                  AutomationException

Next Incremetal indexing start time.

Specified by:

getNextIncrementalIndexingStartTime in interface IIndexingStatus

Returns:

The nextIncremetalIndexingStartTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNextIncrementalIndexingStartTime

public void setNextIncrementalIndexingStartTime(String nextIncremetalIndexingStartTime)
                                         throws IOException,
                                                AutomationException

Next Incremetal indexing start time.

Specified by:

setNextIncrementalIndexingStartTime in interface IIndexingStatus

Parameters:

nextIncremetalIndexingStartTime - The nextIncremetalIndexingStartTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextIndexingType

public int getNextIndexingType()
                        throws IOException,
                               AutomationException

Indicates next indexing type.

Specified by:

getNextIndexingType in interface IIndexingStatus

Returns:

A com.esri.arcgis.search.esriIndexingType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNextIndexingType

public void setNextIndexingType(int indexingType)
                         throws IOException,
                                AutomationException

Indicates next indexing type.

Specified by:

setNextIndexingType in interface IIndexingStatus

Parameters:

indexingType - A com.esri.arcgis.search.esriIndexingType 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.

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