com.filenet.api.core
Interface ObjectStore

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, InstantiatingScope, Repository, Scope, java.io.Serializable

public interface ObjectStore
extends InstantiatingScope, Repository

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:

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain or ObjectStore
SuperclassName: Repository


Method Summary
 IdList determinePrerequisiteAddOnIds(Id addOnId)
          Returns the feature addon IDs for which installation is required prior to the installation of the feature 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 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 feature addon identified by addOnId is installed (true) or not (false) in the object store.
 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

get_DescriptiveText

java.lang.String get_DescriptiveText()
Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.


set_DescriptiveText

void set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.


get_LocaleName

java.lang.String get_LocaleName()
Returns the value of the LocaleName property. For more information, see LocaleName Property.


get_LocaleNames

StringList get_LocaleNames()
Returns the value of the LocaleNames property. For more information, see LocaleNames Property.


get_ObjectStoreId

Id get_ObjectStoreId()
Returns the value of the ObjectStoreId property. For more information, see ObjectStoreId Property.


get_TopFolders

FolderSet get_TopFolders()
Returns the value of the TopFolders property. For more information, see TopFolders Property.


get_Name

java.lang.String get_Name()
Returns the value of the Name property. For more information, see Name Property.


get_Permissions

AccessPermissionList get_Permissions()
Returns the value of the Permissions property. For more information, see Permissions Property.


set_Permissions

void set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. For more information, see Permissions Property.


get_RootClassDefinitions

ClassDefinitionSet get_RootClassDefinitions()
Returns the value of the RootClassDefinitions property. For more information, see RootClassDefinitions Property.


get_PropertyTemplates

PropertyTemplateSet get_PropertyTemplates()
Returns the value of the PropertyTemplates property. For more information, see PropertyTemplates Property.


get_ChoiceLists

ChoiceListSet get_ChoiceLists()
Returns the value of the ChoiceLists property. For more information, see ChoiceLists Property.


get_StoragePolicies

StoragePolicySet get_StoragePolicies()
Returns the value of the StoragePolicies property. For more information, see StoragePolicies Property.


get_JNDIDataSource

java.lang.String get_JNDIDataSource()
Returns the value of the JNDIDataSource property. For more information, see JNDIDataSource Property.


set_JNDIDataSource

void set_JNDIDataSource(java.lang.String value)
Sets the value of the JNDIDataSource property. For more information, see JNDIDataSource Property.


get_JNDIXADataSource

java.lang.String get_JNDIXADataSource()
Returns the value of the JNDIXADataSource property. For more information, see JNDIXADataSource Property.


set_JNDIXADataSource

void set_JNDIXADataSource(java.lang.String value)
Sets the value of the JNDIXADataSource property. For more information, see JNDIXADataSource Property.


get_DatabaseType

DatabaseType get_DatabaseType()
Returns the value of the DatabaseType property. For more information, see DatabaseType Property.


get_DefaultQueryTimeLimit

java.lang.Integer get_DefaultQueryTimeLimit()
Returns the value of the DefaultQueryTimeLimit property. For more information, see DefaultQueryTimeLimit Property.


set_DefaultQueryTimeLimit

void set_DefaultQueryTimeLimit(java.lang.Integer value)
Sets the value of the DefaultQueryTimeLimit property. For more information, see DefaultQueryTimeLimit Property.


get_MaxQueryTimeLimit

java.lang.Integer get_MaxQueryTimeLimit()
Returns the value of the MaxQueryTimeLimit property. For more information, see MaxQueryTimeLimit Property.


set_MaxQueryTimeLimit

void set_MaxQueryTimeLimit(java.lang.Integer value)
Sets the value of the MaxQueryTimeLimit property. For more information, see MaxQueryTimeLimit Property.


get_RootFolder

Folder get_RootFolder()
Returns the value of the RootFolder property. For more information, see RootFolder Property.


get_EventActions

EventActionSet get_EventActions()
Returns the value of the EventActions property. For more information, see EventActions Property.


get_Subscriptions

SubscriptionSet get_Subscriptions()
Returns the value of the Subscriptions property. For more information, see Subscriptions Property.


get_DocumentLifecyclePolicies

DocumentLifecyclePolicySet get_DocumentLifecyclePolicies()
Returns the value of the DocumentLifecyclePolicies property. For more information, see DocumentLifecyclePolicies Property.


get_DocumentLifecycleActions

DocumentLifecycleActionSet get_DocumentLifecycleActions()
Returns the value of the DocumentLifecycleActions property. For more information, see DocumentLifecycleActions Property.


get_DocumentClassificationActions

DocumentClassificationActionSet get_DocumentClassificationActions()
Returns the value of the DocumentClassificationActions property. For more information, see DocumentClassificationActions Property.


get_XMLPropertyMappingScripts

XMLPropertyMappingScriptSet get_XMLPropertyMappingScripts()
Returns the value of the XMLPropertyMappingScripts property. For more information, see XMLPropertyMappingScripts Property.


get_WorkflowDefinitions

WorkflowDefinitionSet get_WorkflowDefinitions()
Returns the value of the WorkflowDefinitions property. For more information, see WorkflowDefinitions Property.


get_TableDefinitions

TableDefinitionSet get_TableDefinitions()
Returns the value of the TableDefinitions property. For more information, see TableDefinitions Property.


get_SecurityPolicies

SecurityPolicySet get_SecurityPolicies()
Returns the value of the SecurityPolicies property. For more information, see SecurityPolicies Property.


get_SymbolicName

java.lang.String get_SymbolicName()
Returns the value of the SymbolicName property. For more information, see SymbolicName Property.


set_SymbolicName

void set_SymbolicName(java.lang.String value)
Sets the value of the SymbolicName property. For more information, see SymbolicName Property.


get_DefaultReservationType

ReservationType get_DefaultReservationType()
Returns the value of the DefaultReservationType property. For more information, see DefaultReservationType Property.


set_DefaultReservationType

void set_DefaultReservationType(ReservationType value)
Sets the value of the DefaultReservationType property. For more information, see DefaultReservationType Property.


get_ContentAccessRecordingLevel

ContentAccessRecordingLevel get_ContentAccessRecordingLevel()
Returns the value of the ContentAccessRecordingLevel property. For more information, see ContentAccessRecordingLevel Property.


set_ContentAccessRecordingLevel

void set_ContentAccessRecordingLevel(ContentAccessRecordingLevel value)
Sets the value of the ContentAccessRecordingLevel property. For more information, see ContentAccessRecordingLevel Property.


get_AuditLevel

AuditLevel get_AuditLevel()
Returns the value of the AuditLevel property. For more information, see AuditLevel Property.


set_AuditLevel

void set_AuditLevel(AuditLevel value)
Sets the value of the AuditLevel property. For more information, see AuditLevel Property.


get_ForceCaseInsensitiveSearch

java.lang.Boolean get_ForceCaseInsensitiveSearch()
Returns the value of the ForceCaseInsensitiveSearch property. For more information, see ForceCaseInsensitiveSearch Property.


set_ForceCaseInsensitiveSearch

void set_ForceCaseInsensitiveSearch(java.lang.Boolean value)
Sets the value of the ForceCaseInsensitiveSearch property. For more information, see ForceCaseInsensitiveSearch Property.


get_StorageAreas

StorageAreaSet get_StorageAreas()
Returns the value of the StorageAreas property. For more information, see StorageAreas Property.


get_Domain

Domain get_Domain()
Returns the value of the Domain property. For more information, see Domain Property.


get_IndexAreas

IndexAreaSet get_IndexAreas()
Returns the value of the IndexAreas property. For more information, see IndexAreas Property.


get_FullTextRowMax

java.lang.Integer get_FullTextRowMax()
Returns the value of the FullTextRowMax property. For more information, see FullTextRowMax Property.


set_FullTextRowMax

void set_FullTextRowMax(java.lang.Integer value)
Sets the value of the FullTextRowMax property. For more information, see FullTextRowMax Property.


get_FullTextRowDefault

java.lang.Integer get_FullTextRowDefault()
Returns the value of the FullTextRowDefault property. For more information, see FullTextRowDefault Property.


set_FullTextRowDefault

void set_FullTextRowDefault(java.lang.Integer value)
Sets the value of the FullTextRowDefault property. For more information, see FullTextRowDefault Property.


get_CBRLocale

java.lang.String get_CBRLocale()
Returns the value of the CBRLocale property. For more information, see CBRLocale Property.


set_CBRLocale

void set_CBRLocale(java.lang.String value)
Sets the value of the CBRLocale property. For more information, see CBRLocale Property.


get_AddOnInstallationRecords

AddOnInstallationRecordList get_AddOnInstallationRecords()
Returns the value of the AddOnInstallationRecords property. For more information, see AddOnInstallationRecords Property.


get_SecurityDescCacheMaxEntries

java.lang.Integer get_SecurityDescCacheMaxEntries()
Returns the value of the SecurityDescCacheMaxEntries property. For more information, see SecurityDescCacheMaxEntries Property.


set_SecurityDescCacheMaxEntries

void set_SecurityDescCacheMaxEntries(java.lang.Integer value)
Sets the value of the SecurityDescCacheMaxEntries property. For more information, see SecurityDescCacheMaxEntries Property.


get_ObjectSecurityCacheMaxEntries

java.lang.Integer get_ObjectSecurityCacheMaxEntries()
Returns the value of the ObjectSecurityCacheMaxEntries property. For more information, see ObjectSecurityCacheMaxEntries Property.


set_ObjectSecurityCacheMaxEntries

void set_ObjectSecurityCacheMaxEntries(java.lang.Integer value)
Sets the value of the ObjectSecurityCacheMaxEntries property. For more information, see ObjectSecurityCacheMaxEntries Property.


get_ObjectSecurityCacheEntryTTL

java.lang.Integer get_ObjectSecurityCacheEntryTTL()
Returns the value of the ObjectSecurityCacheEntryTTL property. For more information, see ObjectSecurityCacheEntryTTL Property.


set_ObjectSecurityCacheEntryTTL

void set_ObjectSecurityCacheEntryTTL(java.lang.Integer value)
Sets the value of the ObjectSecurityCacheEntryTTL property. For more information, see ObjectSecurityCacheEntryTTL Property.


get_FolderCacheMaxEntries

java.lang.Integer get_FolderCacheMaxEntries()
Returns the value of the FolderCacheMaxEntries property. For more information, see FolderCacheMaxEntries Property.


set_FolderCacheMaxEntries

void set_FolderCacheMaxEntries(java.lang.Integer value)
Sets the value of the FolderCacheMaxEntries property. For more information, see FolderCacheMaxEntries Property.


get_FolderCacheReapFrequency

java.lang.Integer get_FolderCacheReapFrequency()
Deprecated. As of release 4.0.1.

Returns the value of the FolderCacheReapFrequency property. For more information, see FolderCacheReapFrequency Property.


set_FolderCacheReapFrequency

void set_FolderCacheReapFrequency(java.lang.Integer value)
Deprecated. As of release 4.0.1.

Sets the value of the FolderCacheReapFrequency property. For more information, see FolderCacheReapFrequency Property.


get_FolderCacheMaxAgeDelta

java.lang.Integer get_FolderCacheMaxAgeDelta()
Deprecated. As of release 4.0.1.

Returns the value of the FolderCacheMaxAgeDelta property. For more information, see FolderCacheMaxAgeDelta Property.


set_FolderCacheMaxAgeDelta

void set_FolderCacheMaxAgeDelta(java.lang.Integer value)
Deprecated. As of release 4.0.1.

Sets the value of the FolderCacheMaxAgeDelta property. For more information, see FolderCacheMaxAgeDelta Property.


get_DatabaseIndexStorageLocation

java.lang.String get_DatabaseIndexStorageLocation()
Returns the value of the DatabaseIndexStorageLocation property. For more information, see DatabaseIndexStorageLocation Property.


set_DatabaseIndexStorageLocation

void set_DatabaseIndexStorageLocation(java.lang.String value)
Sets the value of the DatabaseIndexStorageLocation property. For more information, see DatabaseIndexStorageLocation Property.


get_DatabaseTableStorageLocation

java.lang.String get_DatabaseTableStorageLocation()
Returns the value of the DatabaseTableStorageLocation property. For more information, see DatabaseTableStorageLocation Property.


set_DatabaseTableStorageLocation

void set_DatabaseTableStorageLocation(java.lang.String value)
Sets the value of the DatabaseTableStorageLocation property. For more information, see DatabaseTableStorageLocation Property.


get_DatabaseLOBStorageLocation

java.lang.String get_DatabaseLOBStorageLocation()
Returns the value of the DatabaseLOBStorageLocation property. For more information, see DatabaseLOBStorageLocation Property.


set_DatabaseLOBStorageLocation

void set_DatabaseLOBStorageLocation(java.lang.String value)
Sets the value of the DatabaseLOBStorageLocation property. For more information, see DatabaseLOBStorageLocation Property.


installAddOn

void installAddOn(AddOn addOn)
Installs an add-on, available on a domain, to the current object store. When an add-on is installed, the pre-import script (if one exists) is run. Then the import data is imported into the object store, creating new metadata classes, properties, and data objects. Finally, the post-import script is run.

This method results in one of the following outcomes:

Parameters:
addOn - An AddOn object that specifies the add-on to install.

fetchAndLockObject

IndependentObject fetchAndLockObject(java.lang.String classIdent,
                                     java.lang.String objectIdent,
                                     long timeout,
                                     java.lang.String lockOwner,
                                     PropertyFilter filter)
Retrieves and locks the specified object from this 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.

Parameters:
classIdent - The class of the object to be retrieved and locked. You can specify the value of this parameter as an ID (a string containing a GUID) or a symbolic name.
objectIdent - The ID of the object to retrieve. You can specify the value of this parameter 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. The value 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.
Returns:
An object of the requested type.

fetchAndLockObject

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. 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.

Parameters:
classIdent - The class of the object to be retrieved and locked. You can specify this value as an ID (a string containing a 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. The value 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.
Returns:
An object of the requested type.

get_ClassDescriptions

ClassDescriptionSet get_ClassDescriptions()
Returns the value of the ClassDescriptions property. For more information, see ClassDescriptions Property.


isAddOnInstalled

boolean isAddOnInstalled(Id addOnId)
Returns a boolean value indicating whether the feature addon identified by addOnId is installed (true) or not (false) in the object store. If the feature addon identified by addOnId has been superseded and the superseded addon is currently installed, a value of true is returned.

Parameters:
addOnId - An Id object identifying the feature addon to check per the previously stated semantics.
Returns:
A boolean value indicating whether or not the feature addon identified by addOnId or that addon's superseding version is installed.

determinePrerequisiteAddOnIds

IdList determinePrerequisiteAddOnIds(Id addOnId)
Returns the feature addon IDs for which installation is required prior to the installation of the feature addon specified by addOnId. If the addon specified by addOnId has been superseded, then the results are based on the superseding addon prerequisites.

Parameters:
addOnId - An Id object representing the ID of the feature addon to be installed. Example: SystemAddOnId.PUBLISHING
Returns:
A collection of addon IDs that must be installed prior to installation of the feature addon specified by addOnId.


© Copyright IBM Corporation 2006, 2009. All rights reserved.