com.esri.arcgis.trackinganalyst
Class GeneralLibraryObject

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.GeneralLibraryObject
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IGeneralLibraryObject, ILibraryItem, java.io.Externalizable, java.io.Serializable

public class GeneralLibraryObject
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeneralLibraryObject, ILibraryItem, IPersistStream, ISupportErrorInfo, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'GeneralLibraryObject'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Implements IGeneralLibraryObject interface used with the general library object.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.IGeneralLibraryObject
IID, IIDcc018a0f_24fb_11d4_b34c_00104ba2abcc, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ILibraryItem
IID, IIDcc018a07_24fb_11d4_b34c_00104ba2abcc, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
GeneralLibraryObject()
          Constructs a GeneralLibraryObject using ArcGIS Engine.
GeneralLibraryObject(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeneralLibraryObject theGeneralLibraryObject = (GeneralLibraryObject) obj;
 
Method Summary
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getCategory()
          Indicates category of library item.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.String getID()
          ID value of library item.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          Name of library item.
 ILibraryObject getParent()
          Indicates parent of library item.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 java.lang.Object getVObject()
          A reference to a COM objects wrapped up in a variant.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 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 readExternal(java.io.ObjectInput in)
           
 void release()
          Release a GeneralLibraryObject.
 void save(IStream pstm, int fClearDirty)
          save
 void setCategory(java.lang.String pVal)
          Indicates category of library item.
 void setName(java.lang.String pVal)
          Name of library item.
 void setParent(ILibraryObject ppiVal)
          Indicates parent of library item.
 void setVObject(java.lang.Object pVal)
          A reference to a COM objects wrapped up in a variant.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

GeneralLibraryObject

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

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

GeneralLibraryObject

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

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

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 GeneralLibraryObject.

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

getVObject

public java.lang.Object getVObject()
                            throws java.io.IOException,
                                   AutomationException
A reference to a COM objects wrapped up in a variant.

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

setVObject

public void setVObject(java.lang.Object pVal)
                throws java.io.IOException,
                       AutomationException
A reference to a COM objects wrapped up in a variant.

Specified by:
setVObject in interface IGeneralLibraryObject
Parameters:
pVal - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

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

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

setCategory

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

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

getID

public java.lang.String getID()
                       throws java.io.IOException,
                              AutomationException
ID value of library item.

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of library item.

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

setName

public void setName(java.lang.String pVal)
             throws java.io.IOException,
                    AutomationException
Name of library item.

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

getParent

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

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

setParent

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

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

libClone

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

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

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

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException