FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface ObjectStore

All Superinterfaces:
BaseObject, ReadableMetadataObject, java.io.Serializable, ValueObject
All Known Subinterfaces:
ObjectStore

public interface ObjectStore
extends BaseObject, ReadableMetadataObject

This base interface includes methods for getting objects persisted in the object store and retrieving metadata.

See Also:
CS Java Connector Developer's Guide

Field Summary
static java.lang.String APPLICATION_DEFINED_TEMPLATES
          Value of "{B5C56D91-CD7D-493B-BE36-A21360F34D8C}"; GUID representing the Content Services StringLookup object's application-defined templates list.
static int SUPPORTS_ACL_MODIFICATIONS
          Value of 6; object store supports modifications to Access Control Lists (permissions).
static int SUPPORTS_ANNOTATIONS
          Value of 1; object store supports document annotations.
static int SUPPORTS_CONTENT_SEARCH
          Value of 8; object store supports content searching.
static int SUPPORTS_CUSTOM_OBJECT
          Value of 9; object store supports custom objects.
static int SUPPORTS_DOC_DELETE
          Value of 2; object store supports document deletion.
static int SUPPORTS_DOC_PAGES
          Not applicable.
static int SUPPORTS_DOC_VERSIONS
          Value of 4; object store supports document versioning.
static int SUPPORTS_QUEUES
          Not applicable.
static int SUPPORTS_REMOTE_PRINT
          Not applicable.
static int SUPPORTS_STORED_SEARCH
          Not applicable.
static java.lang.String VERSION_STATUS_LOOKUP
          Value of "{BFF36187-91DF-4F90-BAC5-CD5B3F3C6D8A}"; GUID representing the Content Services StringLookup object's version status list.
 
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
 
Method Summary
 ContainableObject createAndFileObject(java.lang.String classId, Properties props, Permissions acls, Folder folder)
          

Not Implemented in CS Java Connector v3.0.

 CreatableObject createObject(java.lang.String classId, Properties props, Permissions acls)
          Returns a CreatableObject object, with the specified properties and permissions, which you cast to the appropriate BaseObject object type.
 java.lang.String exportObjects(java.lang.String exportFilter, int flags)
          

Not Implemented in CS Java Connector v3.0.

 Documents getCheckoutList()
          Returns a collection of Document objects that the current user has checked out from this object store.
 Documents getCheckoutList(java.lang.String[] propNames)
          Returns a collection of Document objects that the current user has checked out from this object store, plus the requested document properties specified by their symbolic property names.
 java.lang.String getCheckoutListXML(java.lang.String[] propNames)
          Returns a String in XML that contains a representation of documents that the current user has checked out from this object store.
 ChoiceLists getChoiceLists(java.util.Vector cvlids, int depth)
          Returns a ChoiceLists collection.
 java.lang.String getChoiceListsXML(java.util.Vector cvlids, int depth)
          Returns a String in XML that represents a set of ChoiceList objects.
 ClassDescriptions getClassDescriptions()
          Returns a collection of all class descriptions for this ObjectStore object.
 ClassDescriptions getClassDescriptions(boolean getAll)
          Returns all class descriptions for this ObjectStore object.
 ClassDescriptions getClassDescriptions(ClassDescriptions classDescs)
          Returns a collection of ClassDescription objects for the specified Content Services classes.
 ClassDescriptions getClassDescriptions(ClassDescriptions classDescs, boolean getAll)
          Returns a collection of ClassDescription objects for the specified Content Services classes.
 ClassDescriptions getClassDescriptions(int[] objTypes)
          Returns a collection of ClassDescription objects for the Content Services classes for the requested object types.
 ClassDescriptions getClassDescriptions(int[] objTypes, boolean getAll)
          Returns a collection of ClassDescription objects for the Content Services classes associated with the requested object types.
 java.lang.String getClassDescriptionsXML(ClassDescriptions classDescs)
          Returns a String in XML that represents the class descriptions for Content Services classes.
 java.lang.String getClassDescriptionsXML(ClassDescriptions classDescs, boolean getAll)
          Returns a String in XML that represents the class descriptions for Content Services classes.
 java.lang.String getClassDescriptionsXML(int[] objTypes)
          Returns a String in XML that represents the class descriptions for the Content Services classes for the requested object types.
 java.lang.String getClassDescriptionsXML(int[] objTypes, boolean getAll)
          Returns a String in XML that represents the class descriptions for the Content Services classes associated with the requested object types.
 java.lang.String[] getClassifierMimeTypes()
          

Not Implemented in CS Java Connector v3.0.

 EventActions getEventActions()
          

Not Implemented in CS Java Connector v3.0.

 EventActions getEventActions(java.lang.String[] propNames)
          

Not Implemented in CS Java Connector v3.0.

 GettableObject getObject(int objectType, java.lang.String id)
          Returns a GettableObject object.
 PropertyDescriptions getPropertyDescriptions(ClassDescriptions classDescs)
          Returns property descriptions for the specified classes.
 PropertyDescriptions getPropertyDescriptions(ClassDescriptions classDescs, boolean getAll)
          Returns a PropertyDescriptions collection whose elements are property descriptions for the specified classes.
 PropertyDescriptions getPropertyDescriptions(int[] objTypes)
          Returns a collection of PropertyDescription objects for the specified object types.
 PropertyDescriptions getPropertyDescriptions(int[] objTypes, boolean getAll)
          Returns a collection of PropertyDescription objects for the specified object types.
 java.lang.String getPropertyDescriptionsXML(ClassDescriptions classDescs)
          Returns a String in XML that represents property descriptions for the specified classes.
 java.lang.String getPropertyDescriptionsXML(ClassDescriptions classDescs, boolean getAll)
          Returns a String in XML that represents property descriptions for the specified classes.
 java.lang.String getPropertyDescriptionsXML(int[] objTypes)
          Returns a String in XML that represents a collection of property descriptions for a specified set of object types.
 java.lang.String getPropertyDescriptionsXML(int[] objTypes, boolean getAll)
          Returns a String in XML that represents a collection of property descriptions for a specified set of object types.
 PublishRequests getPublishRequests(PublishRequestFilter filter)
          

Not Implemented in CS Java Connector v3.0.

 PublishRequests getPublishRequests(PublishRequestFilter filter, java.lang.String providerId, int maxResults)
          

Not Implemented in CS Java Connector v3.0.

 Folder getRootFolder()
          Returns a reference to the root folder of an object store on the Content Services server.
 SecurityPolicies getSecurityPolicies()
          

Not Implemented in CS Java Connector v3.0.

 SecurityPolicies getSecurityPolicies(ClassDescription cd, boolean includeSubclasses)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getSecurityPoliciesXML()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getSecurityPoliciesXML(ClassDescription cd, boolean includeSubclasses)
          

Not Implemented in CS Java Connector v3.0.

 StoredSearches getStoredSearches(int[] objTypes, java.lang.String[] propNames)
          Deprecated. Use int[], String[] form of this method. Returns a collection of StoredSearch objects, including the properties of those objects as specified by their symbolic property names.

You can use this method to retrieve stored searches, search templates, or both. Identify what to retrieve in the objTypes parameter, which is an int array that can contain the following object types:

  • Stored searches (StoredSearch.TYPE_SEARCH)
  • Search templates (StoredSearch.TYPE_TEMPLATE)

Note: If the int array contains other BaseObject object types, they are ignored.

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. An exception is thrown if the array contains property names that are invalid or not selectable.

 java.lang.String getStoredSearchesXML(int[] objTypes, java.lang.String[] propNames)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String[][] getStringLookupLists(java.lang.String objId)
          

Not Implemented in CS Java Connector v3.0.

 StyleTemplates getStyleTemplates()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getTopFoldersXML(java.lang.String[] propNames)
          Returns a String in XML that contains a representation of a Folders collection whose elements are the top folders of the object store, that is, the immediate subfolders of the root folder.
 WorkflowDefinitions getWorkflowDefinitions()
          

Not Implemented in CS Java Connector v3.0.

 WorkflowDefinitions getWorkflowDefinitions(java.lang.String[] propNames)
          

Not Implemented in CS Java Connector v3.0.

 BaseObject importBaseObject(int objType, java.lang.String importXML, int flags)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String importObjects(java.lang.String importXML, int flags)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String installFeatureAddOn(FeatureAddOn addOnInst)
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String installFeatureAddOn(FeatureAddOn addOnInst, int flags)
          Deprecated. Use installFeatureAddOn(FeatureAddOn addOnInst).
 boolean supports(int value)
          Returns a boolean value that indicates whether this object store supports a specific capability.
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 

Field Detail

SUPPORTS_ACL_MODIFICATIONS

public static final int SUPPORTS_ACL_MODIFICATIONS
Value of 6; object store supports modifications to Access Control Lists (permissions).

See Also:
Constant Field Values

SUPPORTS_ANNOTATIONS

public static final int SUPPORTS_ANNOTATIONS
Value of 1; object store supports document annotations.

See Also:
Constant Field Values

SUPPORTS_CONTENT_SEARCH

public static final int SUPPORTS_CONTENT_SEARCH
Value of 8; object store supports content searching.

See Also:
Constant Field Values

SUPPORTS_CUSTOM_OBJECT

public static final int SUPPORTS_CUSTOM_OBJECT
Value of 9; object store supports custom objects.

See Also:
Constant Field Values

SUPPORTS_DOC_DELETE

public static final int SUPPORTS_DOC_DELETE
Value of 2; object store supports document deletion.

See Also:
Constant Field Values

SUPPORTS_DOC_PAGES

public static final int SUPPORTS_DOC_PAGES
Not applicable. Value of 3; object store supports document pages.

See Also:
Constant Field Values

SUPPORTS_DOC_VERSIONS

public static final int SUPPORTS_DOC_VERSIONS
Value of 4; object store supports document versioning.

See Also:
Constant Field Values

SUPPORTS_QUEUES

public static final int SUPPORTS_QUEUES
Not applicable. Value of 7; object store supports queues.

See Also:
Constant Field Values

SUPPORTS_REMOTE_PRINT

public static final int SUPPORTS_REMOTE_PRINT
Not applicable. Value of 5; object store supports remote printing.

See Also:
Constant Field Values

SUPPORTS_STORED_SEARCH

public static final int SUPPORTS_STORED_SEARCH
Not applicable. Value of 10; object store supports stored searches.

See Also:
Constant Field Values

APPLICATION_DEFINED_TEMPLATES

public static final java.lang.String APPLICATION_DEFINED_TEMPLATES
Value of "{B5C56D91-CD7D-493B-BE36-A21360F34D8C}"; GUID representing the Content Services StringLookup object's application-defined templates list.

See Also:
Constant Field Values

VERSION_STATUS_LOOKUP

public static final java.lang.String VERSION_STATUS_LOOKUP
Value of "{BFF36187-91DF-4F90-BAC5-CD5B3F3C6D8A}"; GUID representing the Content Services StringLookup object's version status list.

See Also:
Constant Field Values
Method Detail

getWorkflowDefinitions

public WorkflowDefinitions getWorkflowDefinitions()

Not Implemented in CS Java Connector v3.0.

Returns a collection of WorkflowDefinition objects on this object store. A WorkflowDefinition object extends the Document object, and contains the definition of a workflow (for example, the instructions, paths, and queues available to, and needed by, the workflow to complete the activities of a business process).

Returns:
A WorkflowDefinitions collection object.

getWorkflowDefinitions

public WorkflowDefinitions getWorkflowDefinitions(java.lang.String[] propNames)

Not Implemented in CS Java Connector v3.0.

Returns a collection of WorkflowDefinition objects on this object store. A WorkflowDefinition object extends the Document object, and contains the definition of a workflow (for example, the instructions, paths, and queues available to, and needed by, the workflow to complete the activities of a business process).

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. If the array contains property names that do not exist for the WorkflowDefinition objects, those properties are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of properties to retrieve for each returned object. Can be null or an empty array. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
A WorkflowDefinitions collection object.

getEventActions

public EventActions getEventActions()

Not Implemented in CS Java Connector v3.0.

Returns an EventActions collection, the elements of which represent all EventAction objects on this object store. An EventAction object defines the actions taken when a workflow is launched via an event subscribed to by a WorkflowSubscription object.

Returns:
An EventActions collection object.

getEventActions

public EventActions getEventActions(java.lang.String[] propNames)

Not Implemented in CS Java Connector v3.0.

Returns an EventActions collection, the elements of which represent all EventAction objects on this object store. An EventAction object defines the actions taken when a workflow is launched via an event subscribed to by a WorkflowSubscription object.

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. If the array contains property names that do not exist for the EventAction objects, those properties are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of properties to retrieve for each returned object. Can be null or an empty array. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
An EventActions collection object.

getClassifierMimeTypes

public java.lang.String[] getClassifierMimeTypes()

Not Implemented in CS Java Connector v3.0.

Returns a String array of MIME types for which this object store has a registered Classifier. Classifier modules are installed on the Content Services server and are registered to the operating system by MIME type. One Classifier is available per MIME type. The system administrator is responsible for configuring the object store on the Content Services server for autoclassification.

When you call checkin or setContent on a Document or VersionSeries object, you can set the autoclassifier parameter to true to specify that the document should be enabled for autoclassification. You can call getClassifierMimeTypes() prior to calling checkin to determine if there is an appropriate Classifier available for the document.

Returns:
A String array of MIME types.

getClassDescriptions

public ClassDescriptions getClassDescriptions()
Returns a collection of all class descriptions for this ObjectStore object. To retrieve class descriptions for a specific object or for a limited set of objects, use one of the other forms of this method as a more efficient retrieval mechanism. To filter out hidden class descriptions, use a form of this method that takes a getAll parameter.

Returns:
A ClassDescriptions collection.

getClassDescriptions

public ClassDescriptions getClassDescriptions(boolean getAll)
Returns all class descriptions for this ObjectStore object.

To retrieve class descriptions for a specific object or for a limited set of objects, use one of the other forms of this method as a more efficient retrieval mechanism.

Parameters:
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
A ClassDescriptions collection that contains the requested class descriptions for this ObjectStore object.

getPropertyDescriptions

public PropertyDescriptions getPropertyDescriptions(int[] objTypes)
Returns a collection of PropertyDescription objects for the specified object types.

Specify the object types to return in an int array using constants defined in the BaseObject interface. If the input array contains multiple object types, this method returns a single collection containing property descriptions for all of the input object types.

Note that a particular Property Description may exhibit property value differences depending on the ClassDescription or ObjectStore object from which the Property Description was obtained. Such programmatic discrepancies can occur because of the override rules inherent in Content Services' administration of property descriptions and classes. For further explanation, see the "Properties" section in the CS Java Connector Developer's Guide

Parameters:
objTypes - An int array of BaseObject object types.

Returns:
A PropertyDescriptions collection.

getPropertyDescriptions

public PropertyDescriptions getPropertyDescriptions(int[] objTypes,
                                                    boolean getAll)
Returns a collection of PropertyDescription objects for the specified object types.

Specify the object types to return in an int array using constants defined in the BaseObject interface. This method returns the property descriptions for a given object type. If the integer array contains multiple object types, this method returns a single collection containing property descriptions for all of the input object types.

For this version of the Content Services Java Connector, you can specify the following types in the integer array:

Note that a particular Property Description may exhibit property value differences depending on the ClassDescription or ObjectStore object from which the Property Description was obtained. Such programmatic discrepancies can occur because of the override rules inherent in Content Services' administration of property descriptions and classes. For further explanation, see the "Properties" section in the CS Java Connector Developer's Guide.

Parameters:
objTypes - An int array of BaseObject object types.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
A PropertyDescriptions collection containing the property descriptions for the requested object types.

getClassDescriptions

public ClassDescriptions getClassDescriptions(int[] objTypes)
Returns a collection of ClassDescription objects for the Content Services classes for the requested object types.

Use this method for efficient retrieval of class descriptions for a specific BaseObject object or for a limited set of BaseObject objects. The object types you can filter for are available as constants in the BaseObject interface; specify them as an int array. If the integer array contains multiple object types, the method returns a single collection containing class descriptions for all of the input object types.

For this version of the Content Services Java Connector, you can specify the following types in the integer array:

The following example returns the class description for a Document object within a previously defined ObjectStore object, objStore:

 int[] objTypes = new int[] {BaseObject.TYPE_DOCUMENT};
 ClassDescriptions classDescs = objStore.getClassDescriptions(objTypes);

Parameters:
objTypes - An int array of BaseObject objects.

Returns:
A ClassDescriptions collection.

getClassDescriptions

public ClassDescriptions getClassDescriptions(int[] objTypes,
                                              boolean getAll)
Returns a collection of ClassDescription objects for the Content Services classes associated with the requested object types.

Use this method for efficient retrieval of class descriptions for a specific BaseObject object or for a limited set of BaseObject objects. The object types you can filter for are available as constants in the BaseObject interface; specify them as an int array. If the integer array contains multiple object types, the method returns a single collection containing class descriptions for all of the input object types.

