|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
getObjectStore(String,Session)
on the ObjectFactory
interface.getObjectStores
on the EntireNetwork
interface. This returns an ObjectStores
collection object, from which you can return an ObjectStore
object from the collection.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.
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.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.ReadableMetadataObject |
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Field Detail |
public static final int SUPPORTS_COMPOUND_DOCUMENTS
public static final int SUPPORTS_PUBLISHING
public static final int itemDeleteAccessDefault
public static final java.lang.String idmAccessLevel
public static final java.lang.String idmAddedByUser
public static final java.lang.String idmDateAdded
public static final java.lang.String idmComment
public static final java.lang.String idmLibSoftwareVer
public static final java.lang.String idmLibDefAllowVariants
public static final java.lang.String idmLibDefOnlineLimit
public static final java.lang.String idmLibLoginLimit
public static final java.lang.String idmLibLoginCount
public static final java.lang.String idmLibUserCount
public static final java.lang.String idmLibBackupDevice
public static final java.lang.String idmLibBackupPath
public static final java.lang.String idmLibSerialNo
public static final java.lang.String idmLibNetworkLogin
public static final java.lang.String idmLibType
public static final java.lang.String idmLibLoginsEnabled
public static final java.lang.String idmLibPvInLimit
public static final java.lang.String idmLibSecureSearch
public static final java.lang.String idmLibSuspendedCount
public static final java.lang.String idmLibCsEnabled
public static final java.lang.String idmLibCsiDefault
public static final java.lang.String idmLibCsiLimit
public static final java.lang.String idmLibCsiPvInLimit
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:
public static final java.lang.String idmLibAdminUser
public static final java.lang.String idmLibAdminGroup
public static final java.lang.String idmLibGeneralGroup
public static final java.lang.String idmLibLanguage
public static final java.lang.String idmLibProduct
public static final java.lang.String idmLibSeqItemIds
public static final java.lang.String idmLibCsSearchThreshold
public static final java.lang.String idmLibReclaimAccess
public static final java.lang.String idmLibDocDelAccess
public static final java.lang.String idmLibAddItem
public static final java.lang.String STATE_CAN_ADD_ROOT_FOLDERS
public static final java.lang.String STATE_CAN_ADD_DOCUMENTS
Method Detail |
public Groups getGroups()
public java.lang.String getGroupsXML()
public Users getUsers()
public java.lang.String getUsersXML()
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |