oracle.ifs.server

Class S_LibraryObjectDataSharedState

java.lang.Object

oracle.ifs.server.S_LibraryObjectDataSharedState

All Implemented Interfaces:

Serializable, Cloneable

public class S_LibraryObjectDataSharedState
extends Object
implements Cloneable, Serializable

Shared state for a S_LibraryObjectData.

Warning! For internal use only. Please check with authors before considering any change to this class.

Version:

2.0

Author:

David Pitfield, Dave Long

See Also:

Serialized Form

(Published)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S_LibraryObjectDataSharedState() Constructs a S_LIbraryObjectDataSharedState.

Method Summary

Modifier and Type	Method and Description
void	addFolderItemIds(Long[] ids, SortSpecification sort) Sets the shared state representing the ids of the items in a Folder.
void	addReferencingFolderIds(Long[] ids, SortSpecification sort) Adds a set of ids of the Folders containing a PublicObject to the shared state.
protected void	applySharedStateMutations(S_LibrarySession session) Applies modifications to cached properties hashtable.
protected boolean	canPurge() Returns whether this instance should be purged when it is determined that it has not been recently used.
Object	clone() Clone an instance (need public scope).
AuditFolderPath	getAuditFolderPath() Gets the shared state representing for the AuditFolderPath for the associated Folder.
Hashtable	getAuditTypeEntryTable() Gets the shared state representing the Hashtable resolution of an AuditTypeList's set of AuditTypeEntries.
Long[]	getCompositeAclIds() Gets the shared state representing the ids of the composite ACLs of an ACL.
Long[]	getDirectAncestorGroupIds() Gets the shared state representing the ids of the direct ancestors of a directoryobject.
AttributeValue	getDirectSubclassesValue() Gets the shared state representing the set of direct subclasses of a ClassObject, stored as an AttributeValue of KOs.
Long[]	getFolderItemIds(LibrarySessionInterface sess, SortSpecification sort) Gets the shared state representing the ids of the items in a Folder.
Hashtable	getFolderItemsKeyedByName() Gets the shared state representing the Hashtable resolution of a Folder's items (keyed by item name, forced to upper case).
Long[]	getGroupDirectMemberIds() Gets the shared state representing the ids of the direct members of a group.
Boolean	getHasSubFoldersState() Returns the hasSubFolders shared state.
Long[]	getLifecyclePolicyEntryIds() Gets the shared state representing the ids of the LifecyclePolicyEntries of a LifecyclePolicy.
Hashtable	getMediaCustomSecureParameters() Gets the secure parameters of a MediaCustom index, as a Hashmap of string values hashed by string key.
Long[]	getMessageEntryIds() Gets the shared state representing the ids of the MessageEntries of a MessageList.
Hashtable	getNegativeFolderItemsKeyedByName() Gets the shared state representing the Hashtable resolution of the set of items not in a Folder (keyed by item name, forced to upper case).
Long[]	getPolicyListElementIds() Gets the shared state representing the ids of the PolicyListElements of a PolicyList.
Long	getPrimaryUserProfileId() Gets the shared state representing the id of the PrimaryUserProfile Id of a DirectoryUser.
Hashtable	getPropertyBundleProperties() Gets the shared state representing the Hashtable resolution of a PropertyBundle's properties.
Vector	getPropertyIds() Gets the shared state representing the ids of the properties of a property bundle.
Long[]	getPublicObjectCategoryIds() Gets the shared state representing the ids of the Categories of a PublicObject.
Long[]	getPublicObjectLinkIds() Gets the shared state representing the ids of the Links of a PublicObject.
Long[]	getReferencingFolderIds(LibrarySessionInterface sess, SortSpecification sort) Gets the shared state representing the ids of the Folders containing a PublicObject.
Long[]	getSchemaObjectCategoryIds() Gets the shared state representing the ids of the Categories of a SchemaObject.
Long[]	getSystemObjectCategoryIds() Gets the shared state representing the ids of the Categories of a SystemObject.
Long[]	getVersionDescriptionIds() Gets the shared state representing the ids of the VersionDescriptions of a VersionSeries.
Long[]	getVersionSeriesIds() Gets the shared state representing the ids of the VersionSerieses of a Family.
static boolean	isEventAffectingSharedState(int eventSubtype) Return true if the specified "special" event subtype is one that affects shared state.
protected void	resetAllState() Clear all members.
void	resetSharedState(IfsEvent event) Resets appropriate subelements of the shared state because of an event.
void	setAuditFolderPath(AuditFolderPath afp) Sets the shared state representing the AuditFolderPath for the associated Folder.
void	setAuditTypeEntryTable(Hashtable ht) Sets the shared state representing the Hashtable resolution of an AuditTypeList's set of AuditTypeEntries.
void	setCompositeAclIds(Long[] ids) Sets the shared state representing the ids of the composite ACLs of an ACL.
void	setDirectAncestorGroupIds(Long[] ids) Sets the shared state representing the ids of the direct ancestors of a directoryobject.
void	setDirectSubclassesValue(AttributeValue av) Sets the shared state representing the set of direct subclasses of a ClassObject, stored as an AttributeValue of KOs.
void	setFolderItemsKeyedByName(Hashtable ht) Sets the shared state representing the Hashtable resolution of a Folder's items (keyed by item name, forced to upper case).
void	setGroupDirectMemberIds(Long[] ids) Sets the shared state representing the ids of the direct members of a group.
void	setHasSubFoldersState(boolean hasSubFolders) Sets the new value for the hasSubFolders shared state.
void	setLifecyclePolicyEntryIds(Long[] ids) Sets the shared state representing the ids of the LifecyclePolicyEntries of a LifecyclePolicy.
void	setMediaCustomSecureParameters(Hashtable sps) Sets the secure parameters of a MediaCustom index, as a Hashmap of string values hashed by string key.
void	setMessageEntryIds(Long[] ids) Sets the shared state representing the ids of the MessageEntries of a MessageList.
void	setNegativeFolderItemsKeyedByName(Hashtable ht) Sets the shared state representing the Hashtable resolution of the set of items not in a Folder (keyed by item name, forced to upper case).
void	setPolicyListElementIds(Long[] ids) Sets the shared state representing the ids of the PolicyListElements of a PolicyList.
void	setPrimaryUserProfileId(Long id) Sets the shared state representing the id of the PrimaryUserProfile Id of a DirectoryUser.
void	setPropertyBundleProperties(Hashtable ht) Sets the shared state representing the Hashtable resolution of a PropertyBundle's properties.
void	setPropertyIds(Vector idsVector) Sets the shared state representing the ids of the properties of a property bundle.
void	setPublicObjectCategoryIds(Long[] ids) Sets the shared state representing the ids of the Categories of a PublicObject.
void	setPublicObjectLinkIds(Long[] ids) Sets the shared state representing the ids of the Links of a PublicObject.
void	setSchemaObjectCategoryIds(Long[] ids) Sets the shared state representing the ids of the Categories of a SchemaObject.
void	setSystemObjectCategoryIds(Long[] ids) Sets the shared state representing the ids of the Categories of a SystemObject.
void	setVersionDescriptionIds(Long[] ids) Sets the shared state representing the ids of the VersionDescription of a VersionSeries.
void	setVersionSeriesIds(Long[] ids) Sets the shared state representing the ids of the VersionSerieses of a Family.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

S_LibraryObjectDataSharedState

protected S_LibraryObjectDataSharedState()

Constructs a S_LIbraryObjectDataSharedState.

Method Detail

canPurge

protected final boolean canPurge()
                          throws IfsException

Returns whether this instance should be purged when it is determined that it has not been recently used.

Returns:

whether the item can be purged

Throws:

IfsException - if operation fails.

(Published)

getPublicObjectCategoryIds

public Long[] getPublicObjectCategoryIds()
                                  throws IfsException

Gets the shared state representing the ids of the Categories of a PublicObject.

Returns:

the Category ids

Throws:

IfsException - if the operation fails

(Published)

setPublicObjectCategoryIds

public void setPublicObjectCategoryIds(Long[] ids)
                                throws IfsException

Sets the shared state representing the ids of the Categories of a PublicObject.

Parameters:

ids - the Category ids

Throws:

IfsException - if the operation fails

(Published)

getSystemObjectCategoryIds

public Long[] getSystemObjectCategoryIds()
                                  throws IfsException

Gets the shared state representing the ids of the Categories of a SystemObject.

Returns:

the system Category ids

Throws:

IfsException - if the operation fails

(Published)

setSystemObjectCategoryIds

public void setSystemObjectCategoryIds(Long[] ids)
                                throws IfsException

Sets the shared state representing the ids of the Categories of a SystemObject.

Parameters:

ids - the SystemCategory ids

Throws:

IfsException - if the operation fails

(Published)

getSchemaObjectCategoryIds

public Long[] getSchemaObjectCategoryIds()
                                  throws IfsException

Gets the shared state representing the ids of the Categories of a SchemaObject.

Returns:

the schema Category ids

Throws:

IfsException - if the operation fails

(Published)

setSchemaObjectCategoryIds

public void setSchemaObjectCategoryIds(Long[] ids)
                                throws IfsException

Sets the shared state representing the ids of the Categories of a SchemaObject.

Parameters:

ids - the SchemaCategory ids

Throws:

IfsException - if the operation fails

(Published)

getPublicObjectLinkIds

public Long[] getPublicObjectLinkIds()
                              throws IfsException

Gets the shared state representing the ids of the Links of a PublicObject.

Returns:

the Link ids

Throws:

IfsException - if the operation fails

(Published)

setPublicObjectLinkIds

public void setPublicObjectLinkIds(Long[] ids)
                            throws IfsException

Sets the shared state representing the ids of the Links of a PublicObject.

Parameters:

ids - the Link ids

Throws:

IfsException - if the operation fails

(Published)

getVersionDescriptionIds

public Long[] getVersionDescriptionIds()
                                throws IfsException

Gets the shared state representing the ids of the VersionDescriptions of a VersionSeries.

Returns:

the VersionDescription ids

Throws:

IfsException - if the operation fails

(Published)

setVersionDescriptionIds

public void setVersionDescriptionIds(Long[] ids)
                              throws IfsException

Sets the shared state representing the ids of the VersionDescription of a VersionSeries.

Parameters:

ids - the VersionDescription ids

Throws:

IfsException - if the operation fails

(Published)

getVersionSeriesIds

public Long[] getVersionSeriesIds()
                           throws IfsException

Gets the shared state representing the ids of the VersionSerieses of a Family.

Returns:

the VersionSeries ids

Throws:

IfsException - if the operation fails

(Published)

setVersionSeriesIds

public void setVersionSeriesIds(Long[] ids)
                         throws IfsException

Sets the shared state representing the ids of the VersionSerieses of a Family.

Parameters:

ids - the VersionSeries ids

Throws:

IfsException - if the operation fails

(Published)

getPropertyIds

public Vector getPropertyIds()
                      throws IfsException

Gets the shared state representing the ids of the properties of a property bundle.

Returns:

the property ids vector

Throws:

IfsException - if the operation fails

(Published)

setPropertyIds

public void setPropertyIds(Vector idsVector)
                    throws IfsException

Sets the shared state representing the ids of the properties of a property bundle.

Parameters:

idsVector - the property ids

Throws:

IfsException - if the operation fails

(Published)

getPropertyBundleProperties

public Hashtable getPropertyBundleProperties()
                                      throws IfsException

Gets the shared state representing the Hashtable resolution of a PropertyBundle's properties.

Returns:

the hashed representation of a PropertyBundle's properties

Throws:

IfsException - if the operation fails

(Published)

setPropertyBundleProperties

public void setPropertyBundleProperties(Hashtable ht)
                                 throws IfsException

Sets the shared state representing the Hashtable resolution of a PropertyBundle's properties.

Parameters:

ht - the hashed representation of a PropertyBundle's properties

Throws:

IfsException - if the operation fails

(Published)

getGroupDirectMemberIds

public Long[] getGroupDirectMemberIds()
                               throws IfsException

Gets the shared state representing the ids of the direct members of a group.

Returns:

the direct member ids

Throws:

IfsException - if the operation fails

(Published)

setGroupDirectMemberIds

public void setGroupDirectMemberIds(Long[] ids)
                             throws IfsException

Sets the shared state representing the ids of the direct members of a group.

Parameters:

ids - the direct member ids

Throws:

IfsException - if the operation fails

(Published)

getDirectAncestorGroupIds

public Long[] getDirectAncestorGroupIds()
                                 throws IfsException

Gets the shared state representing the ids of the direct ancestors of a directoryobject.

Returns:

the direct ancestor ids

Throws:

IfsException - if the operation fails

(Published)

setDirectAncestorGroupIds

public void setDirectAncestorGroupIds(Long[] ids)
                               throws IfsException

Sets the shared state representing the ids of the direct ancestors of a directoryobject.

Parameters:

ids - the direct ancestor ids

Throws:

IfsException - if the operation fails

(Published)

getPrimaryUserProfileId

public Long getPrimaryUserProfileId()
                             throws IfsException

Gets the shared state representing the id of the PrimaryUserProfile Id of a DirectoryUser.

Returns:

the PrimaryUserProfile id

Throws:

IfsException - if the operation fails

(Published)

setPrimaryUserProfileId

public void setPrimaryUserProfileId(Long id)
                             throws IfsException

Sets the shared state representing the id of the PrimaryUserProfile Id of a DirectoryUser.

Parameters:

id - the PrimaryUserProfile id

Throws:

IfsException - if the operation fails

(Published)

getCompositeAclIds

public Long[] getCompositeAclIds()
                          throws IfsException

Gets the shared state representing the ids of the composite ACLs of an ACL.

Returns:

the composite ACLs of an ACL

Throws:

IfsException - if the operation fails

(Published)

setCompositeAclIds

public void setCompositeAclIds(Long[] ids)
                        throws IfsException

Sets the shared state representing the ids of the composite ACLs of an ACL.

Parameters:

ids - the composite ACLs of an ACL

Throws:

IfsException - if the operation fails

(Published)

getPolicyListElementIds

public Long[] getPolicyListElementIds()
                               throws IfsException

Gets the shared state representing the ids of the PolicyListElements of a PolicyList.

Returns:

the policylist ids

Throws:

IfsException - if the operation fails

(Published)

setPolicyListElementIds

public void setPolicyListElementIds(Long[] ids)
                             throws IfsException

Sets the shared state representing the ids of the PolicyListElements of a PolicyList.

Parameters:

ids - the policylist element ids

Throws:

IfsException - if the operation fails

(Published)

getLifecyclePolicyEntryIds

public Long[] getLifecyclePolicyEntryIds()
                                  throws IfsException

Gets the shared state representing the ids of the LifecyclePolicyEntries of a LifecyclePolicy.

Returns:

the LifecyclePolicyEntry ids

Throws:

IfsException - if the operation fails

(Published)

setLifecyclePolicyEntryIds

public void setLifecyclePolicyEntryIds(Long[] ids)
                                throws IfsException

Sets the shared state representing the ids of the LifecyclePolicyEntries of a LifecyclePolicy.

Parameters:

ids - the LifecyclePolicyEntry ids

Throws:

IfsException - if the operation fails

(Published)

getMessageEntryIds

public Long[] getMessageEntryIds()
                          throws IfsException

Gets the shared state representing the ids of the MessageEntries of a MessageList.

Returns:

the MessageEntry IDs

Throws:

IfsException - if the operation fails

(Published)

setMessageEntryIds

public void setMessageEntryIds(Long[] ids)
                        throws IfsException

Sets the shared state representing the ids of the MessageEntries of a MessageList.

Parameters:

ids - the MessageEntry IDs

Throws:

IfsException - if the operation fails

(Published)

getMediaCustomSecureParameters

public Hashtable getMediaCustomSecureParameters()
                                         throws IfsException

Gets the secure parameters of a MediaCustom index, as a Hashmap of string values hashed by string key.

Returns:

the secure parameters, or null if none

Throws:

IfsException - if the operation fails

(Published)

setMediaCustomSecureParameters

public void setMediaCustomSecureParameters(Hashtable sps)
                                    throws IfsException

Sets the secure parameters of a MediaCustom index, as a Hashmap of string values hashed by string key.

Parameters:

sps - the secure parameters, or null if none

Throws:

IfsException - if the operation fails

(Published)

getAuditTypeEntryTable

public Hashtable getAuditTypeEntryTable()
                                 throws IfsException

Gets the shared state representing the Hashtable resolution of an AuditTypeList's set of AuditTypeEntries.

The Hashtable is keyed by operation type (the Integer), and has a value of an AuditTypeEntryValue.

Returns:

the hashed representation of an AuditTypeList's AuditTypeEntries, keyed by operation type.

Throws:

IfsException - if the operation fails

setAuditTypeEntryTable

public void setAuditTypeEntryTable(Hashtable ht)
                            throws IfsException

Sets the shared state representing the Hashtable resolution of an AuditTypeList's set of AuditTypeEntries.

See javadoc for getAuditTypeEntryTable which describes the structure of the Hashtable.

Parameters:

ht - the hashed representation of an AuditTypeList, keyed by operation type.

Throws:

IfsException - if the operation fails

getDirectSubclassesValue

public AttributeValue getDirectSubclassesValue()
                                        throws IfsException

Gets the shared state representing the set of direct subclasses of a ClassObject, stored as an AttributeValue of KOs.

Returns:

the value representing a set of ClassObjects

Throws:

IfsException - if the operation fails

(Published)

setDirectSubclassesValue

public void setDirectSubclassesValue(AttributeValue av)
                              throws IfsException

Sets the shared state representing the set of direct subclasses of a ClassObject, stored as an AttributeValue of KOs.

Parameters:

av - the value representing a set of ClassObjects

Throws:

IfsException - if the operation fails

(Published)

getFolderItemIds

public Long[] getFolderItemIds(LibrarySessionInterface sess,
                               SortSpecification sort)
                        throws IfsException

Gets the shared state representing the ids of the items in a Folder.

Returns:

the Folder item ids

Throws:

IfsException - if the operation fails

(Published)

getHasSubFoldersState

public Boolean getHasSubFoldersState()
                              throws IfsException

Returns the hasSubFolders shared state. If there is no state, it returns null;

Returns:

has sub folders shared state

Throws:

IfsException - if the operation fails

(Published)

addFolderItemIds

public void addFolderItemIds(Long[] ids,
                             SortSpecification sort)
                      throws IfsException

Sets the shared state representing the ids of the items in a Folder.

Parameters:

ids - the Folder item ids

Throws:

IfsException - if the operation fails

(Published)

setHasSubFoldersState

public void setHasSubFoldersState(boolean hasSubFolders)
                           throws IfsException

Sets the new value for the hasSubFolders shared state.

Parameters:

hasSubFolders - the new value for the state

Throws:

IfsException - if the operation fails

(Published)

getReferencingFolderIds

public Long[] getReferencingFolderIds(LibrarySessionInterface sess,
                                      SortSpecification sort)
                               throws IfsException

Gets the shared state representing the ids of the Folders containing a PublicObject.

Parameters:

sess - the session sontext

sort - how the IDs are to be sorted

Returns:

the Folder ids

Throws:

IfsException - if the operation fails

(Published)

addReferencingFolderIds

public void addReferencingFolderIds(Long[] ids,
                                    SortSpecification sort)
                             throws IfsException

Adds a set of ids of the Folders containing a PublicObject to the shared state.

Parameters:

ids - the Folder item ids

sort - how they are sorted

Throws:

IfsException - if the operation fails

(Published)

getFolderItemsKeyedByName

public Hashtable getFolderItemsKeyedByName()
                                    throws IfsException

Gets the shared state representing the Hashtable resolution of a Folder's items (keyed by item name, forced to upper case).

Returns:

the hashed representation of a Folder's items

Throws:

IfsException - if the operation fails

(Published)

setFolderItemsKeyedByName

public void setFolderItemsKeyedByName(Hashtable ht)
                               throws IfsException

Sets the shared state representing the Hashtable resolution of a Folder's items (keyed by item name, forced to upper case).

Parameters:

ht - the hashed representation of a Folder's items.

Throws:

IfsException - if the operation fails

(Published)

getNegativeFolderItemsKeyedByName

public Hashtable getNegativeFolderItemsKeyedByName()
                                            throws IfsException

Gets the shared state representing the Hashtable resolution of the set of items not in a Folder (keyed by item name, forced to upper case).

Returns:

the hashed representation of a items not in a Folder

Throws:

IfsException - if the operation fails

(Published)

setNegativeFolderItemsKeyedByName

public void setNegativeFolderItemsKeyedByName(Hashtable ht)
                                       throws IfsException

Sets the shared state representing the Hashtable resolution of the set of items not in a Folder (keyed by item name, forced to upper case).

Parameters:

ht - the hashed representation of a items not in a Folder

Throws:

IfsException - if the operation fails

(Published)

getAuditFolderPath

public AuditFolderPath getAuditFolderPath()
                                   throws IfsException

Gets the shared state representing for the AuditFolderPath for the associated Folder.

Returns:

the AuditFolderPath for the target folder

Throws:

IfsException - if the operation fails

(Published)

setAuditFolderPath

public void setAuditFolderPath(AuditFolderPath afp)
                        throws IfsException

Sets the shared state representing the AuditFolderPath for the associated Folder.

Parameters:

afp - the AuditFolderPath

Throws:

IfsException - if the operation fails

(Published)

clone

public final Object clone()
                   throws CloneNotSupportedException

Clone an instance (need public scope).

Overrides:

clone in class Object

Returns:

the clone

Throws:

CloneNotSupportedException

(Published)

isEventAffectingSharedState

public static boolean isEventAffectingSharedState(int eventSubtype)

Return true if the specified "special" event subtype is one that affects shared state.

Parameters:

eventSubtype - the event subtype that triggered the reset

Returns:

true if this event subtype affects shared state

(Published)

resetSharedState

public void resetSharedState(IfsEvent event)

Resets appropriate subelements of the shared state because of an event.

Parameters:

event - event that caused the shared state reset.

(Published)

applySharedStateMutations

protected void applySharedStateMutations(S_LibrarySession session)

Applies modifications to cached properties hashtable. This will get called from S_LOData.fetchOrCreateSharedState() if the state already exists and the caller indicates that the mutations be applied. This method is currently used only for LO data that correspond to to a property bundle.

Parameters:

session - LibrarySession

(Published)

resetAllState

protected void resetAllState()

Clear all members.

(Published)