For this version of the Content Services Java Connector, you can specify the following types in the integer array:

The following example returns the class description for a Document object within a previously defined ObjectStore object, objStore:

 int[] objTypes = new int[] {BaseObject.TYPE_DOCUMENT};
 ClassDescriptions classDescs = objStore.getClassDescriptions(objTypes, true);

Parameters:
objTypes - An int array of BaseObject objects.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
A ClassDescriptions collection that contains the requested class descriptions for this ObjectStore object.

getPropertyDescriptions

public PropertyDescriptions getPropertyDescriptions(ClassDescriptions classDescs)
Returns property descriptions for the specified classes. To filter out hidden property descriptions, use the getPropertyDescriptions(classDescs, getAll) form of this method.

The properties returned by this method may not be a one-to-one match with the property descriptions for the class. For example, for a Document class, this method returns a number of property descriptions, one for each Document property available on this ObjectStore object.

The argument to this method is a ClassDescriptions collection object, the elements of which you can specify by their GUIDs. (GUIDs for some objects are available as constants in the ClassDescription interface. You can also call the getClassId() method of most objects to obtain the GUID for the object's class. The exception is the Property object, which is not a subclass of BaseObject.)

Note that although this method returns the PropertyDescription objects for each ClassDescription object specified in the input collection, there is no way to determine which PropertyDescription object applies to which ClassDescription. As an alternative, you can use the following methods to retrieve property descriptions that can be readily identified as belonging to a particular class:

Parameters:
classDescs - A ClassDescriptions collection containing the ClassDescription objects for which PropertyDescription objects are requested. Cannot be null. Can be an empty collection, in which case the method returns all PropertyDescription objects for this object store.

Returns:
A PropertyDescriptions collection that contains property descriptions for the requested classes.

getPropertyDescriptions

public PropertyDescriptions getPropertyDescriptions(ClassDescriptions classDescs,
                                                    boolean getAll)
Returns a PropertyDescriptions collection whose elements are property descriptions for the specified classes.

The properties returned by this method may not be a one-to-one match with the property descriptions for the class. For example, for a Document class, this method returns a number of property descriptions, one for each Document property available on this ObjectStore object.

The argument to this method is a ClassDescriptions collection object, the elements of which you can specify by their GUIDs. (GUIDs for some objects are available as constants in the ClassDescription interface. You can also call the getClassId() method of most objects to obtain the GUID for the object's class. The exception is the Property object, which is not a subclass of BaseObject.)

Note that although this method returns the PropertyDescription objects for each ClassDescription object specified in the input collection, there is no way to determine which PropertyDescription object applies to which ClassDescription. As an alternative, you can use the following methods to retrieve property descriptions that can be readily identified as belonging to a particular class:

Parameters:
classDescs - A ClassDescriptions collection containing the ClassDescription objects for which PropertyDescription objects are requested. Cannot be null. Can be an empty collection, in which case the method returns all PropertyDescription objects for this object store.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
A PropertyDescriptions collection that contains the property descriptions for the requested classes.

getClassDescriptions

public ClassDescriptions getClassDescriptions(ClassDescriptions classDescs)
Returns a collection of ClassDescription objects for the specified Content Services classes.

Use this method for efficient retrieval of class descriptions for a specific object's class description or for a limited set of class descriptions. The argument passed to this method is a ClassDescriptions collection, the elements of which you can specify as ClassDescription GUIDs. (GUIDs for some objects are available as constants in the ClassDescription interface. You can also call the getClassId() method of most objects to obtain the GUID for the object's class.)

Parameters:
classDescs - A ClassDescriptions collection containing class IDs for which ClassDescription objects are requested. Cannot be null. Can be an empty collection, in which case the method returns all ClassDescription objects for this object store.

Returns:
A ClassDescriptions collection containing the requested class descriptions.

getClassDescriptions

public ClassDescriptions getClassDescriptions(ClassDescriptions classDescs,
                                              boolean getAll)
Returns a collection of ClassDescription objects for the specified Content Services classes.

Use this method for efficient retrieval of class descriptions for a specific object's class description or for a limited set of class descriptions. The argument passed to this method is a ClassDescriptions collection, the elements of which you can specify as of class IDs specified as GUIDs. (Class IDs for some objects are available as constants in the ClassDescription interface. You can also call the getClassId() method of most objects to obtain the GUID for the object's class.)

Parameters:
classDescs - A ClassDescriptions collection containing class IDs for which ClassDescription objects are requested. Cannot be null. Can be an empty collection, in which case the method returns all ClassDescription objects for this object store.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
A ClassDescriptions collection.

getCheckoutList

public Documents getCheckoutList()
Returns a collection of Document objects that the current user has checked out from this object store.

Returns:
A Documents collection.

getCheckoutList

public Documents getCheckoutList(java.lang.String[] propNames)
Returns a collection of Document objects that the current user has checked out from this object store, plus the requested document properties specified by their symbolic property names.

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. If the array contains property names that do not exist for the Document objects, those properties are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of properties to retrieve for each returned object. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
A Documents collection.

getObject

public GettableObject getObject(int objectType,
                                java.lang.String id)
Returns a GettableObject object. You can call this method for any CS Java Connector object that extends the GettableObject interface. Cast the returned object to the appropriate BaseObject object type.

Specify the object to be returned as a BaseObject type, such as BaseObject.TYPE_DOCUMENT, as shown in the following code fragment:

Document objA =
     (Document)objStore1.getObject(BaseObject.TYPE_DOCUMENT, documentID);

This method verifies the existence of the requested object; if the object does not exist in Content Services server, it throws a BadReferenceException.

BaseObject.TYPE_ANY is not supported for objectType argument. The id parameter is required and can be specified as the idmId of the specific instance of the object in the object store. An object can not be retrieved by its path name from ObjectStore.

