oracle.ifs.common

Interface LibrarySessionInterface

All Superinterfaces:

Traceable

All Known Implementing Classes:

LibrarySession, S_LibrarySession, S_TieLibrarySession, TieLibrarySession

public interface LibrarySessionInterface
extends Traceable

The interface used by beans-side and server-side LibrarySession classes.

This is used to make certain classes in the common package useable by both the beans and server packages.

Version:

1.0

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALWAYS_CACHE_SELECTED_DATA_PROPERTY Session property name for the boolean setting for the indication as to whether the current session always caches selected data from Selectors.
static String	CLEAR_SHARED_CACHES Session property name for the boolean setting to indicate whether the service should clear its shared caches.
static String	DEFAULT_CONTENTQUOTA_PROPERTY Session property name for the default ContentQuota object
static int	EXECUTIONMODE_ADMINISTRATION Administration execution mode.
static int	EXECUTIONMODE_DISCOVERYADMINISTRATION Discovery-administration execution mode.
static int	EXECUTIONMODE_INSTALLADMINISTRATION Install administration execution mode.
static int	EXECUTIONMODE_PREEXISTING Pre-existing execution mode.
static int	EXECUTIONMODE_SYSTEMADMINISTRATION System administration execution mode.
static int	EXECUTIONMODE_USER User execution mode.
static String	FOLDER_PATH_DELIMITER_PROPERTY Session property name for the Folder-Path delimiter
static String	PREVENT_SESSION_TIMEOUTS_PROPERTY Session property name for the boolean setting for bypassing session timeouts
static String	UPGRADE_BEHAVIOR_PROPERTY Session property name for the boolean setting for behaving as if an upgrade was in progress.

Method Summary

Modifier and Type	Method and Description
AttributeValue	getArrayTypeAttributeValue(AttributeValueArray av, long objectId, long attributeId, Long priClassId, int count) Gets a fully resolved array-type AttributeValue with non-transient elements that is a copy of the specified array-type AttributeValue.
String	getAttributeSortName(String classname, String attributename) return the Database object name that corresponds to an Attribute of a specified ClassObject.
Collection	getClassAccessControlListCollection() Gets a reference to the ClassAccessControlList collection.
Collection	getClassDomainCollection() Gets a reference to the ClassDomain collection.
Collection	getClassObjectCollection() Gets a reference to the ClassObject collection.
AttributeValue	getClassObjectValueByName(String name) Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.
DirectoryObjectInterface	getDirectoryObjectInterface(Long id) Gets the DirectoryObjectInterface for the specified id.
DirectoryObjectInterface[]	getDirectoryObjectInterfaces(Long[] ids) Gets the DirectoryObjectInterfaces for the specified ids.
Collection	getDirectoryUserCollection() Gets a reference to the DirectoryUser collection.
Collection	getExtendedPermissionCollection() Gets a reference to the ExtendedPermission collection.
Collection	getExtendedUserProfileCollection() Gets a reference to the ExtendedUserProfile collection.
Collection	getFormatCollection() Gets a reference to the Format collection.
Collection	getFormatExtensionCollection() Gets a reference to the FormatExtension collection.
Localizer	getLocalizer() Gets the localizer of this session.
Long	getLowestCommonClassObjectIdAncestor(SimpleObjectInterface[] mos) Gets the lowest common ClassObject ancestor for the specified array of SimpleObjectInterface, excluding tableless ClassObjects.
AttributeValue	getMapTypeAttributeValue(int dataType, long objectId, long attrIdVal, int count) Gets a fully resolved map-type AttributeValue with non-transient elements that is a copy of the specified map-type AttributeValue.
Collection	getMediaCollection() Gets a reference to the Media collection.
Collection	getPermissionBundleCollection() Gets a reference to the PermissionBundle collection.
Collection	getPolicyCollection() Gets a reference to the Policy collection.
PublicObjectInterface	getPublicObjectInterface(Long id) Gets the PublicObjectInterface for the specified id.
PublicObjectInterface[]	getPublicObjectInterfaces(Long[] ids) Gets the PublicObjectInterfaces for the specified ids.
SchemaObjectInterface	getSchemaObjectInterface(Long id) Gets the SchemaObjectInterface for the specified id.
SchemaObjectInterface[]	getSchemaObjectInterfaces(Long[] ids) Gets the SchemaObjectInterfaces for the specified ids.
SimpleObjectInterface	getSimpleObjectInterface(Long id, Long classId) Gets the SimpleObjectInterface for the specified id.
SimpleObjectInterface[]	getSimpleObjectInterfaces(Long[] ids) Gets the SimpleObjectInterfaces for the specified ids.
SimpleObjectInterface[]	getSimpleObjectInterfaces(Long[] ids, Long primaryClassId) Gets the SimpleObjectInterfaces for the specified ids.
Collection	getSystemAccessControlListCollection() Gets a reference to the SystemAccessControlList collection.
SystemObjectInterface	getSystemObjectInterface(Long id) Gets the SystemObjectInterface for the specified id.
SystemObjectInterface[]	getSystemObjectInterfaces(Long[] ids) Gets the SystemObjectInterfaces for the specified ids.
Collection	getValueDefaultCollection() Gets a reference to the ValueDefault collection.
Collection	getValueDomainCollection() Gets a reference to the ValueDomain collection.

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

FOLDER_PATH_DELIMITER_PROPERTY

static final String FOLDER_PATH_DELIMITER_PROPERTY

Session property name for the Folder-Path delimiter

See Also:

Constant Field Values

(Unpublished)

DEFAULT_CONTENTQUOTA_PROPERTY

static final String DEFAULT_CONTENTQUOTA_PROPERTY

Session property name for the default ContentQuota object

See Also:

Constant Field Values

(Unpublished)

PREVENT_SESSION_TIMEOUTS_PROPERTY

static final String PREVENT_SESSION_TIMEOUTS_PROPERTY

Session property name for the boolean setting for bypassing session timeouts

See Also:

Constant Field Values

(Unpublished)

ALWAYS_CACHE_SELECTED_DATA_PROPERTY

static final String ALWAYS_CACHE_SELECTED_DATA_PROPERTY

Session property name for the boolean setting for the indication as to whether the current session always caches selected data from Selectors.

See Also:

Constant Field Values

(Unpublished)

UPGRADE_BEHAVIOR_PROPERTY

static final String UPGRADE_BEHAVIOR_PROPERTY

Session property name for the boolean setting for behaving as if an upgrade was in progress.

When this behavior is set to true, operations performed on behalf of that session differ from those occuring on normal sessions in the following ways:

• Quota is not checked during document creation/update.
• Last modification date and last modifier are not updated when updating system-set attributes.
• Last modification date and last modifier are not updated on folders when an item is added or removed from that folder.

See Also:

Constant Field Values

(Unpublished)

CLEAR_SHARED_CACHES

static final String CLEAR_SHARED_CACHES

Session property name for the boolean setting to indicate whether the service should clear its shared caches.

When this behavior is set to true, the S_LibraryService will perform a one-time reset of its internal shared caches.

See Also:

Constant Field Values

(Unpublished)

EXECUTIONMODE_PREEXISTING

static final int EXECUTIONMODE_PREEXISTING

Pre-existing execution mode.

An execution mode used internally by the session to indicate that the session's execution mode is not temporarily overridden by a more priviledged mode (for example, in the execution of a policy-driven operation).

See Also:

Constant Field Values

(Published)

EXECUTIONMODE_USER

static final int EXECUTIONMODE_USER

User execution mode.

The session executes in a normal user mode, meaning all operations are controlled by ACLs and other default authorization rules.

See Also:

Constant Field Values

(Published)

EXECUTIONMODE_DISCOVERYADMINISTRATION

static final int EXECUTIONMODE_DISCOVERYADMINISTRATION

Discovery-administration execution mode.

The session executes in a privileged mode, in which any PublicObject can be "discovered", regardless of its ACL or owner.

See Also:

Constant Field Values

(Published)

EXECUTIONMODE_ADMINISTRATION

static final int EXECUTIONMODE_ADMINISTRATION

Administration execution mode.

The session executes in a privileged "administration" mode. This allows operations that would normally be prevented for regular user sessions.

See Also:

Constant Field Values

(Published)

EXECUTIONMODE_SYSTEMADMINISTRATION

static final int EXECUTIONMODE_SYSTEMADMINISTRATION

System administration execution mode.

The session executes in a privileged " system administration" mode. This allows operations that would normally be prevented for regular user sessions.

See Also:

Constant Field Values

(Published)

EXECUTIONMODE_INSTALLADMINISTRATION

static final int EXECUTIONMODE_INSTALLADMINISTRATION

Install administration execution mode.

