Packaging for the Java environment
The API classes help facilitate communication with Content Manager OnDemand and instantiate programming models of Content Manager OnDemand objects (for example, application groups and folders).
The API classes are contained in one package: com.ibm.edms.od.
The following list describes the classes:
- com.ibm.edms.od.ODApplication
- This class represents a Content Manager OnDemand application. An instance of the ODApplication object provides an application developer access to information that is specified for a Content Manager OnDemand application.
- com.ibm.edms.od. ODApplicationGroup
- This class represents a Content Manager OnDemand application group. An instance of the ODApplicationGroup object provides an application developer access to information that is specified for a Content Manager OnDemand application group. An instance of the ODApplicationGroup object is generated through an instance of the ODServer object by calling the getApplicationGroup() method.
- com.ibm.edms.od. ODApplicationGroupField
- This class represents a Content Manager OnDemand application group field. It contains application group field information.
- com.ibm.edms.od.ODCabinet
- This class represents a collection of Content Manager OnDemand folders. The administrator defines and manages cabinets on the Content Manager OnDemand server.
- com.ibm.edms.od.ODCallback
- This class is used with all methods in which the server operation returns data while processing.
- com.ibm.edms.od.ODConfig
- The ODConfig Java™ object is the preferred method to configure the system parameters.
- com.ibm.edms.od.ODConstant
- ODConstant is the public interface.
- com.ibm.edms.od.ODCriteria
- A class that represents the search criteria from a Content Manager OnDemand folder. The criteria class contains methods to set a search operator and search values.
- com.ibm.edms.od.ODException
- This class represents the exceptions which might occur when using the APIs.
- com.ibm.edms.od.ODFolder
- A class that represents a Content Manager OnDemand folder. This object is returned from a successful call to ODServer.openFolder(). This class contains folder criteria information. These criteria objects are what need to be modified in order to narrow the query on the server.
- com.ibm.edms.od.ODHit
- This class represents a Content Manager OnDemand document.
- com.ibm.edms.od. ODHitProperties
- Use this class to obtain the Content Manager OnDemand internal property values for a hit.
- com.ibm.edms.od.ODHold
- This class represents a Content Manager OnDemand hold definition. This object is returned from a successful call to (ODServer.getHolds()).
- com.ibm.edms.od.ODLogicalView
- This class represents a Content Manager OnDemand logical view.
- com.ibm.edms.od. ODNamedQuery
- This class represents a Content Manager OnDemand named query. This class contains the details of a named query, and enables the system to retrieve existing named queries and save new named queries to the Content Manager OnDemand server.
- com.ibm.edms.od. ODNamedQueryCriteria
- This class represents the criteria of a Content Manager OnDemand named query. This class contains search criteria details that are stored in a named query.
- com.ibm.edms.od.ODNote
- This class represents a Content Manager OnDemand annotation.
- com.ibm.edms.od.ODServer
- This class represents a connection to a Content Manager OnDemand server. From this class you can log on, log off and change the password. After a successful logon, this object will contain a list of all folders that the session has access to.
- com.ibm.edms.od.ODTransform
- This class represents the configuration settings for a single Generic transform to be defined to the ODWEK Java APIs.
- com.ibm.edms.od.ODUser
- This class represents a Content Manager OnDemand user. From this class, you can gather user information such as address and phone number that is stored in the Content Manager OnDemand server.