FileNet Content Services
Java Connector v3.0

com.filenet.Panagon
Interface ObjectStore

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

public interface ObjectStore
extends PanagonObject, ObjectStore

An ObjectStore object represents a location (an object store) in which objects are stored on the Content Services server. Within a given Content Services object store, an ObjectStore object provides access to document, class description, and property description collections, and to individual objects that support the GettableObject interface.

You cannot create an object store via the CS Java Connector. You can get a reference to an existing ObjectStore object in one of the following ways:

Note that until a function is performed on the returned ObjectStore object that causes a roundtrip to the Content Services server, the object is not validated and is simply an object with the name of an object store.

This interface defines the fields for the object store properties. You can retrieve a Properties collection using the getProperties() method, which is defined in the ReadableMetadataObject superinterface.

Also defined are methods for retrieving PropertyDescription objects, allowing you to access the metadata for one or more specified properties.

To determine an object store's support for a particular capability, call the supports method. This method returns true if the object store supports the capability and false if it doesn't.

See Also:
CS Java Connector Developer's Guide

Field Summary
static java.lang.String idmAccessLevel
          Contains the current user's access to the ObjectStore object.
static java.lang.String idmAddedByUser
          Contains the name of the user who added the object to the object store.
static java.lang.String idmComment
          Contains a comment about the object store.
static java.lang.String idmDateAdded
          Contains the date and time the object store was installed.
static java.lang.String idmLibAccessDomain
          Contains a group-domain value indicating the group affiliation(s) to apply when determining which search results to return during the user's search.
static java.lang.String idmLibAddItem
          Internally used property
static java.lang.String idmLibAdminGroup
          The name given to the administrative group, with the default value being "Administrators".
static java.lang.String idmLibAdminUser
          The name given to the initial administrator in the particular object store, with the default value being Admin.
static java.lang.String idmLibBackupDevice
          Internally used property
static java.lang.String idmLibBackupPath
          Internally used property
static java.lang.String idmLibCsEnabled
          Indicates whether content searches are allowed.
static java.lang.String idmLibCsiDefault
          Contains the value that will be entered for the idmDocCsiDefault property in a new Document object when added by the user during this session.
static java.lang.String idmLibCsiLimit
          Indicates a default value for the idmDocCsiLimit document property object.
static java.lang.String idmLibCsiPvInLimit
          Indicates whether versions marked as permanently indexed are to be included in the indexed version limit for a document.
static java.lang.String idmLibCsSearchThreshold
          Determines whether to do a content search or property search first, when both types of criteria are specified for a search.
static java.lang.String idmLibDefAllowVariants
          Indicates whether secondary version lines are allowed for items in this system (Yes/No).
static java.lang.String idmLibDefOnlineLimit
          Provides an initial value for the idmDocOnlineLimit document property when a document is added to the object store.
static java.lang.String idmLibDocDelAccess
          For Content Services 5.x and later, indicates the minimum level of access rights needed to delete a document (defaults to Admin).
static java.lang.String idmLibGeneralGroup
          The name given to the universal group, with the default value being "General Users".
static java.lang.String idmLibLanguage
          Contains the language with which the user opened the session.
static java.lang.String idmLibLoginCount
          Contains the current number of active sessions.
static java.lang.String idmLibLoginLimit
          Contains the maximum number of active sessions permitted for the object store.
static java.lang.String idmLibLoginsEnabled
          Indicates whether users whose default group is not set to Administrators can open sessions.
static java.lang.String idmLibNetworkLogin
          Internally used property
static java.lang.String idmLibProduct
          Contains the name to be used for your DS product.
static java.lang.String idmLibPvInLimit
          Indicates whether versions marked as Permanent are to be included in the online limit for a protected item.
static java.lang.String idmLibReclaimAccess
          Indicates the minimum level of access rights needed to reclaim a document (defaults to Owner).
static java.lang.String idmLibSecureSearch
          Indicates whether the user who opened this session must have at least Viewer access rights to a document to have that document included in the results of one of his or her searches.
static java.lang.String idmLibSeqItemIds
          Specifies whether to use sequential item IDs rather than DS Julian date IDs for all items added.
static java.lang.String idmLibSerialNo
          Contains the serial number of the license for the object store.
static java.lang.String idmLibSoftwareVer
          Contains the software version of the product being used.
static java.lang.String idmLibSuspendedCount
          Contains the current number of sessions that are suspended.
static java.lang.String idmLibType
          Internally used property
static java.lang.String idmLibUserCount
          Contains the total number of users who have been added to the object store.
static int itemDeleteAccessDefault
          Internally used property
static java.lang.String STATE_CAN_ADD_DOCUMENTS
          Returns True if the user has sufficient access to add documents to the object store.
static java.lang.String STATE_CAN_ADD_ROOT_FOLDERS
          Returns True if the user has sufficient access to add root level folders to the object store.
static int SUPPORTS_COMPOUND_DOCUMENTS
          Returns True if the object store supports compound documents.
static int SUPPORTS_PUBLISHING
          Returns True if the object store supports publishing.
 
Fields inherited from interface com.filenet.Panagon.PanagonObject
idmId, idmName
 
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
 
Fields inherited from interface com.filenet.wcm.api.ObjectStore
APPLICATION_DEFINED_TEMPLATES, SUPPORTS_ACL_MODIFICATIONS, SUPPORTS_ANNOTATIONS, SUPPORTS_CONTENT_SEARCH, SUPPORTS_CUSTOM_OBJECT, SUPPORTS_DOC_DELETE, SUPPORTS_DOC_PAGES, SUPPORTS_DOC_VERSIONS, SUPPORTS_QUEUES, SUPPORTS_REMOTE_PRINT, SUPPORTS_STORED_SEARCH, VERSION_STATUS_LOOKUP
 
Method Summary
 Groups getGroups()
          Returns a collection of Group objects.
 java.lang.String getGroupsXML()
          Returns an XML representation of the groups in this Object Store.
 Users getUsers()
          Returns a collection of User objects.
 java.lang.String getUsersXML()
          Returns an XML representation of the users in this Object Store.
 
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.ObjectStore
createAndFileObject, createObject, exportObjects, getCheckoutList, getCheckoutList, getCheckoutListXML, getChoiceLists, getChoiceListsXML, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptionsXML, getClassDescriptionsXML, getClassDescriptionsXML, getClassDescriptionsXML, getClassifierMimeTypes, getEventActions, getEventActions, getObject, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptionsXML, getPropertyDescriptionsXML, getPropertyDescriptionsXML, getPropertyDescriptionsXML, getPublishRequests, getPublishRequests, getRootFolder, getSecurityPolicies, getSecurityPolicies, getSecurityPoliciesXML, getSecurityPoliciesXML, getStoredSearches, getStoredSearchesXML, getStringLookupLists, getStyleTemplates, getTopFoldersXML, getWorkflowDefinitions, getWorkflowDefinitions, importBaseObject, importObjects, installFeatureAddOn, installFeatureAddOn, supports
 
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_COMPOUND_DOCUMENTS

public static final int SUPPORTS_COMPOUND_DOCUMENTS
Returns True if the object store supports compound documents.

See Also:
Constant Field Values

SUPPORTS_PUBLISHING

public static final int SUPPORTS_PUBLISHING
Returns True if the object store supports publishing.

See Also:
Constant Field Values

itemDeleteAccessDefault

public static final int itemDeleteAccessDefault
Internally used property

See Also:
Constant Field Values

idmAccessLevel

public static final java.lang.String idmAccessLevel
Contains the current user's access to the ObjectStore object. See the Permission interface for a list of idmAccessLevel values.

See Also:
Constant Field Values

idmAddedByUser

public static final java.lang.String idmAddedByUser
Contains the name of the user who added the object to the object store. Read Only.

See Also:
Constant Field Values

idmDateAdded

public static final java.lang.String idmDateAdded
Contains the date and time the object store was installed. Read Only.

See Also:
Constant Field Values

idmComment

public static final java.lang.String idmComment
Contains a comment about the object store.

See Also:
Constant Field Values

idmLibSoftwareVer

public static final java.lang.String idmLibSoftwareVer
Contains the software version of the product being used.

See Also:
Constant Field Values

idmLibDefAllowVariants

public static final java.lang.String idmLibDefAllowVariants
Indicates whether secondary version lines are allowed for items in this system (Yes/No). Read Only.

See Also:
Constant Field Values

idmLibDefOnlineLimit

public static final java.lang.String idmLibDefOnlineLimit
Provides an initial value for the idmDocOnlineLimit document property when a document is added to the object store. (idmDocOnlineLimit establishes the maximum number of versions of the item that can be stored online before automatic archiving begins moving the oldest version offline. Read Only.

See Also:
Constant Field Values

idmLibLoginLimit

public static final java.lang.String idmLibLoginLimit
Contains the maximum number of active sessions permitted for the object store. Read Only.

See Also:
Constant Field Values

idmLibLoginCount

public static final java.lang.String idmLibLoginCount
Contains the current number of active sessions. Read Only.

See Also:
Constant Field Values

idmLibUserCount

public static final java.lang.String idmLibUserCount
Contains the total number of users who have been added to the object store. Read Only.

See Also:
Constant Field Values

idmLibBackupDevice

public static final java.lang.String idmLibBackupDevice
Internally used property

See Also:
Constant Field Values

idmLibBackupPath

public static final java.lang.String idmLibBackupPath
Internally used property

See Also:
Constant Field Values

idmLibSerialNo

public static final java.lang.String idmLibSerialNo
Contains the serial number of the license for the object store. Read Only.

See Also:
Constant Field Values

idmLibNetworkLogin

public static final java.lang.String idmLibNetworkLogin
Internally used property

See Also:
Constant Field Values

idmLibType

public static final java.lang.String idmLibType
Internally used property

See Also:
Constant Field Values

idmLibLoginsEnabled

public static final java.lang.String idmLibLoginsEnabled
Indicates whether users whose default group is not set to Administrators can open sessions. This value is automatically set to No any time the DS Property Manager is restored.(Yes/No).

See Also:
Constant Field Values

idmLibPvInLimit

public static final java.lang.String idmLibPvInLimit
Indicates whether versions marked as Permanent are to be included in the online limit for a protected item. (Yes/No).

See Also:
Constant Field Values

idmLibSecureSearch

public static final java.lang.String idmLibSecureSearch
Indicates whether the user who opened this session must have at least Viewer access rights to a document to have that document included in the results of one of his or her searches. (Yes/No). Read Only.

See Also:
Constant Field Values

idmLibSuspendedCount

public static final java.lang.String idmLibSuspendedCount
Contains the current number of sessions that are suspended. Read Only.

See Also:
Constant Field Values

idmLibCsEnabled

public static final java.lang.String idmLibCsEnabled
Indicates whether content searches are allowed. (Yes/No). Read Only.

See Also:
Constant Field Values

idmLibCsiDefault

public static final java.lang.String idmLibCsiDefault
Contains the value that will be entered for the idmDocCsiDefault property in a new Document object when added by the user during this session. The object store derives this value by using the first value it finds in a sequential check of the 'Default Index Versions?' properties in the User object, the User’s active Group object, and/or the System object. Read Only.

See Also:
Constant Field Values

idmLibCsiLimit

public static final java.lang.String idmLibCsiLimit
Indicates a default value for the idmDocCsiLimit document property object. This value is set to 1 by default when the object store is installed.

See Also:
Constant Field Values

idmLibCsiPvInLimit

public static final java.lang.String idmLibCsiPvInLimit
Indicates whether versions marked as permanently indexed are to be included in the indexed version limit for a document. (Yes/No).

See Also:
Constant Field Values

idmLibAccessDomain

public static final java.lang.String idmLibAccessDomain

Contains a group-domain value indicating the group affiliation(s) to apply when determining which search results to return during the user's search. Possible values are:


idmLibAdminUser

public static final java.lang.String idmLibAdminUser
The name given to the initial administrator in the particular object store, with the default value being Admin. This user is added automatically by the installation program. Read Only.

See Also:
Constant Field Values

idmLibAdminGroup

public static final java.lang.String idmLibAdminGroup
The name given to the administrative group, with the default value being "Administrators". Read Only.

See Also:
Constant Field Values

idmLibGeneralGroup

public static final java.lang.String idmLibGeneralGroup
The name given to the universal group, with the default value being "General Users". Read Only.

See Also:
Constant Field Values

idmLibLanguage

public static final java.lang.String idmLibLanguage
Contains the language with which the user opened the session. Read Only.

See Also:
Constant Field Values

idmLibProduct

public static final java.lang.String idmLibProduct
Contains the name to be used for your DS product. Read Only.

See Also:
Constant Field Values

idmLibSeqItemIds

public static final java.lang.String idmLibSeqItemIds
Specifies whether to use sequential item IDs rather than DS Julian date IDs for all items added. Julian date IDs apply only to the first 9999 items added in a day; thereafter sequential item IDs are applied. In the year 2000, sequential item IDs will be applied regardless of this property setting, due to possible ID numbering conflicts. See the Content Services documentation for further details. (Yes/No) Default is Yes.

See Also:
Constant Field Values

idmLibCsSearchThreshold

public static final java.lang.String idmLibCsSearchThreshold
Determines whether to do a content search or property search first, when both types of criteria are specified for a search. This threshold indicates that if the number of content search hits returned by a search is greater than (>) the threshold value, the property-based search criteria is used first. If this value is less than or equal to (<=) the number of content search hits, the content search-based criteria is used first. Read Only.

See Also:
Constant Field Values

idmLibReclaimAccess

public static final java.lang.String idmLibReclaimAccess
Indicates the minimum level of access rights needed to reclaim a document (defaults to Owner). The value of this property is supplied to the SPI_SES_RECLAIM_ACCESS property of the DS Session object. The Session object instance for a particular user applies this property value when the session opens. Any changes to this property do not take effect until the next session is opened. (Admin, Owner, Author, Viewer, None).

See Also:
Constant Field Values

idmLibDocDelAccess

public static final java.lang.String idmLibDocDelAccess
For Content Services 5.x and later, indicates the minimum level of access rights needed to delete a document (defaults to Admin). The only other acceptable value is Owner. The Session object instance for a particular user applies this property value when the session opens. Any changes to this property do not go into effect until the next session is opened. (Admin/Owner).

See Also:
Constant Field Values

idmLibAddItem

public static final java.lang.String idmLibAddItem
Internally used property

See Also:
Constant Field Values

STATE_CAN_ADD_ROOT_FOLDERS

public static final java.lang.String STATE_CAN_ADD_ROOT_FOLDERS
Returns True if the user has sufficient access to add root level folders to the object store.

See Also:
Constant Field Values

STATE_CAN_ADD_DOCUMENTS

public static final java.lang.String STATE_CAN_ADD_DOCUMENTS
Returns True if the user has sufficient access to add documents to the object store.

See Also:
Constant Field Values
Method Detail

getGroups

public Groups getGroups()
Returns a collection of Group objects. Each element of the returned collection represents a group defined on the Content Services server by the system administrator.

Returns:
A Group collection.

getGroupsXML

public java.lang.String getGroupsXML()
Returns an XML representation of the groups in this Object Store.

Returns:
An XML String.

getUsers

public Users getUsers()
Returns a collection of User objects. Each element of the returned collection represents a user defined on the Content Services server by the system administrator.

Returns:
A Groups collection.

getUsersXML

public java.lang.String getUsersXML()
Returns an XML representation of the users in this Object Store.

Returns:
An XML String.

FileNet Content Services
Java Connector v3.0