The session executes in the most privileged mode, to allow certain operations that are performed during installation or upgrade.

See Also:

Constant Field Values

(Unpublished)

Method Detail

getLocalizer

Localizer getLocalizer()
                throws IfsException

Gets the localizer of this session.

Returns:

the localizer

Throws:

IfsException - if the operation fails

(Published)

getClassObjectValueByName

AttributeValue getClassObjectValueByName(String name)
                                  throws IfsException

Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.

Returns:

the CLASSOBJECT value

Throws:

IfsException - if the operation fails

(Published)

getClassObjectCollection

Collection getClassObjectCollection()
                             throws IfsException

Gets a reference to the ClassObject collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getClassDomainCollection

Collection getClassDomainCollection()
                             throws IfsException

Gets a reference to the ClassDomain collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getValueDefaultCollection

Collection getValueDefaultCollection()
                              throws IfsException

Gets a reference to the ValueDefault collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getValueDomainCollection

Collection getValueDomainCollection()
                             throws IfsException

Gets a reference to the ValueDomain collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getExtendedUserProfileCollection

Collection getExtendedUserProfileCollection()
                                     throws IfsException

Gets a reference to the ExtendedUserProfile collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getFormatCollection

Collection getFormatCollection()
                        throws IfsException

Gets a reference to the Format collection.

Returns:

the CachedResolverCollection

Throws:

IfsException - if the operation fails

(Published)

getFormatExtensionCollection

Collection getFormatExtensionCollection()
                                 throws IfsException

Gets a reference to the FormatExtension collection.

Unlike the FormatCollection, this collection is organizaed by EXTENSION, not NAME.

Returns:

the CachedResolverCollection

Throws:

IfsException - if the operation fails

(Published)

getMediaCollection

Collection getMediaCollection()
                       throws IfsException

Gets a reference to the Media collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getSystemAccessControlListCollection

Collection getSystemAccessControlListCollection()
                                         throws IfsException

Gets a reference to the SystemAccessControlList collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getClassAccessControlListCollection

Collection getClassAccessControlListCollection()
                                        throws IfsException

Gets a reference to the ClassAccessControlList collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getDirectoryUserCollection

Collection getDirectoryUserCollection()
                               throws IfsException

Gets a reference to the DirectoryUser collection.

Returns:

the UncachedPreparedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getExtendedPermissionCollection

Collection getExtendedPermissionCollection()
                                    throws IfsException

Gets a reference to the ExtendedPermission collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getPermissionBundleCollection

Collection getPermissionBundleCollection()
                                  throws IfsException

Gets a reference to the PermissionBundle collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getPolicyCollection

Collection getPolicyCollection()
                        throws IfsException

Gets a reference to the Policy collection.

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getDirectoryObjectInterface

DirectoryObjectInterface getDirectoryObjectInterface(Long id)
                                              throws IfsException

Gets the DirectoryObjectInterface for the specified id.

Parameters:

id - the id of interest

Returns:

the DirectoryObjectInterface

Throws:

IfsException - if the operation fails

(Unpublished)

getDirectoryObjectInterfaces

DirectoryObjectInterface[] getDirectoryObjectInterfaces(Long[] ids)
                                                 throws IfsException

Gets the DirectoryObjectInterfaces for the specified ids.

Parameters:

ids - the ids of interest

Returns:

the DirectoryObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getPublicObjectInterface

PublicObjectInterface getPublicObjectInterface(Long id)
                                        throws IfsException

Gets the PublicObjectInterface for the specified id.

Parameters:

id - the id of interest

Returns:

the PublicObjectInterface

Throws:

IfsException - if the operation fails

(Unpublished)

getPublicObjectInterfaces

PublicObjectInterface[] getPublicObjectInterfaces(Long[] ids)
                                           throws IfsException

Gets the PublicObjectInterfaces for the specified ids.

Parameters:

ids - the ids of interest

Returns:

the PublicObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getSchemaObjectInterface

SchemaObjectInterface getSchemaObjectInterface(Long id)
                                        throws IfsException

Gets the SchemaObjectInterface for the specified id.

Parameters:

id - the id of interest

Returns:

the SchemaObjectInterface

Throws:

IfsException - if the operation fails

(Unpublished)

getSchemaObjectInterfaces

SchemaObjectInterface[] getSchemaObjectInterfaces(Long[] ids)
                                           throws IfsException

Gets the SchemaObjectInterfaces for the specified ids.

Parameters:

ids - the ids of interest

Returns:

the SchemaObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getSystemObjectInterface

SystemObjectInterface getSystemObjectInterface(Long id)
                                        throws IfsException

Gets the SystemObjectInterface for the specified id.

Parameters:

id - the id of interest

Returns:

the SystemObjectInterface

Throws:

IfsException - if the operation fails

(Unpublished)

getSystemObjectInterfaces

SystemObjectInterface[] getSystemObjectInterfaces(Long[] ids)
                                           throws IfsException

Gets the SystemObjectInterfaces for the specified ids.

Parameters:

ids - the ids of interest

Returns:

the SystemObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getSimpleObjectInterface

SimpleObjectInterface getSimpleObjectInterface(Long id,
                                               Long classId)
                                        throws IfsException

Gets the SimpleObjectInterface for the specified id.

Parameters:

id - the id of interest

id - the classId of interest

Returns:

the SimpleObjectInterface

Throws:

IfsException - if the operation fails

(Unpublished)

getSimpleObjectInterfaces

SimpleObjectInterface[] getSimpleObjectInterfaces(Long[] ids)
                                           throws IfsException

Gets the SimpleObjectInterfaces for the specified ids.

Parameters:

ids - the ids of interest

Returns:

the SimpleObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getSimpleObjectInterfaces

SimpleObjectInterface[] getSimpleObjectInterfaces(Long[] ids,
                                                  Long primaryClassId)
                                           throws IfsException

Gets the SimpleObjectInterfaces for the specified ids.

Parameters:

ids - the ids of interest

primaryClassId - the primary class ID

Returns:

the SimpleObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getAttributeSortName

String getAttributeSortName(String classname,
                            String attributename)
                     throws IfsException

return the Database object name that corresponds to an Attribute of a specified ClassObject. Used by SortSpecification to derive the SQL order by clause. This will throw an Exception if there is no Attribute for the specified class, or if the ClassObject does not exist.

Parameters:

classname - the name of the ClassObject

attributename - the name of the Attribute

Returns:

the Database object name that corresponds to an Attribute.

Throws:

IfsException - if the operation fails

(Unpublished)

getArrayTypeAttributeValue

AttributeValue getArrayTypeAttributeValue(AttributeValueArray av,
                                          long objectId,
                                          long attributeId,
                                          Long priClassId,
                                          int count)
                                   throws IfsException

Gets a fully resolved array-type AttributeValue with non-transient elements that is a copy of the specified array-type AttributeValue.

For internal use only. Do not use this method.

The invoker of this method sucks the elements from the returned object, plugs them into the corresponding cached AttributeValue, and then discards the returned object.

Parameters:

av - the AttributeValue of interest

objectId - The LibraryObject ID.

attributeId - The Attribute id.

priClassId - The primary Class ID

count - the number of elements in the AttributeValue

Returns:

a fully-resolved copy of the AttributeValue

Throws:

IfsException - if the operation fails

(Unpublished)

getMapTypeAttributeValue

AttributeValue getMapTypeAttributeValue(int dataType,
                                        long objectId,
                                        long attrIdVal,
                                        int count)
                                 throws IfsException

Gets a fully resolved map-type AttributeValue with non-transient elements that is a copy of the specified map-type AttributeValue.

For internal use only. Do not use this method.

The invoker of this method sucks the elements from the returned object, plugs them into the corresponding cached AttributeValue, and then discards the returned object.

Parameters:

dataType - the AttributeValue's data type

objectId - the ID of the LibraryObject for which this AttributeValue represents the value of one of its Attributes

attrIdVal - the ID value of the Attribute

count - the number of elements in the AttributeValue

Returns:

a fully-resolved copy of the AttributeValue

Throws:

IfsException - if the operation fails

(Unpublished)

getLowestCommonClassObjectIdAncestor

Long getLowestCommonClassObjectIdAncestor(SimpleObjectInterface[] mos)
                                   throws IfsException

Gets the lowest common ClassObject ancestor for the specified array of SimpleObjectInterface, excluding tableless ClassObjects.

The class ID returned is null if all objects in the specified array are null. The class ID returned is zero if there is no common ancestor for the specified objects (at least one of which is non-null) that is non-tableless.

Parameters:

mos - the SimpleObjects

Returns:

the ID of the ClassObject that is the lowest common ancestor of the SimpleObjects

Throws:

IfsException - if the operation fails

(Unpublished)