Parameters:
objectType - A BaseObject type.

id - A String that represents the idmId of the object specified in the objectType parameter.

Returns:
A GettableObject interface representing a reference to a Content Services server object, cast to the appropriate BaseObject object type.

getRootFolder

public Folder getRootFolder()
Returns a reference to the root folder of an object store on the Content Services server.

You cannot delete or rename the root folder but you can perform other operations on this folder in the same manner as any other folder, such as retrieving a list of the root folder's containees.

Returns:
A reference to the root Folder object of this object store.

createObject

public CreatableObject createObject(java.lang.String classId,
                                    Properties props,
                                    Permissions acls)
Returns a CreatableObject object, with the specified properties and permissions, which you cast to the appropriate BaseObject object type. This method returns a reference to the object in the object store but does not file the object into a folder, check it in, or set its content.

Note: For this release of the CS Java Connector, you can only create a Document object with this method.

The following code fragment creates a Document object:
 System.out.println("Creating the Document object");
 Document DocumentObj = (Document)objStore.createObject(ClassDescription.DOCUMENT,
                                props, null);
 System.out.println("Document object successfully created");

Some Content Services object properties have default values. When you create an object, some properties are required to have values. Therefore, when calling createObject, you need only supply values for those properties that are required but have no default values.

If you supply permissions in the Permissions collection, the method creates the object with the supplied permissions. If you pass in null for the collection, the Default Item Access List of the user creating the object is applied. To change the defaults, you must subsequently call setPermissions on the object.

If you create an object that the user subsequently does not have permission to access--either because the default security or the explicitly-set permissions require a greater level of access--an exception will be thrown even if the object is successfully created.

Parameters:
classId - A String that represents the ID or the symbolic name of the class on the Content Services server.

props - A Properties collection containing the properties to assign to the created object. If this parameter is null or is an empty collection, the default behavior is to assign properties based on the equivalent Content Services object.

acls - A Permissions collection that contains the access rights (permissions) to be assigned to the created object. Note that the permissions you set represent basic object permissions (that is, an object's Permissions property). If null, the permissions in the user's Default Item Access List are applied. Passing an empty collection throws an exception.

Returns:
A CreatableObject interface, which you cast to the appropriate BaseObject object type.

getStoredSearches

public StoredSearches getStoredSearches(int[] objTypes,
                                        java.lang.String[] propNames)
Deprecated. Use int[], String[] form of this method. Returns a collection of StoredSearch objects, including the properties of those objects as specified by their symbolic property names.

You can use this method to retrieve stored searches, search templates, or both. Identify what to retrieve in the objTypes parameter, which is an int array that can contain the following object types:

  • Stored searches (StoredSearch.TYPE_SEARCH)
  • Search templates (StoredSearch.TYPE_TEMPLATE)

Note: If the int array contains other BaseObject object types, they are ignored.

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. An exception is thrown if the array contains property names that are invalid or not selectable.

Not Implemented in CS Java Connector v3.0.

Parameters:
objTypes - An int array of object types limited to either StoredSearch.TYPE_TEMPLATE or StoredSearch.TYPE_SEARCH. Specifying both types returns stored searches and search templates.

propNames - A String array whose elements specify the symbolic names of properties to retrieve for each returned object. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
A collection of StoredSearch objects.

getChoiceLists

public ChoiceLists getChoiceLists(java.util.Vector cvlids,
                                  int depth)
Returns a ChoiceLists collection. Each element of the returned ChoiceLists collection is a ChoiceList collection object.

A ChoiceList represents a set of choices for a settable property. The elements in the ChoiceList collection are Choice objects, each of which represents a possible value for the property.

The ChoiceList objects are represented by a Vector array of CVL (Controlled Vocabulary Lists) names in the cvlids parameter.

Parameters:
cvlids - A Vector array of CVL name Strings. If null, all choice lists for this object store are returned.

depth - Requires an integer value; however, the value is ignored by the CS Java Connector.

Returns:
A ChoiceLists collection.

getChoiceListsXML

public java.lang.String getChoiceListsXML(java.util.Vector cvlids,
                                          int depth)
Returns a String in XML that represents a set of ChoiceList objects. The ChoiceList objects in the String are determined by passing a vector array of ChoiceList IDs to the method.

A ChoiceList represents a set of choices for a settable property. The elements in the ChoiceList are Choice objects, each of which represents a possible value for the property.

The ChoiceList objects, represented by a Vector array of CVL (Controlled Vocabulary Lists) names in the cvlids parameter.

Parameters:
cvlids - A Vector array of CVL name Strings. If this parameter is null or is an empty array, all choice lists for this object store are returned.

depth - Requires an integer value; however, the value is ignored by the CS Java Connector.

Returns:
A String representation of a collection of ChoiceList objects.

getClassDescriptionsXML

public java.lang.String getClassDescriptionsXML(ClassDescriptions classDescs)
Returns a String in XML that represents the class descriptions for Content Services classes.

Specify the class descriptions to retrieve in the classDescs parameter, using constants defined in the ClassDescriptions interface. To filter out hidden class descriptions, use the getClassDescriptions(classDescs, getAll) form of this method.

Parameters:
classDescs - A ClassDescriptions collection. Cannot be null. Can be an empty collection, in which case the method returns XML that represents all ClassDescription objects for this object store.

Returns:
An XML String representing the requested class descriptions for this object store.

getClassDescriptionsXML

public java.lang.String getClassDescriptionsXML(ClassDescriptions classDescs,
                                                boolean getAll)
Returns a String in XML that represents the class descriptions for Content Services classes.

Specify the class descriptions to retrieve in the classDescs, using constants defined in the ClassDescriptions interface.

Parameters:
classDescs - A ClassDescriptions collection. Cannot be null. Can be an empty collection, in which case the method returns XML that represents all ClassDescription objects for this object store.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
An XML String representing the requested class descriptions for this object store.

getClassDescriptionsXML

public java.lang.String getClassDescriptionsXML(int[] objTypes)
Returns a String in XML that represents the class descriptions for the Content Services classes for the requested object types. Specify the object types in an int array using constants defined in the BaseObject interface. As an example, if the collection contains an object type of Document (BaseObject.TYPE_DOCUMENT), this method returns a String that represents the class descriptions for all Document objects in this object store.

To filter out hidden class descriptions, use the getClassDescriptionsXML(objTypes, getAll) form of this method.

Parameters:
objTypes - An int array of BaseObject object types.

Returns:
An XML String representing the class descriptions for the requested object types.

getClassDescriptionsXML

public java.lang.String getClassDescriptionsXML(int[] objTypes,
                                                boolean getAll)
Returns a String in XML that represents the class descriptions for the Content Services classes associated with the requested object types. Specify the object types in an int array using constants defined in the BaseObject interface. As an example, if the collection contains an object type of Document (BaseObject.TYPE_DOCUMENT), this method returns a String that represents the class descriptions for all Document objects in this object store.

Parameters:
objTypes - An int array of BaseObject object types.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
An XML String representing the class descriptions for the requested object types.

getPropertyDescriptionsXML

public java.lang.String getPropertyDescriptionsXML(ClassDescriptions classDescs)
Returns a String in XML that represents property descriptions for the specified classes. To filter out hidden property descriptions, use the getPropertyDescriptions(classDescs, getAll) form of this method.

Specify the classes for which you want to retrieve property descriptions in a ClassDescriptions collection using constants defined in the ClassDescription interface. As an example, to return property descriptions for a folder, add ClassDescription.FOLDER as an element of the ClassDescriptions collection.

Note that although this method returns the property descriptions for each ClassDescription object passed in, there is no way to determine which property description applies to which ClassDescription. As an alternative, you can use the following methods to retrieve property descriptions that can be readily identified as belonging to a particular class:

Parameters:
classDescs - A ClassDescriptions collection that specifies the classes for which property descriptions are requested. Cannot be null. Can be an empty collection, in which case this method returns XML that represents all of the property descriptions for this object store.

Returns:
An XML String that represents the property descriptions for the specified classes.

getPropertyDescriptionsXML

public java.lang.String getPropertyDescriptionsXML(ClassDescriptions classDescs,
                                                   boolean getAll)
Returns a String in XML that represents property descriptions for the specified classes.

Specify the classes in a ClassDescriptions collection using constants defined in the ClassDescription interface. As an example, to return property descriptions for a folder, add ClassDescription.FOLDER as an element of the ClassDescriptions collection.

Note that although this method returns the property descriptions for each ClassDescription object passed in, there is no way to determine which property description applies to which ClassDescription. As an alternative, you can use the following methods to retrieve property descriptions that can be readily identified as belonging to a particular class:

Parameters:
classDescs - A ClassDescriptions collection that specifies the classes for which property descriptions are requested. Cannot be null. Can be an empty collection, in which case this method returns XML that represents all of the property descriptions for this object store.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
An XML String that represents the property descriptions for the specified classes.

getPropertyDescriptionsXML

public java.lang.String getPropertyDescriptionsXML(int[] objTypes)
Returns a String in XML that represents a collection of property descriptions for a specified set of object types. Specify the object types in an int array using constants defined in the BaseObject interface.

Parameters:
objTypes - An int array of BaseObject object types.

Returns:
An XML String representing the property descriptions for the requested object types.

getPropertyDescriptionsXML

public java.lang.String getPropertyDescriptionsXML(int[] objTypes,
                                                   boolean getAll)
Returns a String in XML that represents a collection of property descriptions for a specified set of object types. Specify the object types in an int array using constants defined in the BaseObject interface.

Note that a particular Property Description may exhibit property value differences depending on the ClassDescription or ObjectStore object from which the Property Description was obtained. Such programmatic discrepancies can occur because of the override rules inherent in Content Services' administration of property descriptions and classes. For further explanation, see the "Properties" section in the CS Java Connector Developer's Guide.

Parameters:
objTypes - An int array of BaseObject object types.
getAll - Requires a boolean value; however, the value is ignored by the CS Java Connector.

Returns:
An XML String representing the property descriptions for the requested object types.

getCheckoutListXML

public java.lang.String getCheckoutListXML(java.lang.String[] propNames)
Returns a String in XML that contains a representation of documents that the current user has checked out from this object store. The current user is identified in the Session object.

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. If the array contains property names that do not exist for the documents, those properties are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the symbolic names of properties to retrieve. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
A String containing an XML representation of the checked out documents.

getTopFoldersXML

public java.lang.String getTopFoldersXML(java.lang.String[] propNames)
Returns a String in XML that contains a representation of a Folders collection whose elements are the top folders of the object store, that is, the immediate subfolders of the root folder.

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties for the top folders. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. If the array contains property names that do not exist for the Folder objects, those properties are ignored (no exception is thrown).

Parameters:
propNames - A String array whose elements specify the properties to retrieve. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
A String containing an XML representation of the top folders of this object store.

getStoredSearchesXML

public java.lang.String getStoredSearchesXML(int[] objTypes,
                                             java.lang.String[] propNames)

Not Implemented in CS Java Connector v3.0.

Returns a String in XML representing a collection of StoredSearch objects.

Use this method to retrieve string representations of stored searches, search templates, or both. Identify what to retrieve in the objTypes parameter, which is an int array that can contain the following object types:

If the propNames parameter is null or an empty array, this method retrieves an initial set of hard-coded properties. However, because this set can vary from release to release, we recommend you specify the properties your application requires in the propNames array. An exception is thrown if the array contains property names that are invalid or not selectable.

Parameters:
objTypes - An array of object types limited to either StoredSearch.TYPE_TEMPLATE or StoredSearch.TYPE_SEARCH. Specifying both types returns stored searches and search templates.

propNames - A String array whose elements specify the properties to retrieve. (If you pass in a null, you must first explicitly cast it to a String[] to avoid a compilation error.)

Returns:
A String containing an XML representation of StoredSearch objects.

getPublishRequests

public PublishRequests getPublishRequests(PublishRequestFilter filter)

Not Implemented in CS Java Connector v3.0.

Returns a collection of PublishRequest objects that are currently queued for this object store.

The returned collection can contain all of the PublishRequest objects queued for this object store, or a subset based on the filter parameter you pass to the method. The states for which you can filter are:

As an example, you can limit the returned collection to only those PublishRequest objects that are in a particular state, such as currently being processed (inWork) or unsuccessfully processed (inError). You can retrieve multiple publish request types by OR'ing together values. For example, passing in a value of 3 retrieves inQueue publish requests and inWork publish requests only.

Parameters:
filter - A PublishRequestFilter object. Specifying null is equivalent to specifying 0 (zero) or returnAll.

Returns:
A collection of PublishRequest objects. The collection can contain all PublishRequest objects queued for this object store, or a subset based on the filter parameter.

getPublishRequests

public PublishRequests getPublishRequests(PublishRequestFilter filter,
                                          java.lang.String providerId,
                                          int maxResults)

Not Implemented in CS Java Connector v3.0.

Returns a collection of all PublishRequest objects, or a subset based on a specified provider ID, that are currently queued for this object store. In addition to returning all properties for each PublishRequest object in the collection, this method also returns two additional properties that provide information about the publish request: the ProviderID property from the associated StyleTemplate object's TransformationEngine (i.e., Plug-in) and the DocumentTitle property from the source Document object. If there is no style template associated with the publish request (for example, if its style template has been deleted), the returned ProviderID property will be empty. If the source document's DocumentTitle property is not set, the returned DocumentTitle will be empty.

The returned collection can contain all of the PublishRequest objects queued for this object store, or a subset based on the filter and providerId parameters you pass to the method. The number of PublishRequests returned can also be limited by using the maxResults parameter. The states for which you can filter are:

As an example, you can limit the returned collection to only those PublishRequest objects that are in a particular state, such as currently being processed (inWork) or unsuccessfully processed (inError). You can retrieve multiple publish request types by OR'ing together values. For example, passing in a value of 3 retrieves inQueue publish requests and inWork publish requests only.

Specifying the providerId parameter further limits the results by returning only those publish requests queued for the specified transformation plug-in provider. As an example, the following code fragment returns a maximum of 50 publish requests that are queued for HTML plug-in processing:

 PublishRequests collPRs =
     objectStore.getPublishRequests(PublishRequestFilter.inQueue,
     "com.filenet.cee.publishing.HTML", 50);

Parameters:
filter - A PublishRequestFilter object. Specifying null is equivalent to specifying 0 (zero) or returnAll.

providerId - A String specifying the provider ID for which PublishRequest objects are to be returned. If null or an empty String, returns PublishRequest objects for all providers.

maxResults - An integer specifying the maximum number of PublishRequest objects to return. Specifying 0 (zero) returns all PublishRequest objects.

Returns:
A PublishRequests collection. The collection can contain all PublishRequest objects queued for this object store, or a subset based on the input parameters.

getStyleTemplates

public StyleTemplates getStyleTemplates()

Not Implemented in CS Java Connector v3.0.

Returns a collection that contains all the StyleTemplate objects for this object store. This method also retrieves and caches the following properties for the returned StyleTemplate objects: OIID, CustomTemplateName, Description, OutputFormat, ProviderID, Title, and TransformationInstructions. No other properties are returned.

Returns:
A collection containing all StyleTemplate objects for this object store.

supports

public boolean supports(int value)
Returns a boolean value that indicates whether this object store supports a specific capability. Use the SUPPORTS_ constants defined in this interface to specify the capabilities you can test for.

Parameters:
value - An integer representing the object store capability to be tested for. Use SUPPORTS_ constants to specify the capability.

Returns:
A boolean - true indicates that this object store supports the specified capability; false indicates it does not support the capability.

createAndFileObject

public ContainableObject createAndFileObject(java.lang.String classId,
                                             Properties props,
                                             Permissions acls,
                                             Folder folder)

Not Implemented in CS Java Connector v3.0.

Creates and files an object to a specified folder in a single roundtrip to the Content Services server. This method returns a ContainableObject object, with the specified properties and permissions, which you cast to either a Document or a CustomObject object. In contrast to the createObject method, this method also automatically files the object in the folder. To successfully file an object into the folder, the caller must have Link permission on the specified Folder object. The folder assignment you specify in the folder parameter is ignored when creating objects other than Document and CustomObject.

A Document object created with this method does not have content and cannot be autoclassified. Prior to filing in the folder, this method automatically checks in the Document object as a released version.

When you file an object into a folder, the Content Services server sets the containment name to the object's Name property. If the Name property is blank, the containment name is set to the object's ID property (a GUID). If the object's Name property is used for the containment name and results in a duplicate name within the folder, then the name is automatically modified to achieve uniqueness. After the object has been filed, you can determine its containment name by calling getContainmentNames.

Some Content Services object properties have default values. When you create an object, some properties are required to have values. Therefore, when calling createAndFileObject, you need only supply values for those properties that are required but have no default values.

If you supply permissions in the Permissions collection, this method creates the object with the supplied permissions. If you pass in null for the collection, the created object inherits from the class's default instance permissions. To change the defaults, you must subsequently call setPermissions on the object. If you create an object that the user subsequently does not have permission to access--either because the default security or the explicitly-set permissions require a greater level of access--an exception will be thrown even if the object is successfully created.

Parameters:
classId - A String that represents the ID or the symbolic name of the class on the Content Services server.

props - A Properties collection containing the properties to assign to the created object. If this parameter is null or is an empty collection, the default is to assign properties based on the equivalent Content Services object.

acls - A Permissions collection that contains the access rights (permissions) to be assigned to the created object. Note that the permissions you set represent basic object permissions (that is, an object's Permissions property). If null, the created object inherits from the class's default instance permissions. Passing an empty collection throws an exception.

folder - A Folder object into which the created object will be filed. Cannot be null. Ignored when creating objects other than Document and CustomObject.

Returns:
A ContainableObject object, which you cast to the appropriate BaseObject object type (BaseObject.TYPE_DOCUMENT or BaseObject.TYPE_CUSTOMOBJECT).

getSecurityPolicies

public SecurityPolicies getSecurityPolicies()

Not Implemented in CS Java Connector v3.0.

Returns a collection of the SecurityPolicy objects persisted to this object store. To return a specific class of SecurityPolicy object, use the getSecurityPolicies(cd, includeSubclasses) form of this method.

Returns:
A collection of SecurityPolicy objects.


getSecurityPolicies

public SecurityPolicies getSecurityPolicies(ClassDescription cd,
                                            boolean includeSubclasses)

Not Implemented in CS Java Connector v3.0.

Returns a collection of the SecurityPolicy objects of the specified class, and optionally its subclasses, that are persisted to this object store. Specify the SecurityPolicy class in the cd parameter. To specify the SecurityPolicy base class, use the SECURITY_POLICY constant defined in the ClassDescription interface.

Parameters:
cd - A ClassDescription object that identifies the SecurityPolicy class.

includeSubclasses - Set to true to return subclasses of the class specified in the cd parameter; otherwise, set to false.

Returns:
A collection of SecurityPolicy objects of the specified class, and optionally its subclasses.


getSecurityPoliciesXML

public java.lang.String getSecurityPoliciesXML()

Not Implemented in CS Java Connector v3.0.

Returns a String in XML representing all of the security policies persisted to this object store. To return a specific class of SecurityPolicy object, use the getSecurityPoliciesXML(cd, includeSubclasses) form of this method.

Returns:
A String in XML representing the security policies persisted to this object store.

getSecurityPoliciesXML

public java.lang.String getSecurityPoliciesXML(ClassDescription cd,
                                               boolean includeSubclasses)

Not Implemented in CS Java Connector v3.0.

Returns a String in XML representing the security policies of the specified class, and optionally its subclasses, that are persisted to this object store. Specify the SecurityPolicy class in the cd parameter. To specify the SecurityPolicy base class, use the SECURITY_POLICY constant defined in the ClassDescription interface.

Parameters:
cd - A ClassDescription object that identifies the SecurityPolicy class.

includeSubclasses - Set to true to return subclasses of the class specified in the cd parameter; otherwise, set to false.

Returns:
A String containing an XML representation of the security policies of the specified class, and optionally its subclasses.

getStringLookupLists

public java.lang.String[][] getStringLookupLists(java.lang.String objId)

Not Implemented in CS Java Connector v3.0.

Returns a two-dimensional String array containing labels and corresponding IDs (GUIDs) retrieved from a string lookup operation.

The objId parameter specifies the Content Services StringLookup object against which this string lookup is to be performed. The StringLookup object contains a list of GUIDs (in the LookupIDList property) and corresponding human-readable labels (in the LookupList property) for the GUIDs. This method is useful for retrieving the labels assigned to versioning state IDs or to application-defined state IDs. Specify ObjectStore.VERSION_STATUS_LOOKUP to retrieve the strings that correspond to the four document versioning state GUIDs. Specify ObjectStore.APPLICATION_DEFINED_TEMPLATES to retrieve strings that correspond to a site's or application's local names for application-defined state IDs.

This method cannot be executed as part of a batch. If called within a batch (that is, between startBatch and executeBatch), the batch is suspended while this method executes, and is resumed immediately after this method completes.

Parameters:
objId - A String containing the GUID or path for the Content Services StringLookup object to be used for the string lookup.

Returns:
A two-dimensional String array containing the individual String values found. String[0] is the list of human-readable labels; String[1] is the list of GUIDs.

exportObjects

public java.lang.String exportObjects(java.lang.String exportFilter,
                                      int flags)

Not Implemented in CS Java Connector v3.0.

Not supported in this release.


importBaseObject

public BaseObject importBaseObject(int objType,
                                   java.lang.String importXML,
                                   int flags)

Not Implemented in CS Java Connector v3.0.

Not supported in this release.


importObjects

public java.lang.String importObjects(java.lang.String importXML,
                                      int flags)

Not Implemented in CS Java Connector v3.0.

Not supported in this release.


installFeatureAddOn

public java.lang.String installFeatureAddOn(FeatureAddOn addOnInst)

Not Implemented in CS Java Connector v3.0.

Installs a specified FeatureAddOn object. Returns a String containing an XML representation of the errors that may have occurred during the installation process.

Objects installed by this method take on default instance permissions, even when permissions are defined within the feature add-on's XML manifest.

Be aware of the following restrictions regarding an installed FeatureAddOn object:

Parameters:
addOnInst - A FeatureAddOn object to install.

Returns:
A String containing an XML representation of errors that occur during FeatureAddOn object installation.

installFeatureAddOn

public java.lang.String installFeatureAddOn(FeatureAddOn addOnInst,
                                            int flags)
Deprecated. Use installFeatureAddOn(FeatureAddOn addOnInst).

Not Implemented in CS Java Connector v3.0.


FileNet Content Services
Java Connector v3.0