|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ObjectStore
Represents a location in which folders, documents, and custom objects are stored, accessed, and managed on the Content Engine server.
An ObjectStore
object provides access to metadata and Content Engine objects,
such as class descriptions, property descriptions, security policies, and so on.
Using methods on this interface, you can retrieve this information, create and store new objects in the object
store, and retrieve its installed feature add-ons.
You can get a reference to an ObjectStore
object by iterating an ObjectStoreSet
collection.
You can get an instance of ObjectStore
by:
createInstance
, getInstance
, or fetchInstance
on the Factory.ObjectStore
class.
getObjectStore
on an instance of a RepositoryObject
subclass.Metadata
Auditable: false
Method Summary | |
---|---|
IdList |
determinePrerequisiteAddOnIds(Id addOnId)
Returns the AddOn IDs for which installation is required prior to the installation of the AddOn specified by addOnId . |
IndependentObject |
fetchAndLockObject(java.lang.String classIdent,
Id objectId,
long timeout,
java.lang.String lockOwner,
PropertyFilter filter)
Retrieves and locks the specified object from this ObjectStore object. |
IndependentObject |
fetchAndLockObject(java.lang.String classIdent,
java.lang.String objectIdent,
long timeout,
java.lang.String lockOwner,
PropertyFilter filter)
Retrieves and locks the object the specified object from this ObjectStore object. |
AddOnInstallationRecordList |
get_AddOnInstallationRecords()
Returns the value of the AddOnInstallationRecords property. |
AuditLevel |
get_AuditLevel()
Returns the value of the AuditLevel property. |
java.lang.String |
get_CBRLocale()
Returns the value of the CBRLocale property. |
ChoiceListSet |
get_ChoiceLists()
Returns the value of the ChoiceLists property. |
ClassDescriptionSet |
get_ClassDescriptions()
Returns the value of the ClassDescriptions property. |
ContentAccessRecordingLevel |
get_ContentAccessRecordingLevel()
Returns the value of the ContentAccessRecordingLevel property. |
java.lang.String |
get_DatabaseIndexStorageLocation()
Returns the value of the DatabaseIndexStorageLocation property. |
java.lang.String |
get_DatabaseLOBStorageLocation()
Returns the value of the DatabaseLOBStorageLocation property. |
java.lang.String |
get_DatabaseTableStorageLocation()
Returns the value of the DatabaseTableStorageLocation property. |
DatabaseType |
get_DatabaseType()
Returns the value of the DatabaseType property. |
java.lang.Integer |
get_DefaultQueryTimeLimit()
Returns the value of the DefaultQueryTimeLimit property. |
ReservationType |
get_DefaultReservationType()
Returns the value of the DefaultReservationType property. |
java.lang.String |
get_DescriptiveText()
Returns the value of the DescriptiveText property. |
DocumentClassificationActionSet |
get_DocumentClassificationActions()
Returns the value of the DocumentClassificationActions property. |
DocumentLifecycleActionSet |
get_DocumentLifecycleActions()
Returns the value of the DocumentLifecycleActions property. |
DocumentLifecyclePolicySet |
get_DocumentLifecyclePolicies()
Returns the value of the DocumentLifecyclePolicies property. |
Domain |
get_Domain()
Returns the value of the Domain property. |
EventActionSet |
get_EventActions()
Returns the value of the EventActions property. |
java.lang.Integer |
get_FolderCacheMaxAgeDelta()
Deprecated. As of release 4.0.1. |
java.lang.Integer |
get_FolderCacheMaxEntries()
Returns the value of the FolderCacheMaxEntries property. |
java.lang.Integer |
get_FolderCacheReapFrequency()
Deprecated. As of release 4.0.1. |
java.lang.Boolean |
get_ForceCaseInsensitiveSearch()
Returns the value of the ForceCaseInsensitiveSearch property. |
java.lang.Integer |
get_FullTextRowDefault()
Returns the value of the FullTextRowDefault property. |
java.lang.Integer |
get_FullTextRowMax()
Returns the value of the FullTextRowMax property. |
IndexAreaSet |
get_IndexAreas()
Returns the value of the IndexAreas property. |
java.lang.String |
get_JNDIDataSource()
Returns the value of the JNDIDataSource property. |
java.lang.String |
get_JNDIXADataSource()
Returns the value of the JNDIXADataSource property. |
java.lang.String |
get_LocaleName()
Returns the value of the LocaleName property. |
StringList |
get_LocaleNames()
Returns the value of the LocaleNames property. |
java.lang.Integer |
get_MaxQueryTimeLimit()
Returns the value of the MaxQueryTimeLimit property. |
java.lang.String |
get_Name()
Returns the value of the Name property. |
java.lang.Integer |
get_ObjectSecurityCacheEntryTTL()
Returns the value of the ObjectSecurityCacheEntryTTL property. |
java.lang.Integer |
get_ObjectSecurityCacheMaxEntries()
Returns the value of the ObjectSecurityCacheMaxEntries property. |
Id |
get_ObjectStoreId()
Returns the value of the ObjectStoreId property. |
AccessPermissionList |
get_Permissions()
Returns the value of the Permissions property. |
PropertyTemplateSet |
get_PropertyTemplates()
Returns the value of the PropertyTemplates property. |
ClassDefinitionSet |
get_RootClassDefinitions()
Returns the value of the RootClassDefinitions property. |
Folder |
get_RootFolder()
Returns the value of the RootFolder property. |
java.lang.Integer |
get_SecurityDescCacheMaxEntries()
Returns the value of the SecurityDescCacheMaxEntries property. |
SecurityPolicySet |
get_SecurityPolicies()
Returns the value of the SecurityPolicies property. |
StorageAreaSet |
get_StorageAreas()
Returns the value of the StorageAreas property. |
StoragePolicySet |
get_StoragePolicies()
Returns the value of the StoragePolicies property. |
SubscriptionSet |
get_Subscriptions()
Returns the value of the Subscriptions property. |
java.lang.String |
get_SymbolicName()
Returns the value of the SymbolicName property. |
TableDefinitionSet |
get_TableDefinitions()
Returns the value of the TableDefinitions property. |
FolderSet |
get_TopFolders()
Returns the value of the TopFolders property. |
WorkflowDefinitionSet |
get_WorkflowDefinitions()
Returns the value of the WorkflowDefinitions property. |
XMLPropertyMappingScriptSet |
get_XMLPropertyMappingScripts()
Returns the value of the XMLPropertyMappingScripts property. |
void |
installAddOn(AddOn addOn)
Installs an add-on, available on a domain, to the current object store. |
boolean |
isAddOnInstalled(Id addOnId)
Returns a boolean value indicating whether the AddOn identified by addId is installed (true) or not (false) in the ObjectStore. |
void |
set_AuditLevel(AuditLevel value)
Sets the value of the AuditLevel property. |
void |
set_CBRLocale(java.lang.String value)
Sets the value of the CBRLocale property. |
void |
set_ContentAccessRecordingLevel(ContentAccessRecordingLevel value)
Sets the value of the ContentAccessRecordingLevel property. |
void |
set_DatabaseIndexStorageLocation(java.lang.String value)
Sets the value of the DatabaseIndexStorageLocation property. |
void |
set_DatabaseLOBStorageLocation(java.lang.String value)
Sets the value of the DatabaseLOBStorageLocation property. |
void |
set_DatabaseTableStorageLocation(java.lang.String value)
Sets the value of the DatabaseTableStorageLocation property. |
void |
set_DefaultQueryTimeLimit(java.lang.Integer value)
Sets the value of the DefaultQueryTimeLimit property. |
void |
set_DefaultReservationType(ReservationType value)
Sets the value of the DefaultReservationType property. |
void |
set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. |
void |
set_FolderCacheMaxAgeDelta(java.lang.Integer value)
Deprecated. As of release 4.0.1. |
void |
set_FolderCacheMaxEntries(java.lang.Integer value)
Sets the value of the FolderCacheMaxEntries property. |
void |
set_FolderCacheReapFrequency(java.lang.Integer value)
Deprecated. As of release 4.0.1. |
void |
set_ForceCaseInsensitiveSearch(java.lang.Boolean value)
Sets the value of the ForceCaseInsensitiveSearch property. |
void |
set_FullTextRowDefault(java.lang.Integer value)
Sets the value of the FullTextRowDefault property. |
void |
set_FullTextRowMax(java.lang.Integer value)
Sets the value of the FullTextRowMax property. |
void |
set_JNDIDataSource(java.lang.String value)
Sets the value of the JNDIDataSource property. |
void |
set_JNDIXADataSource(java.lang.String value)
Sets the value of the JNDIXADataSource property. |
void |
set_MaxQueryTimeLimit(java.lang.Integer value)
Sets the value of the MaxQueryTimeLimit property. |
void |
set_ObjectSecurityCacheEntryTTL(java.lang.Integer value)
Sets the value of the ObjectSecurityCacheEntryTTL property. |
void |
set_ObjectSecurityCacheMaxEntries(java.lang.Integer value)
Sets the value of the ObjectSecurityCacheMaxEntries property. |
void |
set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. |
void |
set_SecurityDescCacheMaxEntries(java.lang.Integer value)
Sets the value of the SecurityDescCacheMaxEntries property. |
void |
set_SymbolicName(java.lang.String value)
Sets the value of the SymbolicName property. |
Methods inherited from interface com.filenet.api.core.InstantiatingScope |
---|
createObject, createObject, fetchObject, fetchObject, getObject, getObject |
Methods inherited from interface com.filenet.api.replication.Repository |
---|
get_Creator, get_DateCreated, get_DateLastModified, get_DisplayName, get_Id, get_LastModifier, get_Site, set_Creator, set_DateCreated, set_DisplayName, set_Site |
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject |
---|
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber |
Methods inherited from interface com.filenet.api.core.IndependentObject |
---|
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
Method Detail |
---|
java.lang.String get_DescriptiveText()
void set_DescriptiveText(java.lang.String value)
java.lang.String get_LocaleName()
StringList get_LocaleNames()
Id get_ObjectStoreId()
FolderSet get_TopFolders()
java.lang.String get_Name()
AccessPermissionList get_Permissions()
void set_Permissions(AccessPermissionList value)
ClassDefinitionSet get_RootClassDefinitions()
PropertyTemplateSet get_PropertyTemplates()
ChoiceListSet get_ChoiceLists()
StoragePolicySet get_StoragePolicies()
java.lang.String get_JNDIDataSource()
void set_JNDIDataSource(java.lang.String value)
java.lang.String get_JNDIXADataSource()
void set_JNDIXADataSource(java.lang.String value)
DatabaseType get_DatabaseType()
java.lang.Integer get_DefaultQueryTimeLimit()
void set_DefaultQueryTimeLimit(java.lang.Integer value)
java.lang.Integer get_MaxQueryTimeLimit()
void set_MaxQueryTimeLimit(java.lang.Integer value)
Folder get_RootFolder()
EventActionSet get_EventActions()
SubscriptionSet get_Subscriptions()
DocumentLifecyclePolicySet get_DocumentLifecyclePolicies()
DocumentLifecycleActionSet get_DocumentLifecycleActions()
DocumentClassificationActionSet get_DocumentClassificationActions()
XMLPropertyMappingScriptSet get_XMLPropertyMappingScripts()
WorkflowDefinitionSet get_WorkflowDefinitions()
TableDefinitionSet get_TableDefinitions()
SecurityPolicySet get_SecurityPolicies()
java.lang.String get_SymbolicName()
void set_SymbolicName(java.lang.String value)
ReservationType get_DefaultReservationType()
void set_DefaultReservationType(ReservationType value)
ContentAccessRecordingLevel get_ContentAccessRecordingLevel()
void set_ContentAccessRecordingLevel(ContentAccessRecordingLevel value)
AuditLevel get_AuditLevel()
void set_AuditLevel(AuditLevel value)
java.lang.Boolean get_ForceCaseInsensitiveSearch()
void set_ForceCaseInsensitiveSearch(java.lang.Boolean value)
StorageAreaSet get_StorageAreas()
Domain get_Domain()
IndexAreaSet get_IndexAreas()
java.lang.Integer get_FullTextRowMax()
void set_FullTextRowMax(java.lang.Integer value)
java.lang.Integer get_FullTextRowDefault()
void set_FullTextRowDefault(java.lang.Integer value)
java.lang.String get_CBRLocale()
void set_CBRLocale(java.lang.String value)
AddOnInstallationRecordList get_AddOnInstallationRecords()
java.lang.Integer get_SecurityDescCacheMaxEntries()
void set_SecurityDescCacheMaxEntries(java.lang.Integer value)
java.lang.Integer get_ObjectSecurityCacheMaxEntries()
void set_ObjectSecurityCacheMaxEntries(java.lang.Integer value)
java.lang.Integer get_ObjectSecurityCacheEntryTTL()
void set_ObjectSecurityCacheEntryTTL(java.lang.Integer value)
java.lang.Integer get_FolderCacheMaxEntries()
void set_FolderCacheMaxEntries(java.lang.Integer value)
java.lang.Integer get_FolderCacheReapFrequency()
void set_FolderCacheReapFrequency(java.lang.Integer value)
java.lang.Integer get_FolderCacheMaxAgeDelta()
void set_FolderCacheMaxAgeDelta(java.lang.Integer value)
java.lang.String get_DatabaseIndexStorageLocation()
void set_DatabaseIndexStorageLocation(java.lang.String value)
java.lang.String get_DatabaseTableStorageLocation()
void set_DatabaseTableStorageLocation(java.lang.String value)
java.lang.String get_DatabaseLOBStorageLocation()
void set_DatabaseLOBStorageLocation(java.lang.String value)
void installAddOn(AddOn addOn)
This method results in one of the following outcomes:
AddOnInstallationRecord
object is created.
addOn
- An AddOn
object that specifies the add-on to install.IndependentObject fetchAndLockObject(java.lang.String classIdent, java.lang.String objectIdent, long timeout, java.lang.String lockOwner, PropertyFilter filter)
ObjectStore
object.
The object can be specified as a string containing a GUID, a symbolic name, or a path.
Use parameters on this method to specify the owner of the lock and the lock timeout value.
This method always makes a round-trip to the server.
You can optionally include a filter to control which properties to return with the object.
If you pass in null
for the filter
parameter, this method returns
values for all non-object properties and returns placeholders for all object-valued properties.
For more information, see the description of the filter
parameter.
classIdent
- The class of the object to be retrieved and locked. This value
may be specified as an ID (GUID) or a symbolic name.objectIdent
- The ID of the object to retrieve. This value
may be specified as an ID (a string containing a GUID), a path, or a symbolic name.timeout
- An integer that represents the number of seconds after which the lock will
expire. The range of values is 0 to 2147483647 (Integer.MAX_VALUE
) seconds.lockOwner
- A String
representing the user name to be assigned as the
owner of the lock on this object. Defaults to the short principal name of the requesting
user. The value is strictly advisory and is not validated against user or group names.
known to the Content Engine. The value can be used by applications such as WebDAV to
identify the user who has locked the object.filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null
, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED
or
PropertyState.REFERENCE
); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.
IndependentObject fetchAndLockObject(java.lang.String classIdent, Id objectId, long timeout, java.lang.String lockOwner, PropertyFilter filter)
ObjectStore
object.
Use parameters on this method to specify the owner of the lock and the lock timeout value.
This method always makes a round-trip to the server.
You can optionally include a filter to control which properties to return with the
object. If you pass in null
for the filter
parameter, this
method returns values for all non-object properties and returns placeholders for all
object-valued properties. For more information, see the description of the
filter
parameter.
classIdent
- The class of the object to be retrieved and locked. This value
may be specified as an ID (GUID) or a symbolic name.objectId
- The ID (GUID) of the object to retrieve.timeout
- An integer that represents the number of seconds after which the lock will expire.
The range of values is 0 to 2147483647 (Integer.MAX_VALUE
) seconds.lockOwner
- A String
representing the user name to be assigned as
the owner of the lock on this object. Defaults to the short principal name of the
requesting user. The value is strictly advisory and is not validated against user
or group names known to the Content Engine. The value can be used by applications
such as WebDAV to identify the user who has locked the object.filter
- A PropertyFilter
object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null
, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED
or
PropertyState.REFERENCE
); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.
ClassDescriptionSet get_ClassDescriptions()
boolean isAddOnInstalled(Id addOnId)
addOnId
- indentifying Addon to check per previously stated semantics.
IdList determinePrerequisiteAddOnIds(Id addOnId)
addOnId
. If the AddOn specified by desiredAddOnId
has been superseded,
the results are based on the superseding AddOn prerequisites.
addOnId
- The ID of the AddOn to be installed. Example: SystemAddOnId.PUBLISHING
addOnId
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |