com.esri.arcgis.trackinganalyst
Interface ILibraryObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

ILibraryObjectProxy

public interface ILibraryObject
extends Serializable

Provides access to members that help manage library objects.

Product Availability

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

Method Summary

void	checkIn(ILibraryItem piItem, boolean bvUndoCheckOut) Checks in a library object.
void	checkOut(ILibraryItem ppiLibraryItem, boolean bForUpdate) Checks out a library object.
String	getCategory() Indicates the category of library object.
int	getCheckOutCount() Number of times object has been checked out.
String	getName() Name of a library object.
boolean	isEditable() Indicates whether the library object is editable.
void	isEqual(String bstrCategory, String bstrName) Indicates whether a library object is equal to a value.
boolean	isUpdating() Indicates if the library object is being updated with new information.
void	load(IStream piStream) Loads a library object.
void	setCategory(String pVal) Indicates the category of library object.
void	setIsUpdating(boolean pVal) Indicates if the library object is being updated with new information.
void	setName(String pVal) Name of a library object.
void	store(IStream piStream) Stores a library object.

Method Detail

getCheckOutCount

int getCheckOutCount()
                     throws IOException,
                            AutomationException

Number of times object has been checked out.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEditable

boolean isEditable()
                   throws IOException,
                          AutomationException

Indicates whether the library object is editable.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdating

boolean isUpdating()
                   throws IOException,
                          AutomationException

Indicates if the library object is being updated with new information.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsUpdating

void setIsUpdating(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the library object is being updated with new information.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

Indicates the category of library object.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(String pVal)
                 throws IOException,
                        AutomationException

Indicates the category of library object.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Name of a library object.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException

Name of a library object.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkIn

void checkIn(ILibraryItem piItem,
             boolean bvUndoCheckOut)
             throws IOException,
                    AutomationException

Checks in a library object.

Product Availability

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

Parameters:

piItem - A reference to a com.esri.arcgis.trackinganalyst.ILibraryItem (in)

bvUndoCheckOut - The bvUndoCheckOut (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkOut

void checkOut(ILibraryItem ppiLibraryItem,
              boolean bForUpdate)
              throws IOException,
                     AutomationException

Checks out a library object.

Product Availability

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

Parameters:

ppiLibraryItem - A reference to a com.esri.arcgis.trackinganalyst.ILibraryItem (in)

bForUpdate - The bForUpdate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

store

void store(IStream piStream)
           throws IOException,
                  AutomationException

Stores a library object.

Product Availability

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

Parameters:

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

load

void load(IStream piStream)
          throws IOException,
                 AutomationException

Loads a library object.

Product Availability

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

Parameters:

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

isEqual

void isEqual(String bstrCategory,
             String bstrName)
             throws IOException,
                    AutomationException

Indicates whether a library object is equal to a value.

Product Availability

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

Parameters:

bstrCategory - The bstrCategory (in)

bstrName - The bstrName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.