com.esri.arcgis.trackinganalyst
Class DataSetDefinition

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.DataSetDefinition
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IDatasetColumnEnumerator, IDatasetDef, IDatasetDef2, IDatasetDef3, IDatasetDefAdmin, ILibraryItem, ILibraryItem2, ITimeZone, Externalizable, Serializable

public class DataSetDefinition
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDatasetDef, IDatasetDef2, IDatasetDef3, IDatasetDefAdmin, IDatasetColumnEnumerator, IPersistStream, ILibraryItem, ILibraryItem2, ITimeZone, ISupportErrorInfo, IDocumentVersionSupportGEN, Externalizable

Defines data structure for a data message.

Description

This class defines the schema of a particular type of data message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:
Serialized Form

Constructor Summary
DataSetDefinition()
          Constructs a DataSetDefinition using ArcGIS Engine.
DataSetDefinition(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataSetDefinition theDataSetDefinition = (DataSetDefinition) obj;
 
Method Summary
 IEditDataSetColumn addColumnDefinition()
          Adds a column definition to the dataset definition.
 Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 boolean equals(Object o)
          Compare this object with another
 IDatasetColumn findColumn(String szColumnName)
          Finds the specified column.
 String get_GeometryColumns(int nGeometryColumnIndex)
          Returns geometry column values for the dataset definition.
 String getActiveMetaDataEditor()
          Class ID of the active metadata editor.
 String getCategory()
          Indicates category of library item.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IDatasetColumn getColumn(int nIndex)
          Returns column information for the dataset definition.
 int getColumnCount()
          Number of columns in dataset definition.
 String getCurrentZone()
          The current Time Zone.
 Object getDateModified()
          Identifies the date of the last modification to the dataset definition.
 String getEndTimeColumn()
          The End Time column in the dataset definition.
 int getGeometryColumnCount()
          Number of geometry columns included in the dataset definition.
 String getID()
          Identifies ID value for dataset definition.
 String getMessageDefinitionName()
          The dataset message definition name.
 String getMessageDefinitionType()
          The dataset message definition type.
 String getMetaData()
          Identifies metadata information for the dataset definition.
 String getName()
          Identifies Name to include in the dataset definition.
 ILibraryObject getParent()
          Indicates parent of library item.
 String getServiceName()
          The service name associated with the dataset.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 Object getSpatialReferance()
          Spatial reference included in the dataset definition.
 String getStartTimeColumn()
          The Start Time column in the dataset definition.
 String getTimeZoneXML()
          The XML representation of a TimeZone.
 String getTrackingColumn()
          Identifies Tracking column value for the dataset definition.
 Object getZoneList()
          List of time zones.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isAdjustForDaylightSavings()
          Indicates whether or not to Adjust For Daylight Savings.
 void isDirty()
          isDirty
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 ILibraryItem libClone()
          Clone this object (library item).
 void load(IStream pstm)
          load
 void moveTo(int nFromIndex, int nToIndex)
          Moves current dataset definition to a specified location.
 IDatasetColumn next()
          Goes to the next enumerator related to the dataset column.
 void readExternal(ObjectInput in)
           
 void removeColumnDefinition(String[] pcName)
          Removes a column definition from the dataset definition.
 void reset()
          Resets the value for enumerator related to the dataset column.
 void save(IStream pstm, int fClearDirty)
          save
 void setActiveMetaDataEditor(String pbstrActiveMetaDataEditor)
          Class ID of the active metadata editor.
 void setAdjustForDaylightSavings(boolean pVal)
          Indicates whether or not to Adjust For Daylight Savings.
 void setCategory(String pVal)
          Indicates category of library item.
 void setCurrentZone(String pbstrCurrentZone)
          The current Time Zone.
 void setEndTimeColumn(String endTimeColumnName)
          The End Time column in the dataset definition.
 void setID(String pVal)
          ID value for the dataset.
 void setIDReadOnly(boolean rhs1)
          Property Make ID Readonly.
 void setMessageDefinitionName(String messageDefinitionName)
          The dataset message definition name.
 void setMessageDefinitionType(String messageDefinitionType)
          The dataset message definition type.
 void setMetaData(String pbstrMetaData)
          Identifies metadata information for the dataset definition.
 void setName(String pVal)
          Identifies Name to include in the dataset definition.
 void setParent(ILibraryObject ppiVal)
          Indicates parent of library item.
 void setServiceName(String serviceName)
          The service name associated with the dataset.
 void setSpatialReferance(Object piSpatialReference)
          Spatial reference included in the dataset definition.
 void setStartTimeColumn(String startTimeColumnName)
          The Start Time column in the dataset definition.
 void setTimeZoneXML(String pbstrXML)
          The XML representation of a TimeZone.
 void setTrackingColumn(String pVal)
          Identifies Tracking column value for the dataset definition.
 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

DataSetDefinition

public DataSetDefinition()
                  throws IOException,
                         UnknownHostException
Constructs a DataSetDefinition using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DataSetDefinition

public DataSetDefinition(Object obj)
                  throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataSetDefinition theDataSetDefinition = (DataSetDefinition) obj;

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

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

getName

public String getName()
               throws IOException,
                      AutomationException
Identifies Name to include in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getName in interface IDatasetDef
Specified by:
getName in interface IDatasetDef2
Specified by:
getName in interface ILibraryItem
Specified by:
getName in interface ILibraryItem2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Identifies Name to include in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setName in interface IDatasetDef
Specified by:
setName in interface IDatasetDef2
Specified by:
setName in interface ILibraryItem
Specified by:
setName in interface ILibraryItem2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

public String getID()
             throws IOException,
                    AutomationException
Identifies ID value for dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getID in interface IDatasetDef
Specified by:
getID in interface IDatasetDef2
Specified by:
getID in interface ILibraryItem
Specified by:
getID in interface ILibraryItem2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackingColumn

public String getTrackingColumn()
                         throws IOException,
                                AutomationException
Identifies Tracking column value for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTrackingColumn in interface IDatasetDef
Specified by:
getTrackingColumn in interface IDatasetDef2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackingColumn

public void setTrackingColumn(String pVal)
                       throws IOException,
                              AutomationException
Identifies Tracking column value for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTrackingColumn in interface IDatasetDef
Specified by:
setTrackingColumn in interface IDatasetDef2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometryColumnCount

public int getGeometryColumnCount()
                           throws IOException,
                                  AutomationException
Number of geometry columns included in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getGeometryColumnCount in interface IDatasetDef
Specified by:
getGeometryColumnCount in interface IDatasetDef2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReferance

public Object getSpatialReferance()
                           throws IOException,
                                  AutomationException
Spatial reference included in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getSpatialReferance in interface IDatasetDef
Specified by:
getSpatialReferance in interface IDatasetDef2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferance

public void setSpatialReferance(Object piSpatialReference)
                         throws IOException,
                                AutomationException
Spatial reference included in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setSpatialReferance in interface IDatasetDef
Specified by:
setSpatialReferance in interface IDatasetDef2
Parameters:
piSpatialReference - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumnCount

public int getColumnCount()
                   throws IOException,
                          AutomationException
Number of columns in dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getColumnCount in interface IDatasetDef
Specified by:
getColumnCount in interface IDatasetDef2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findColumn

public IDatasetColumn findColumn(String szColumnName)
                          throws IOException,
                                 AutomationException
Finds the specified column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
findColumn in interface IDatasetDef
Specified by:
findColumn in interface IDatasetDef2
Parameters:
szColumnName - The szColumnName (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IDatasetColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addColumnDefinition

public IEditDataSetColumn addColumnDefinition()
                                       throws IOException,
                                              AutomationException
Adds a column definition to the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
addColumnDefinition in interface IDatasetDef
Specified by:
addColumnDefinition in interface IDatasetDef2
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IEditDataSetColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeColumnDefinition

public void removeColumnDefinition(String[] pcName)
                            throws IOException,
                                   AutomationException
Removes a column definition from the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
removeColumnDefinition in interface IDatasetDef
Specified by:
removeColumnDefinition in interface IDatasetDef2
Parameters:
pcName - The pcName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumn

public IDatasetColumn getColumn(int nIndex)
                         throws IOException,
                                AutomationException
Returns column information for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getColumn in interface IDatasetDef
Specified by:
getColumn in interface IDatasetDef2
Parameters:
nIndex - The nIndex (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IDatasetColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

get_GeometryColumns

public String get_GeometryColumns(int nGeometryColumnIndex)
                           throws IOException,
                                  AutomationException
Returns geometry column values for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
get_GeometryColumns in interface IDatasetDef
Specified by:
get_GeometryColumns in interface IDatasetDef2
Parameters:
nGeometryColumnIndex - The nGeometryColumnIndex (in)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveTo

public void moveTo(int nFromIndex,
                   int nToIndex)
            throws IOException,
                   AutomationException
Moves current dataset definition to a specified location.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
moveTo in interface IDatasetDef
Specified by:
moveTo in interface IDatasetDef2
Parameters:
nFromIndex - The nFromIndex (in)
nToIndex - The nToIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetaData

public String getMetaData()
                   throws IOException,
                          AutomationException
Identifies metadata information for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getMetaData in interface IDatasetDef2
Returns:
The pbstrMetaData
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetaData

public void setMetaData(String pbstrMetaData)
                 throws IOException,
                        AutomationException
Identifies metadata information for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setMetaData in interface IDatasetDef2
Parameters:
pbstrMetaData - The pbstrMetaData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDateModified

public Object getDateModified()
                       throws IOException,
                              AutomationException
Identifies the date of the last modification to the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getDateModified in interface IDatasetDef2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setID

public void setID(String pVal)
           throws IOException,
                  AutomationException
ID value for the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setID in interface IDatasetDef2
Specified by:
setID in interface ILibraryItem2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveMetaDataEditor

public String getActiveMetaDataEditor()
                               throws IOException,
                                      AutomationException
Class ID of the active metadata editor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getActiveMetaDataEditor in interface IDatasetDef2
Returns:
The pbstrActiveMetaDataEditor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActiveMetaDataEditor

public void setActiveMetaDataEditor(String pbstrActiveMetaDataEditor)
                             throws IOException,
                                    AutomationException
Class ID of the active metadata editor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setActiveMetaDataEditor in interface IDatasetDef2
Parameters:
pbstrActiveMetaDataEditor - The pbstrActiveMetaDataEditor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartTimeColumn

public String getStartTimeColumn()
                          throws IOException,
                                 AutomationException
The Start Time column in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getStartTimeColumn in interface IDatasetDef3
Returns:
The startTimeColumnName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartTimeColumn

public void setStartTimeColumn(String startTimeColumnName)
                        throws IOException,
                               AutomationException
The Start Time column in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setStartTimeColumn in interface IDatasetDef3
Parameters:
startTimeColumnName - The startTimeColumnName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndTimeColumn

public String getEndTimeColumn()
                        throws IOException,
                               AutomationException
The End Time column in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getEndTimeColumn in interface IDatasetDef3
Returns:
The endTimeColumnName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndTimeColumn

public void setEndTimeColumn(String endTimeColumnName)
                      throws IOException,
                             AutomationException
The End Time column in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setEndTimeColumn in interface IDatasetDef3
Parameters:
endTimeColumnName - The endTimeColumnName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceName

public String getServiceName()
                      throws IOException,
                             AutomationException
The service name associated with the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getServiceName in interface IDatasetDef3
Returns:
The serviceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServiceName

public void setServiceName(String serviceName)
                    throws IOException,
                           AutomationException
The service name associated with the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setServiceName in interface IDatasetDef3
Parameters:
serviceName - The serviceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessageDefinitionType

public String getMessageDefinitionType()
                                throws IOException,
                                       AutomationException
The dataset message definition type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getMessageDefinitionType in interface IDatasetDef3
Returns:
The messageDefinitionType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMessageDefinitionType

public void setMessageDefinitionType(String messageDefinitionType)
                              throws IOException,
                                     AutomationException
The dataset message definition type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setMessageDefinitionType in interface IDatasetDef3
Parameters:
messageDefinitionType - The messageDefinitionType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessageDefinitionName

public String getMessageDefinitionName()
                                throws IOException,
                                       AutomationException
The dataset message definition name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getMessageDefinitionName in interface IDatasetDef3
Returns:
The messageDefinitionName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMessageDefinitionName

public void setMessageDefinitionName(String messageDefinitionName)
                              throws IOException,
                                     AutomationException
The dataset message definition name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setMessageDefinitionName in interface IDatasetDef3
Parameters:
messageDefinitionName - The messageDefinitionName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIDReadOnly

public void setIDReadOnly(boolean rhs1)
                   throws IOException,
                          AutomationException
Property Make ID Readonly.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setIDReadOnly in interface IDatasetDefAdmin
Specified by:
setIDReadOnly in interface ILibraryItem2
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the value for enumerator related to the dataset column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
reset in interface IDatasetColumnEnumerator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

public IDatasetColumn next()
                    throws IOException,
                           AutomationException
Goes to the next enumerator related to the dataset column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
next in interface IDatasetColumnEnumerator
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IDatasetColumn
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.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
Indicates category of library item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getCategory in interface ILibraryItem
Specified by:
getCategory in interface ILibraryItem2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String pVal)
                 throws IOException,
                        AutomationException
Indicates category of library item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setCategory in interface ILibraryItem
Specified by:
setCategory in interface ILibraryItem2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

public ILibraryObject getParent()
                         throws IOException,
                                AutomationException
Indicates parent of library item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getParent in interface ILibraryItem
Specified by:
getParent in interface ILibraryItem2
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ILibraryObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParent

public void setParent(ILibraryObject ppiVal)
               throws IOException,
                      AutomationException
Indicates parent of library item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setParent in interface ILibraryItem
Specified by:
setParent in interface ILibraryItem2
Parameters:
ppiVal - A reference to a com.esri.arcgis.trackinganalyst.ILibraryObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

libClone

public ILibraryItem libClone()
                      throws IOException,
                             AutomationException
Clone this object (library item).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
libClone in interface ILibraryItem
Specified by:
libClone in interface ILibraryItem2
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ILibraryItem
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentZone

public String getCurrentZone()
                      throws IOException,
                             AutomationException
The current Time Zone.

Description

This property indicates the current time zone the temporal feature class’ temporal field is using.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getCurrentZone in interface ITimeZone
Returns:
The pbstrCurrentZone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentZone

public void setCurrentZone(String pbstrCurrentZone)
                    throws IOException,
                           AutomationException
The current Time Zone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setCurrentZone in interface ITimeZone
Parameters:
pbstrCurrentZone - The pbstrCurrentZone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZoneList

public Object getZoneList()
                   throws IOException,
                          AutomationException
List of time zones.

Description

This property indicates a list of time zones that are pulled from the computer’s registry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getZoneList in interface ITimeZone
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAdjustForDaylightSavings

public boolean isAdjustForDaylightSavings()
                                   throws IOException,
                                          AutomationException
Indicates whether or not to Adjust For Daylight Savings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isAdjustForDaylightSavings in interface ITimeZone
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAdjustForDaylightSavings

public void setAdjustForDaylightSavings(boolean pVal)
                                 throws IOException,
                                        AutomationException
Indicates whether or not to Adjust For Daylight Savings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setAdjustForDaylightSavings in interface ITimeZone
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeZoneXML

public String getTimeZoneXML()
                      throws IOException,
                             AutomationException
The XML representation of a TimeZone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTimeZoneXML in interface ITimeZone
Returns:
The pbstrXML
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeZoneXML

public void setTimeZoneXML(String pbstrXML)
                    throws IOException,
                           AutomationException
The XML representation of a TimeZone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTimeZoneXML in interface ITimeZone
Parameters:
pbstrXML - The pbstrXML (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
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