Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.ifs.server
Class S_LibrarySession

    java.lang.Object
      oracle.ifs.server.S_LibrarySession

All Implemented Interfaces:
  LibraryConstants, IfsEventHandler, LibrarySessionInterface, LogInfo, Traceable, S_LibrarySessionInterface

Direct Known Subclasses:
  S_TieLibrarySession

    public class S_LibrarySession

extends java.lang.Object
implements LibrarySessionInterface, S_LibrarySessionInterface, IfsEventHandler, Traceable, LibraryConstants, LogInfo

An S_LibrarySession represents a user session in the CM SDK repository.

For every S_LibrarySession there is a corresponding LibrarySession. LibrarySession, in the package `oracle.ifs.beans`, forms part of the CM SDK application development API, informally known as the "beans API". Applications invoke CM SDK functionality by calling the beans API. S_LibrarySession, however, is in the `oracle.ifs.server` package, and forms part of the CM SDK server extensibility API, also known as the "server API". The server API is used to override or extend out-of-the-box CM SDK behavior by injecting your code into certain methods that are automatically invoked by the CM SDK repository. Applications do not typically call the server API directly.

S_LibrarySession provides helpful methods as you use the server API to change the behavior of S_LibraryObject subclasses. To get a reference to the S_LibrarySession, call `getSession` on S_LibraryObject.

You can change the behavior of S_LibrarySession via the Tie class, S_TieLibrarySession.

(Published)

Field Summary
`protected boolean` | `m_AccessCheckMode` Indication if access checks for other than Discover permssion should be performed.
`protected java.util.Stack` | `m_AccessCheckModeStack` A stack of temporary access check modes, stored as Boolean objects.
`protected java.lang.String` | `m_ApplicationName` The name of the application that created this session.
`protected java.util.Hashtable` | `m_AuxiliaryConnections` The auxiliary LibraryConnections acquired by this S_LibrarySession, hashed by Connection.
`protected boolean` | `m_Cancelled` Has the session been interrupted due to an explicit cancel?
`protected long` | `m_ClientVersionNumber` The version of LibrarySession as a long.
`protected java.lang.String` | `m_ClientVersionString` The version of LibrarySession as a string.
`protected java.lang.Long` | `m_ComponentAclsAttributeId` The ID of the AccessControlList.ComponentAcls attribute
`protected java.util.Hashtable` | `m_Cursors` The S_LibraryObjectCursors created by this S_LibrarySession, hashed by cursor sequence.
`protected long` | `m_CursorSequence` The last used cursor sequence.
`protected S_ContentQuota` | `m_DefaultContentQuota` the default ContentQuota object that will be used for any new Documents
`protected java.lang.String` | `m_DefaultFolderRelationshipClassname` The name of the default classobject used to represent new folder relationships.
`protected java.lang.Long` | `m_DirectoryObjectClassId` The id of the DIRECTORYOBJECT classobject.
`protected S_PropertyBundle` | `m_DomainPropertyBundle` The domain PropertyBundle.
`protected boolean` | `m_EventProcessingEnabled` Whether event processing is enabled for this S_LibrarySession.
`protected oracle.ifs.server.S_LibrarySession.Fifo` | `m_EventsQueuedForProcessing` A queue of events awaiting processing by this S_LibrarySession.
`protected int` | `m_ExecutionMode` The current execution mode of the session.
`protected S_DirectoryUser` | `m_FeignedUser` The current S_DirectoryUser.
`protected java.lang.Long` | `m_FeignedUserId` The ID of the current S_DirectoryUser.
`protected java.lang.String` | `m_FeignedUserName` The name of the current S_DirectoryUser.
`protected java.lang.String` | `m_FolderPathDelimiter` The delimiter for elements in folder paths (e.g.
`protected java.lang.Long` | `m_Id` The id of this S_LibrarySession.
`protected boolean` | `m_Interrupted` Has the session been interrupted?
`protected java.lang.Boolean` | `m_IsContextEnabled` Remember if context is installed in this schema.
`protected long` | `m_LastOperationTime` The time at which the most-recent DMFoo operation was performed.
`protected LibrarySession` | `m_LibrarySession` The LibrarySession for this S_LibrarySession.
`protected Localizer` | `m_Localizer` The Localizer for this S_LibrarySession.
`protected java.util.Hashtable` | `m_LockedForSessionObjects` The self-hashed ids of the objects for which this S_LibrarySession has acquired a session lock.
`protected OperationDriver` | `m_OperationDriver` The class which drives policy-driven operations.
`protected boolean` | `m_PolicyMode` Is the session in "Policy Mode", indicating that non-settable attributes added to definitions will be honored?
`protected boolean` | `m_PreventSessionTimeouts` Indication as to whether session timeouts are suppressed
`protected S_PrimaryUserProfile` | `m_PrimaryUserProfile` The S_PrimaryUserProfile of m_FeignedUser.
`protected java.lang.Long` | `m_PublicObjectClassId` The id of the PUBLICOBJECT classobject.
`protected java.util.Hashtable` | `m_RegisteredClassEventHandlers` Registered class event handlers (see registerClassEventHandler()).
`protected java.util.Hashtable` | `m_RegisteredEventHandlers` Registered event handlers (see registerEventHandler()).
`protected S_Folder` | `m_RootFolder` The root folder.
`protected java.lang.Long` | `m_SchemaObjectClassId` The id of the SCHEMAOBJECT classobject.
`protected java.util.Hashtable` | `m_SearchCursors` The S_Search objects created by this S_LibrarySession, hashed by cursor sequence.
`protected java.util.HashMap` | `m_SelectorMap` The S_LibraryObjectSelectors for every S_ClassObject, hashed by class id.
`protected S_LibraryService` | `m_Service` The S_LibraryService hosting this S_LibrarySession.
`protected oracle.ifs.server.S_LibraryServiceEventExchanger` | `m_ServiceEventExchanger` The S_LibraryServiceEventExchanger of the S_LibraryService hosting this S_LibrarySession.
`protected long` | `m_SessionCreationTime` The time at which this session was created.
`protected java.util.Stack` | `m_SessionStateStack` A stack of S_SessionStates.
`protected S_LibraryObjectDataSharedStateFactory` | `m_SharedStateFactory` The Shared state factory
`protected java.util.Hashtable` | `m_SSelectors` The S_Selectors created by this S_LibrarySession, hashed by selector sequence.
`protected long` | `m_SSelectorSequence` The last used selector sequence.
`protected java.sql.Statement` | `m_StatementInProgress` The current JDBC statement being executed on beahlf on this session
`protected boolean` | `m_StatementInProgressCancelled` Has the current JDBC statement being executed on beahlf on this session been cancelled?
`protected java.lang.Long` | `m_SystemObjectClassId` The id of the SYSTEMOBJECT classobject.
`protected int` | `m_TemporaryExecutionMode` The temporarily expanded execution mode.
`protected java.util.HashMap` | `m_TemporyDiscoveredAcls` The table used to track discoverability when m_TemporyDiscoveredAclsEnabled is true.
`protected boolean` | `m_TemporyDiscoveredAclsEnabled` Indication if ACL discoverability should be cached in a temporary HashMap.
`protected oracle.ifs.server.S_LibrarySessionTransactionManager` | `m_TransactionManager` The S_LibrarySessionTransactionManager for this S_LibrarySession.
`protected UncommittedLibraryObjectDataCache` | `m_UncommittedLibraryObjectDataCache` The uncommitted S_LibraryObjectData cache for this S_LibrarySession.
`protected UncommittedResolvedAclCache` | `m_UncommittedResolvedAclCache` The uncommitted Resolved ACL cache for this S_LibrarySession.
`protected S_DirectoryUser` | `m_User` The S_DirectoryUser that was authenticated to create this S_LibrarySession.
`protected java.lang.String` | `m_UserName` The name of the S_DirectoryUser that was authenticated to create this S_LibrarySession.
`protected S_UserState` | `m_UserState` The S_UserState (for example, read indication) for m_FeignedUser.

Fields inherited from interface oracle.ifs.common.LibrarySessionInterface
`DEFAULT_CONTENTQUOTA_PROPERTY, DEFAULT_FOLDER_RELATIONSHIP_PROPERTY, EXECUTIONMODE_ADMINISTRATION, EXECUTIONMODE_DISCOVERYADMINISTRATION, EXECUTIONMODE_INSTALLADMINISTRATION, EXECUTIONMODE_PREEXISTING, EXECUTIONMODE_SYSTEMADMINISTRATION, EXECUTIONMODE_USER, FOLDER_PATH_DELIMITER_PROPERTY, PREVENT_SESSION_TIMEOUTS_PROPERTY, UPGRADE_BEHAVIOR_PROPERTY`

Fields inherited from interface oracle.ifs.beans.resources.LibraryConstants
`AUDIT_EVENT_COLUMN_APPLICATIONCONTEXT, AUDIT_EVENT_COLUMN_APPLICATIONUSER, AUDIT_EVENT_COLUMN_AUXILIARYNUMBER, AUDIT_EVENT_COLUMN_AUXILIARYSTRING, AUDIT_EVENT_COLUMN_CREATEDATE, AUDIT_EVENT_COLUMN_CREATORID, AUDIT_EVENT_COLUMN_DOMAINID, AUDIT_EVENT_COLUMN_ID, AUDIT_EVENT_COLUMN_OPERATIONSUCCEEDED, AUDIT_EVENT_COLUMN_OPERATIONTYPE, AUDIT_EVENT_COLUMN_TARGETOBJECTID, AUDIT_SPECIFICATION_CUSTOM, AUDIT_SPECIFICATION_GLOBAL, AUDIT_SPECIFICATION_OBJECT, AUDIT_SUCCESS_MODE_FAILURE_ONLY, AUDIT_SUCCESS_MODE_NONE, AUDIT_SUCCESS_MODE_SUCCESS_ONLY, AUDIT_SUCCESS_MODE_SUCCESS_OR_FAILURE, CAPABILITY_ADDITEM, CAPABILITY_ADDVERSION, CAPABILITY_ADMINISTER_CATEGORY, CAPABILITY_ADMINISTER_CONFIGURATION, CAPABILITY_ADMINISTER_CONTAINER, CAPABILITY_ADMINISTER_DOMAIN, CAPABILITY_ADMINISTER_LOCK, CAPABILITY_ADMINISTER_QUOTA, CAPABILITY_ADMINISTER_RECORD, CAPABILITY_ADMINISTER_ROLE, CAPABILITY_ADMINISTER_SECURITY, CAPABILITY_ADMINISTER_USER, CAPABILITY_ADMINISTER_WORKSPACE, CAPABILITY_COPY, CAPABILITY_CREATECONTAINER, CAPABILITY_CREATEFOLDER, CAPABILITY_CREATEWORKSPACE, CAPABILITY_DELETE, CAPABILITY_DISCOVER, CAPABILITY_GET_CONTENT, CAPABILITY_GETAUDITHISTORY, CAPABILITY_GETMETADATA, CAPABILITY_GETRELATION, CAPABILITY_LOCK, CAPABILITY_MOVE, CAPABILITY_SET_ATTR, CAPABILITY_SET_CONTENT, CAPABILITY_SETMETADATA, CAPABILITY_SETRELATION, EXCEPTION_INFO_AGGREGATE_ENTRIES, EXCEPTION_INFO_CONFLICTING_OBJECT_ID, EXCEPTION_INFO_DESCRIPTION_MAP, EXCEPTION_INFO_LIMIT, EXCEPTION_INFO_OBJECT_ID, EXCEPTION_INFO_PARAMETER_NAME, IFS_DOMAIN_ACCESSCONTROLLIST_BYPASSNAMEUNIQUENESSCHECK, IFS_DOMAIN_ACCESSCONTROLLIST_COMPOSITEACLSUPPORTED, IFS_DOMAIN_ACLINDEX_EVENTTARGET, IFS_DOMAIN_APPLICATION_INITIALIZERCLASSNAME, IFS_DOMAIN_AUDIT_AUDITINGENABLED, IFS_DOMAIN_AUDITING_GLOBALAUDITEVENTEXPIRATIONPERIOD, IFS_DOMAIN_AUDITING_GLOBALAUDITTYPELIST, IFS_DOMAIN_AUDITRULEEVALUATORCLASS, IFS_DOMAIN_CONFIGURATIONCATEGORYDESCRIPTORMAPCLASSNAME, IFS_DOMAIN_CREDENTIALMANAGER_ANONYMOUSUSER, IFS_DOMAIN_CREDENTIALMANAGER_ANONYMOUSUSERNAME, IFS_DOMAIN_CREDENTIALMANAGER_AUTOUSERPROVISIONINGENABLED, IFS_DOMAIN_CREDENTIALMANAGER_IDM, IFS_DOMAIN_CREDENTIALMANAGER_IDM_COUNT_LIMIT, IFS_DOMAIN_CREDENTIALMANAGER_IDM_EXTERNALLY_SUPPORTED_ATTRIBUTES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_DIRECTORY_VENDOR, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_MEMBER_ATTRIBUTES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_NAME_ATTRIBUTE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_OBJECT_CLASSES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_SEARCHBASES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_HOST, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_PORT, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_SSL_ENABLED, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_USER_NAME_ATTRIBUTE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_USER_OBJECT_CLASSES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_USER_SEARCHBASES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_PAGE_SIZE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_SECURITY_PROVIDER_TYPE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_TIME_LIMIT, IFS_DOMAIN_CREDENTIALMANAGER_IDM_XML_FILE_PATH, IFS_DOMAIN_CREDENTIALMANAGER_IDM_XML_REALM, IFS_DOMAIN_CREDENTIALMANAGER_IDMENABLED, IFS_DOMAIN_DEFAULT_TIMEZONE_STRING, IFS_DOMAIN_DEFINITIONCLONINGREQUIRED, IFS_DOMAIN_DIRECTORYGROUP_BYPASSNAMEUNIQUENESSCHECK, IFS_DOMAIN_DOCUMENT_DEFINITIONOBJECTEXPIRATIONPERIOD, IFS_DOMAIN_FDKCONFIGURATIONCLASS, IFS_DOMAIN_FOLDERINDEX_EVENTTARGET, IFS_DOMAIN_LIBRARYOBJECT_AUDITSPECIFICATION_GLOBALAUDITHISTORY, IFS_DOMAIN_LIBRARYOBJECT_AUDITSPECIFICATION_OBJECTAUDITHISTORY, IFS_DOMAIN_LIBRARYOBJECT_CLASSACCESSCONTROLLIST_CLASSPRIVATE, IFS_DOMAIN_LIBRARYOBJECT_CLASSACCESSCONTROLLIST_CLASSPUBLIC, IFS_DOMAIN_LIBRARYOBJECT_CLASSACCESSCONTROLLIST_CLASSRESTRICTCREATION, IFS_DOMAIN_LIBRARYOBJECT_MEDIA_DEFAULTCONTENTMEDIA, IFS_DOMAIN_LIBRARYOBJECT_MEDIA_NONCONTENTMEDIA, IFS_DOMAIN_LIBRARYOBJECT_NODECONFIGURATION_DEFAULTNODECONFIGURATION, IFS_DOMAIN_LIBRARYOBJECT_SERVICECONFIGURATION_DEFAULTSERVICECONFIGURATION, IFS_DOMAIN_LIBRARYOBJECT_STORAGEGROUP_DEFAULTSTORAGEGROUP, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMACCESSCONTROLLIST_PRIVATE, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMACCESSCONTROLLIST_PUBLIC, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMACCESSCONTROLLIST_PUBLISHED, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMLOCKOBJECT_SYSTEMHARDLOCK, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMLOCKOBJECT_SYSTEMSOFTLOCK, IFS_DOMAIN_LOCALIZER_DEFAULTEXTENDEDRESOURCEBUNDLENAMES, IFS_DOMAIN_LOCKOBJECT_ENABLED, IFS_DOMAIN_LOOKUP_CLUSTERING_PROPERTIES, IFS_DOMAIN_LOOKUP_CUSTOMLOCKTYPES, IFS_DOMAIN_LOOKUP_ORACLELOCKTYPES, IFS_DOMAIN_LOOKUP_SORTOBJECTCOLLECTION, IFS_DOMAIN_OIDCREDENTIALMANAGERAGENT_SUBSCRIBERS, IFS_DOMAIN_OPERATIONACTIONSPECIFICATION_GLOBALLIST, IFS_DOMAIN_PROPERTYBUNDLE_NAME, IFS_DOMAIN_PROTOCOLS_DAV_COPYMOVETHROUGHFOLDERLINKENABLED, IFS_DOMAIN_PROTOCOLS_DAV_NULLRESOURCELOCKEXPIRATIONPERIOD, IFS_DOMAIN_PROTOCOLS_DAV_USERAGENTS, IFS_DOMAIN_RANDOMACCESSOR_EXPIRATIONPERIOD, IFS_DOMAIN_SEARCH_ATTEMPTCONTEXTSEARCHREWRITE, IFS_DOMAIN_SECURITY_SYNCHRONOUSSECURITYREFRESHENABLED, IFS_DOMAIN_SHAREDSTATEFACTORY, IFS_DOMAIN_UPGRADEINPROGRESS, IFS_DOMAIN_WORKFLOW_BPEL_CREATIONENABLED, IFS_DOMAIN_WORKFLOW_BPEL_WORKLISTURL, IFS_DOMAIN_WORKFLOW_ENABLED, IFS_DOMAIN_WORKFLOW_SCHEMANAME, IFS_DOMAIN_WS_CLEARTEXTAUTHENTICATIONREQUIRESHTTPS, IFS_HANDLER_PROPERTY_BASETIMEOFDAY, IFS_HANDLER_PROPERTY_NOTIFIEDONEVENT, IFS_HANDLER_PROPERTY_TIMERPERIOD, IFS_NODE_DISABLEDINHERITEDPROPERTYNAMES, IFS_NODE_DISABLEDINHERITEDSERVERNAMES, IFS_NODE_ENABLEDINHERITEDPROPERTYNAMES, IFS_NODE_ENABLEDINHERITEDSERVERNAMES, IFS_ORACLELOCKTYPE_KEY_CHECKOUT, IFS_ORACLELOCKTYPE_KEY_DAV, IFS_ORACLELOCKTYPE_KEY_FINALIZED, IFS_ORACLELOCKTYPE_KEY_FREEZE, IFS_ORACLELOCKTYPE_KEY_HASRECORD, IFS_ORACLELOCKTYPE_KEY_LIFECYCLE, IFS_ORACLELOCKTYPE_KEY_MANUAL, IFS_ORACLELOCKTYPE_KEY_NAMEDFREEZE, IFS_ORACLELOCKTYPE_KEY_RECORD, IFS_ORACLELOCKTYPE_KEY_RETENTION, IFS_ORACLELOCKTYPE_KEY_WORKFLOW, IFS_SERVICE_ACLCACHE_EMERGENCYTRIGGER, IFS_SERVICE_ACLCACHE_NORMALTRIGGER, IFS_SERVICE_ACLCACHE_PURGETARGET, IFS_SERVICE_ACLCACHE_SIZE, IFS_SERVICE_ACLCACHE_URGENTTRIGGER, IFS_SERVICE_AUDITCERTIFICATECACHE_PURGETARGET, IFS_SERVICE_AUDITINGENABLED, IFS_SERVICE_AUDITSTRINGCACHE_PURGETARGET, IFS_SERVICE_AURORASERVICE, IFS_SERVICE_CASESENSITIVEAUTHENTICATION, IFS_SERVICE_CHECKFORORPHANSESSIONSPERIOD, IFS_SERVICE_CONNECTIONPOOL_READONLY_MAXIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_READONLY_MAXIMUMSIZETIMEOUT, IFS_SERVICE_CONNECTIONPOOL_READONLY_MINIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_READONLY_STATEMENTCACHESIZETRIGGER, IFS_SERVICE_CONNECTIONPOOL_READONLY_STATEMENTCACHETARGET, IFS_SERVICE_CONNECTIONPOOL_READONLY_STATEMENTRESETLIMIT, IFS_SERVICE_CONNECTIONPOOL_READONLY_TARGETSIZE, IFS_SERVICE_CONNECTIONPOOL_READONLY_TARGETSIZETIMEOUT, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_MAXIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_MAXIMUMSIZETIMEOUT, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_MINIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_STATEMENTCACHESIZETRIGGER, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_STATEMENTCACHETARGET, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_STATEMENTRESETLIMIT, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_TARGETSIZE, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_TARGETSIZETIMEOUT, IFS_SERVICE_CONTENTBUFFERSIZE, IFS_SERVICE_CREDENTIALMANAGER, IFS_SERVICE_CREDENTIALMANAGER_CREDENTIALNAMETOKENIZER, IFS_SERVICE_CREDENTIALMANAGER_NAMES, IFS_SERVICE_DATACACHE_EMERGENCYTRIGGER, IFS_SERVICE_DATACACHE_NORMALTRIGGER, IFS_SERVICE_DATACACHE_PURGETARGET, IFS_SERVICE_DATACACHE_SIZE, IFS_SERVICE_DATACACHE_URGENTTRIGGER, IFS_SERVICE_DEFAULTCHARACTERSET, IFS_SERVICE_DEFAULTLANGUAGE, IFS_SERVICE_EVENTEXCHANGER, IFS_SERVICE_EVENTSTATEMENTRESETLIMIT, IFS_SERVICE_JDBC_DEFAULTROWPREFETCH, IFS_SERVICE_JDBC_DRIVER, IFS_SERVICE_JDBC_DRIVERTYPE, IFS_SERVICE_JDBC_TRACINGENABLED, IFS_SERVICE_LOCKTIMEOUTPERIOD, IFS_SERVICE_MAXIMUMCONCURRENTSESSIONS, IFS_SERVICE_MAXIMUMPOOLEDCONTENTBUFFERSPERSESSION, IFS_SERVICE_ORPHANSESSIONTIMEOUTPERIOD, IFS_SERVICE_POLLFOREVENTSFROMOTHERSERVICESPERIOD, IFS_SERVICE_QUOTACHECKFREQUENCYINBYTES, IFS_SERVICE_SERVICEKEEPALIVEEVENTPERIOD, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_SIZE, IFS_SERVICE_SESSION_BEANSSESSION, IFS_SERVICE_SESSION_DATACACHE_EMERGENCYTRIGGER, IFS_SERVICE_SESSION_DATACACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_DATACACHE_PURGETARGET, IFS_SERVICE_SESSION_DATACACHE_SIZE, IFS_SERVICE_SESSION_DATACACHE_URGENTTRIGGER, IFS_SERVICE_SESSION_DEFAULTSEARCHTIMEOUTPERIOD, IFS_SERVICE_SESSION_EVENTPOLLER, IFS_SERVICE_SESSION_EVENTPOLLERPERIOD, IFS_SERVICE_SESSION_FOLDERITEM_CACHING_ENABLED, IFS_SERVICE_SESSION_FOLDERPATHCACHE_ENABLED, IFS_SERVICE_SESSION_FOLDERPATHCACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_FOLDERPATHCACHE_PURGETARGET, IFS_SERVICE_SESSION_FOLDERPATHCACHE_SIZE, IFS_SERVICE_SESSION_FOLDERPATHCACHE_URGENTTRIGGER, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_EMERGENCYTRIGGER, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_ISUNBOUNDED, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_PURGETARGET, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_SIZE, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_URGENTTRIGGER, IFS_SERVICE_SESSION_SERVERSESSION, IFS_SERVICE_SESSION_TRANSACTIONSTACKSIZE, IFS_SERVICE_SESSIONOPERATIONTIMEOUTPERIOD, IFS_SERVICE_TRACING_BEANSSESSIONTRACETYPE, IFS_SERVICE_TRACING_CHANNELCOUNT, IFS_SERVICE_TRACING_CHANNELLEVEL, IFS_SERVICE_TRACING_DEFAULTTRACELEVEL, IFS_SERVICE_TRACING_SERVERSESSIONTRACETYPE, IFS_SERVICE_TRACING_SERVICETRACETYPE, IFS_SERVICE_TRANSPORTBATCHSIZE, IFS_SERVICE_TRANSPORTEVENTSTOOTHERSERVICESPERIOD, IFS_SESSIONSTATE_APPLICATION_SESSIONID, IFS_SESSIONSTATE_AUDIT_DOMAIN_DEFAULT, IFS_SESSIONSTATE_OPERATIONS_COPYTABLE, IFS_SESSIONSTATE_OPERATIONS_FREETABLE, IFS_SESSIONSTATE_OPERATIONS_UPDATETABLE, LOCKTYPE_CHECKOUT, LOCKTYPE_CUSTOM, LOCKTYPE_DAV, LOCKTYPE_FAMILYHASRECORD, LOCKTYPE_FINALIZED, LOCKTYPE_FREEZE, LOCKTYPE_HAS_RECORD, LOCKTYPE_LIFECYCLE, LOCKTYPE_MANUAL, LOCKTYPE_NAMEDFREEZE, LOCKTYPE_RECORD, LOCKTYPE_RETENTION, LOCKTYPE_WORKFLOW, PUBLIC_SESSIONSTATE_APPLICATION_CONTEXT, PUBLIC_SESSIONSTATE_APPLICATION_USERIDENTIFER, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_CHECKOUT, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_DAV, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_FINALIZED, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_FREEZE, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_HASRECORD, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_LIFECYCLE, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_MANUAL, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_NAMEDFREEZE, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_RECORD, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_RETENTION, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_WORKFLOW, SYSTEMLOCK_NAME_FINALIZED, SYSTEMLOCK_NAME_FREEZE, SYSTEMLOCK_NAME_HAS_RECORD, SYSTEMLOCK_NAME_LIFECYCLE, SYSTEMLOCK_NAME_RECORD, SYSTEMLOCK_NAME_RETENTION`

Constructor Summary
`protected` | `S_LibrarySession(S_LibraryService service)` Constructs an unauthenticated S_LibrarySession.

Method Summary
`void` | `abortImplicitTransaction(Transaction transaction)` Aborts an implicit transaction.
`void` | `abortTransaction(Transaction transaction)` Aborts a transaction.
`void` | `abortTransaction(Transaction transaction, IfsException originalException)` Aborts a transaction in response to the specified IfsException.
`java.sql.Connection` | `acquireAuxiliaryConnection()` Acquires an auxiliary Connection for use by this S_LibrarySession.
`LibraryConnection` | `acquireAuxiliaryLibraryConnection()` Acquires an auxiliary LibraryConnection for use by this S_LibrarySession.
`protected void` | `addLockedForSessionObject(java.lang.Long objid)` Adds the specified S_PublicObject to this S_LibrarySession's internal table of session-locked objects.
`protected void` | `addLockedForSessionObject(S_PublicObject obj)` Adds the specified S_PublicObject to this S_LibrarySession's internal table of session-locked objects.
`protected S_LibraryObjectSelector` | `addSelectorToHashMap(java.lang.Long classId)` Creates an S_LibraryObjectSelector for the specified classobject and adds it to the hashtable of S_LibraryObjectSelectors.
`protected void` | `addSSelector(S_Selector sel)` Add the specified S_Selector to the set of S_Selectors for this S_LibrarySession.
`Transaction` | `beginImplicitReadonlyTransaction()` Starts a readonly transaction implicitly at the beginning of an operation.
`Transaction` | `beginImplicitTransaction()` Starts a writeable transaction implicitly at the beginning of an operation.
`Transaction` | `beginReadonlyTransaction()` Starts a readonly transaction.
`Transaction` | `beginTransaction()` Starts a writeable transaction.
`Transaction` | `beginTransaction(boolean writeable)` Starts a transaction.
`protected void` | `clearPreparedInsertStatement(java.sql.PreparedStatement stmt, S_ClassObjectData clssdef)` Clears all bind variables of the specified INSERT statement for the specified classobject.
`protected void` | `clearValueInStatement(java.sql.PreparedStatement stmt, int position, int datatype)` Clears the value of a bind variable in the specified PreparedStatement.
`void` | `commit()` Makes all pending changes for all in-progress Transactions for this S_LibrarySession visible to all other S_LibrarySessions.
`void` | `completeImplicitTransaction(Transaction transaction)` Completes an implicit transaction.
`void` | `completeTransaction(Transaction transaction)` Completes a transaction.
`protected S_LibraryObject` | `constructLibraryObject(java.lang.Long class_id)` Constructs a new, non-persistent S_LibraryObject.
`protected S_LibraryObject` | `constructLibraryObject(S_LibraryObjectData data)` Constructs an S_LibraryObject for the specified S_LibraryObjectData.
`protected S_LibraryObjectData` | `constructLibraryObjectData(S_LibraryObjectSelector sel, java.lang.Long id)` Construct an S_LibraryObjectData by singleton-selecting the specified object using the specified S_LibraryObjectSelector.
`protected OperationDriver` | `constructOperationDriver()` Constructs an OperationDriver instance to be used to drive a policy-driven operation.
`protected S_LibraryObjectDataSharedState` | `constructSharedState()` Returns a newly constructed shared state instance of the proper type.
`protected S_LibraryObjectCursor` | `createLibraryObjectCursor(LibraryQueryStatement lstmt, java.sql.ResultSet resultSet, S_LibraryObjectSelector selector)` Creates a S_LibraryObjectCursor.
`AttributeValue` | `createPublicObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef)` Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition within an OperationState context.
`AttributeValue` | `createSchemaObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef)` Creates a new S_SchemaObject based on the specified S_LibraryObjectDefinition within an OperationState context.
`AttributeValue` | `createSystemObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef)` Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition within an OperationState context.
`protected AttributeValue` | `createVersionedPublicObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef)` Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition within an OperationState context.
`void` | `deleteExpiredAuditFolderPaths(long expPeriod)` Delete any expired Audit folder paths, that have expired longer than the specified period.
`void` | `deleteExpiredGlobalAuditEvents(java.lang.Long domainId, java.lang.Long specId, java.lang.Long expPeriod)` Delete any expired global audit events.
`protected void` | `deleteRepositoryParameter(java.lang.String name)` Deletes the specified repository parameter.
`void` | `deleteUnusedAuditFolderPathOverflowEntries()` Delete any unused overflow entries for Audit folder paths.
`void` | `deleteUnusedAuditProperties()` Delete any unreferenced Audit event properties.
`void` | `deregisterClassEventHandler(S_ClassObject co, boolean includeSubclasses, IfsEventHandler handler)` Deregisters the specified IfsEventHandler for the specified class.
`void` | `deregisterCollection(Collection collection, java.lang.String classname)` Deregisters a collection, cancelling the event registration.
`void` | `deregisterEventHandler(S_LibraryObject lo, IfsEventHandler handler)` Deregisters the specified IfsEventHandler for the specified S_LibraryObject.
`protected void` | `destroyOperationDriver()` Destroys the current OperationDriver and nulls the reference to it.
`protected void` | `disconnect()` Disconnects this S_LibrarySession.
`S_LibraryObject` | `discoverLibraryObject(java.lang.Long id)` Gets an S_LibraryObject by ID, without knowing the class ID.
`S_LibraryObject` | `discoverLibraryObject(java.lang.Long id, java.lang.Long classId)` Gets an S_LibraryObject by ID and classId.
`S_PublicObject` | `discoverPublicObject(java.lang.Long id)` Gets an S_PublicObject by id.
`void` | `DMAbortTransaction(Transaction transaction)` Aborts a transaction.
`S_LibraryObjectData` | `DMaddAccessControlEntry(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition sdef)` Adds an S_AccessControlEntry to the specified S_AccessControlList.
`java.lang.Long` | `DMAddAttributeToClassObject(java.lang.Long id, S_LibraryObjectDefinition def)` Adds an attribute to an existing classobject.
`void` | `DMAddFolderRelationship(java.lang.Long id, java.lang.Long classid, S_LibraryObjectDefinition rdef)` Adds an item to the specified S_Folder.
`void` | `DMAddMembersToDirectoryGroup(java.lang.Long group_id, java.lang.Long classid, java.lang.Long[] rightObjIds, java.lang.Long[] rightObjClassids)` Adds the specified S_DirectoryObjects to the specified S_DirectoryGroup.
`void` | `DMAddMemberToDirectoryGroup(java.lang.Long group_id, java.lang.Long classid, java.lang.Long member_id, java.lang.Long memberClassid)` Adds the specified S_DirectoryObject to the specified S_DirectoryGroup.
`S_LibraryObjectData` | `DMAddRelationship(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition rdef)` Adds a relationship for the specified S_PublicObject.
`void` | `DMAddToFolder(java.lang.Long folder_id, java.lang.Long classid, java.lang.Long rightObj, java.lang.Long rightObjClassid)` Adds the specified item to the specified S_Folder.
`void` | `DMApplyAclIndexDeferredUpdate(AccessControlListDeferredUpdate entry, boolean deleteAfterProcessing)` Forces re-calculation of an ACL's discoverer table.
`void` | `DMApplyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry)` Applies a deferred update to the Folder index
`Transaction` | `DMBeginTransaction(boolean writeable)` Starts a transaction.
`void` | `DMCalculateConsumedStorage(java.lang.Long quotaid, java.lang.Long classid)` Recalculates consumed storage for the specified S_ContentQuota.
`void` | `DMCancelOperation()` Cancel any server-side operation in progress for this session.
`boolean` | `DMCheckExistenceOfPublicObjectByPath(java.lang.Long folder_id, java.lang.Long classid, java.lang.String path)` Checks whether there exists an S_PublicObject at a path relative to a specified S_Folder.
`void` | `DMCloseFolder(java.lang.Long folder_id, java.lang.Long classid)` Closes the specified S_Folder.
`void` | `DMCloseSearch(java.lang.Long srchId)` Closes the specified S_Search.
`void` | `DMCloseSelector(long selId)` Closes the specified selector.
`void` | `DMCommit()` Makes all pending changes for all in-progress Transactions for this S_LibrarySession visible to all other S_LibrarySessions.
`void` | `DMCompleteTransaction(Transaction transaction)` Completes a transaction.
`S_LibraryObjectData` | `DMConvertToPrivateACL(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition sdef)` Makes the specified S_PublicObject have a private S_AccessControlList.
`S_LibraryObjectData` | `DMCopyLibraryObject(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition sdef)` Copies the specified S_LibraryObject.
`S_LibraryObjectData` | `DMCreateDefaultPolicyPropertyBundle(java.lang.Long id, java.lang.Long classId)` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`S_LibraryObjectData` | `DMCreateDefaultPropertyBundle(java.lang.Long id, java.lang.Long classId)` Creates a default PropertyBundle.
`void` | `DMCreateRetainedEventDatabaseObjects(RetainedEvent event)` Create tables associated with a RetainedEvent type
`void` | `DMCreateView(ViewSpecification vsp)` Creates a view for the specified ViewSpecification.
`void` | `DMDelete(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition def)` Deletes the specified S_PublicObject.
`void` | `DMDeleteAclIndexDeferredUpdates(java.lang.Long[] ids)` deletes a set of Deferred ACL Resolution Entries
`void` | `DMDeleteRepositoryParameter(java.lang.String name)` Deletes the specified repository parameter.
`void` | `DMDeleteRetainedEvent(RetainedEvent event)` Delete a RetainedEvent
`oracle.sql.ORAData` | `DMDequeueMessage(java.lang.Long id, java.lang.Long classId, java.lang.String subscriberName)` Dequeues a message from the specified queue as the specified subscriber.
`oracle.sql.ORAData` | `DMDequeueMessageFromExceptionQueue(java.lang.Long id, java.lang.Long classId)` Dequeues a message from the specified exception queue.
`void` | `DMDeregisterClassEventHandler(java.lang.Long classId)` Receive notification that the bean-side has de-registered all event handlers for the specified ClassObject.
`void` | `DMDeregisterEventHandler(java.lang.Long id)` Receive notification that the bean-side has de-registered all event handlers for the specified object.
`void` | `DMDeregisterServiceEventHandler(IfsEventHandler handler)` De-register a Service event handler.
`void` | `DMDisconnect()` Disconnects this S_LibrarySession.
`void` | `DMDisposeSearch(java.lang.Long srchId)` Disposes the specified S_Search.
`void` | `DMDropRetainedEventDatabaseObjects(RetainedEvent event)` Drop tables associated with a RetainedEvent type
`void` | `DMEmptyWastebasket()` Empties the user's (or feigned user's, if applicable) wastebasket.
`void` | `DMEnqueueMessage(java.lang.Long id, java.lang.Long classId, oracle.sql.ORAData message)` Enqueues the message on the specified queue.
`void` | `DMEnqueueMessage(java.lang.Long id, java.lang.Long classId, oracle.sql.ORAData message, java.lang.String correlation)` Enqueues the message on the specified queue.
`void` | `DMFeignUser(java.lang.Long id, java.lang.Long classid)` Feigns the specified S_DirectoryUser.
`java.lang.Long[]` | `DMfetchACEs(java.lang.Long id, java.lang.Long classId)` Gets the S_AccessControlEntries for the specified S_AccessControlList.
`java.util.Vector` | `DMFetchPolicyListElements(java.lang.Long policyListId, java.lang.Long policyListClassId)` Gets the PolicyListElements for the specified PolicyList.
`java.util.Vector` | `DMFetchProperties(java.lang.Long propBundleId, java.lang.Long propClassId)` Gets the S_Properties for the specified S_PropertyBundle.
`java.lang.Long[]` | `DMfetchRevisions(java.lang.Long id, java.lang.Long classid)` Gets the S_VersionDescription IDs for the specified S_VersionSeries.
`java.lang.Long[]` | `DMfetchVersionSerieses(java.lang.Long id, java.lang.Long classid)` Gets the S_VersionSeries for the specified S_Family.
`void` | `DMFilterContent(java.lang.Long id, java.lang.Long classId, boolean plaintext, java.lang.Long refObjId, java.lang.Long refObjClassId)` Filters the specified S_ContentObject.
`void` | `DMFilterDeletedObjects(boolean mode)` Deprecated. iFS 9.0.3 Has no effect
`S_LibraryObjectData` | `DMFindPublicObjectByPath(java.lang.Long folder_id, java.lang.Long classid, java.lang.String path)` Finds an S_PublicObject by its path relative to a specified S_Folder.
`void` | `DMFlushEvents()` Flushes any outgoing events in event exchanger.
`boolean` | `DMFolderHasSubFolders(java.lang.Long folder_id, java.lang.Long classid)` Returns true if the folder has subfolders.
`void` | `DMForceReadEvents()` Forces incoming events from the event exchanger to be processed.
`void` | `DMFree(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition def)` Frees the specified S_LibraryObject.
`void` | `DMGenerateSummary(java.lang.Long id, java.lang.Long classId, java.lang.String pointOfView, long sizeAsPercent, long sizeAsNumParagraphs, java.lang.String summaryLevel, java.lang.Long refObjId, java.lang.Long refObjClassId)` Generates a summary of the specified S_ContentObject.
`void` | `DMGenerateThemes(java.lang.Long id, java.lang.Long classId, boolean fullThemes, java.lang.Long refObjId, java.lang.Long refObjClassId)` Generates the themes of the specified S_ContentObject.
`AccessLevel` | `DMGetAccessLevel(java.lang.Long id, java.lang.Long classId, java.lang.Long userId)` Gets the AccessLevel of the specified S_DirectoryUser for the specified S_AccessControlList.
`java.util.Vector` | `DMGetAclIndexDeferredUpdates(int maxItems)` gets a set of Deferred ACL Resolution Entries
`java.lang.Long[]` | `DMGetAllAncestorsOfDirectoryObject(java.lang.Long id, java.lang.Long classid)` Gets all ancestors of the specified S_DirectoryGroup.
`java.lang.String[]` | `DMGetAllFolderPaths(java.lang.Long id, java.lang.Long classid, java.lang.Long folderRefId, java.lang.Long folderRefClassid, FolderPathOptions fpo, SortSpecification sort)` Return all reachable folder paths to an object, or null if there is no reachable path.
`java.lang.Long[]` | `DMGetAllMembersOfDirectoryGroup(java.lang.Long id, java.lang.Long classid, boolean filterForDiscoverability)` Gets all members of the specified S_DirectoryGroup.
`java.lang.String` | `DMGetAnyFolderPath(java.lang.Long id, java.lang.Long classid, java.lang.Long folderRefId, java.lang.Long folderRefClassid, FolderPathOptions fpo, SortSpecification sort)` Return a folder path to an object, or null if there is no reachable path.
`java.util.Vector` | `DMGetArrayReferencingObjects(java.lang.Long attributeId, AttributeValue referencedValue, SortSpecification sort)` Gets the set of object data for objects that are instances of the class on which the specified Attribute is defined, and whose array value contains the specified referenced value.
`AttributeValue` | `DMGetArrayTypeAttributeValue(long objectId, long attributeId, long auditId, int count)` Gets a fully resolved array-type AttributeValue with non-transient elements for the the specified object/attribute combination.
`long` | `DMGetAttributesRsn()` Gets the attributes RSN of the service.
`AuditCertificate[]` | `DMGetAuditCertificates(java.lang.Long[] objectIds)` Select AuditCertificates for the specified object IDs.
`AttributeValue[]` | `DMGetAuditTypesForClass(java.lang.String className, boolean includeNested)` Gets the audit operation type values for a specified class name, optionally including any types that are applicable to a class that is considered a descendent of the specified class.
`AttributeValue[]` | `DMGetAuditTypesForCreateOperations()` Gets the audit operation type values that correspond to "CREATED" operations.
`AttributeValue[]` | `DMGetAuditTypesForFreeOperations()` Gets the audit operation type values that correspond to "FREED" operations.
`java.lang.Long[]` | `DMGetCategoryIds(java.lang.Long id, java.lang.Long classid)` Gets all category IDs for the specified S_PublicObject or S_SystemObject or S_SchemaObject For publicobjects, it returns only the set of ID's that represents Categories that the current session can discover (which in general should always be all of the categories, since the ACL of the Category should always be the same as the PO).
`java.lang.Long` | `DMGetClockOffset()` Gets the clock offset, representing the number of milliseconds the DBMS clock is ahead of this mid tier.
`java.lang.Long[]` | `DMGetCompositeAclIds(java.lang.Long id, java.lang.Long classid, SortSpecification sort)` Gets the set of composite ACLs which reference the target ACL as a "component".
`long` | `DMGetConsumedStorage(java.lang.Long id, java.lang.Long classid)` Returns the storage (in bytes) consumed by a given public object.
`RandomAccessor` | `DMGetContentByRandomAccess(java.lang.Long coId, java.lang.Long coClassId, java.lang.Long refObjId, java.lang.Long refObjClassId)` Gets a RandomAccessor for randomly reading the content of the specified ContentObject.
`ContentStreamSerializer` | `DMGetContentReader(java.lang.Long id, java.lang.Long classId, java.lang.Long refObjId, java.lang.Long refObjClassId)` Gets the content of the specified S_ContentObject as a reader.
`ContentStreamSerializer` | `DMGetContentStream(java.lang.Long id, java.lang.Long classId, java.lang.Long refObjId, java.lang.Long refObjClassId)` Fetches a ContentStream encapulated in a ContentStreamSerializer for the given ContentObject.
`AttributeValue[]` | `DMGetCustomAuditTypes()` Gets the custom audit operation type values.
`java.lang.Long[]` | `DMGetDirectAncestorsOfDirectoryObject(java.lang.Long id, java.lang.Long classid)` Gets the direct ancestors of the specified S_DirectoryGroup.
`java.lang.Long[]` | `DMGetDirectMembersOfDirectoryGroup(java.lang.Long id, java.lang.Long classid, boolean filterForDiscoverability)` Gets the direct members of the specified S_DirectoryGroup.
`S_LibraryObjectData` | `DMGetDirectoryUserData()` Gets the S_LibraryObjectData for the current S_DirectoryUser for this S_LibrarySession.
`java.lang.Long[]` | `DMGetDiscoverabilityOfPublicObjectsIds(java.lang.Long[] ids)` Return indication as to which PublicObject objects specified (by ID) the current user can discover.
`java.util.Vector` | `DMGetEffectiveClassPolicyListElements(java.lang.Long id, java.lang.Long classId, java.lang.String operation)` Gets the set of policies, as PolicyListElement ids, implicitly applied to all instances of the specified ClassObject for the specified operation.
`java.util.Vector` | `DMGetEffectivePolicyListElements(java.lang.Long id, java.lang.Long classId, java.lang.String operation)` Gets the set of policies, as PolicyListElement ids, applied to the specified LibraryObject, either explicitly (through its PolicyLists) or implicitly (through the ClassPolicyLists of its classobject hierarchy) for the specified operation.
`java.lang.String` | `DMGetEncryptedRepositoryParameter(java.lang.String name)` Gets the value of the specified repository parameter.
`java.util.Vector` | `DMGetExpiredTimedLocks(int maxItems, int offset)` Get a set of timed out locks, bounded in size by the max count specified.
`ContentStreamSerializer` | `DMGetFilteredContent(java.lang.Long id, java.lang.Long classId, java.lang.Long refObjId, java.lang.Long refObjClassId)` Gets the filtered content for the specified S_ContentObject as as reader.
`java.util.Vector` | `DMGetFolderIndexDeferredUpdates(int maxItems)` gets a set of Deferred Folder index updates
`long` | `DMGetFolderItemCount(java.lang.Long id, java.lang.Long classId, java.lang.String folderRelClassname)` Gets the number of items in the specified S_Folder.
`java.lang.Long[]` | `DMGetFolderItemList(java.lang.Long folder_id, java.lang.Long classid, SortSpecification sort)` Gets the item IDs in the specified Folder.
`java.lang.Long[]` | `DMGetFolderReferences(java.lang.Long PublicObject_id, java.lang.Long classid, SortSpecification sort)` Gets the S_Folders that contain the specified S_PublicObject.
`long` | `DMGetHighestAuditId()` Get the highest Audit Id in use.
`java.lang.Long[]` | `DMGetIdsForNewObjects(int length)` Returns a set of objects that can be used to import new objects.
`java.util.Date` | `DMGetLastAccessDate(java.lang.Long id, java.lang.Long classId)` Gets when the content of a ContentObject was most recently written or read.
`java.util.Vector` | `DMGetLeftwardRelationshipObjects(java.lang.Long id, java.lang.Long classId, java.lang.Long relClassId, SortSpecification sort)` Gets the target objects of the leftward relationships for the specified S_PublicObject.
`java.util.Vector` | `DMGetLeftwardRelationships(java.lang.Long id, java.lang.Long classId, java.lang.Long relClassId, SortSpecification sort)` Gets the leftward relationships for the specified S_PublicObject.
`long` | `DMGetLeftwardRelationshipsCount(java.lang.Long id, java.lang.Long classId, java.lang.Long relClassId)` Gets the number of leftward relationships for the specified S_PublicObject.
`S_LibraryObjectData` | `DMgetLibraryObjectData(java.lang.Long id, java.lang.Long classId, java.lang.String attributeName, boolean selectFully)` Gets the S_LibraryObjectData for the specified id and class id.
`java.lang.Long[]` | `DMGetLinks(java.lang.Long id, java.lang.Long classid)` Gets the Links for the specified PublicObject.
`java.util.Vector` | `DMGetLockedForSessionObjects()` Gets the objects in this S_LibrarySession's internal table of session-locked objects.
`java.lang.String` | `DMGetNLSDatabaseParameterValue(java.lang.String parameter)` Gets the value for the specified NLS database parameter.
`java.io.Serializable` | `DMGetObjectReferenceAttribute(java.lang.Long id, java.lang.Long classId, java.lang.String attrName)` Gets the value of the specified object-reference type attribute.
`S_LibraryObjectData` | `DMGetOurPrimaryUserProfile()` Gets the S_PrimaryUserProfile of current S_DirectoryUser for this S_LibrarySession.
`java.lang.Long` | `DMGetPartitionValue(java.lang.Long id, java.lang.Long classId)` Gets the partition value of a ContentObject.
`int` | `DMGetPreparedSelectorItemCount(java.lang.String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, java.lang.String searchDefinition, boolean recursive, java.lang.String hint, AttributeValue[] bindValues)` Constructs an S_PreparedSelector and gets its item count.
`S_LibraryObjectData` | `DMGetPrimaryUserProfile(java.lang.Long id)` Gets the S_PrimaryUserProfile of the specified S_DirectoryUser.
`AttributeValue` | `DMGetProperty(java.lang.Long propBundleId, java.lang.Long propClassId, java.lang.String propertyName)` Gets the property value from the property bundle.
`S_LibraryObjectData` | `DMGetPublicObjectData(java.lang.Long id, java.lang.Long classId)` Gets the S_LibraryObjectData for the specified S_PublicObject.
`java.util.Vector` | `DMGetPublicObjectsReferringToLockObject(java.lang.Long id, java.lang.Long classid, SortSpecification sort)` Gets the PO's that reference this LockObject
`java.lang.String` | `DMGetRepositoryParameter(java.lang.String name)` Gets the value of the specified repository parameter.
`java.lang.String[]` | `DMGetRepositoryParameterNames(java.lang.String prefix)` Gets the repository parameter names that start with the specified prefix.
`S_ClassObjectData` | `DMGetResolvedClassObjectData(java.lang.Long id)` Gets the fully-resolved S_ClassObjectData.
`RetainedEvent[]` | `DMGetRetainedEvents(RetainedEvent event, int maxItems)` Select RetainedEvents
`java.util.Vector` | `DMGetRightwardRelationshipObjects(java.lang.Long id, java.lang.Long classId, java.lang.Long relClassId, SortSpecification sort)` Gets the target objects of the rightward relationships for the specified S_PublicObject.
`java.util.Vector` | `DMGetRightwardRelationships(java.lang.Long id, java.lang.Long classId, java.lang.Long relClassId, SortSpecification sort)` Gets the rightward relationships for the specified S_PublicObject.
`S_LibraryObjectData` | `DMGetSchemaObjectData(java.lang.Long id, java.lang.Long classId)` Gets the S_LibraryObjectData for the specified S_SchemaObject.
`int` | `DMgetSearchItemCount(java.lang.Long srchId, java.util.Vector bindValues, java.lang.String language, int timeout)` Gets the item count for the specified S_Search.
`SearchSpecification` | `DMGetSearchSpecification(java.lang.Long srchId)` Gets the SearchSpecification of the specified S_Search.
`java.lang.String` | `DMgetSearchSQLString(java.lang.Long srchId)` Gets the SQL string for the specified S_Search.
`long` | `DMGetSelectorItemCount(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive)` Constructs an S_Selector and gets its number of items.
`java.util.Hashtable` | `DMGetServiceConfigurationProperties()` Gets the service properties.
`java.lang.Long` | `DMGetServiceId()` Gets the id of the S_LibraryService hosting this S_LibrarySession.
`int[]` | `DMGetServiceTraceLoggerLevels()` Gets the trace levels of the S_LibraryServiceTraceLogger.
`java.lang.Long` | `DMGetSessionId()` Gets the id of this S_LibrarySession.
`int[]` | `DMGetSessionTraceLoggerLevels()` Gets the trace levels of the S_LibrarySessionTraceLogger.
`S_LibraryObjectDefinition` | `DMGetSLibraryObjectDefinition(java.lang.Long id, java.lang.Long classId)` Generates an S_LibraryObjectDefinition for the specified S_LibraryObject.
`long` | `DMGetSubfolderCount(java.lang.Long id, java.lang.Long classId, java.lang.String folderRelClassname)` Gets the number of folders in the specified S_Folder.
`ContentStreamSerializer` | `DMGetSummary(java.lang.Long id, java.lang.Long classId, java.lang.String pointOfView, java.lang.Long refObjId, java.lang.Long refObjClassId)` Gets the summary of the specified S_ContentObject as as reader.
`S_LibraryObjectData` | `DMGetSystemObjectData(java.lang.Long id, java.lang.Long classId)` Gets the S_LibraryObjectData for the specified S_SystemObject.
`ContextTheme[]` | `DMGetThemes(java.lang.Long id, java.lang.Long classId, java.lang.Long refObjId, java.lang.Long refObjClassId)` Gets the themes of the specified S_ContentObject.
`int` | `DMGetTotalFolderItemCount(java.lang.Long folder_id, java.lang.Long classid)` Gets the count of items in a folder, including undiscoverable items.
`long` | `DMGetWastebasketSelectorItemCount(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive)` Constructs a wastebasket S_Selector and gets its number of items.
`void` | `DMGrantAdmin(java.lang.Long userid)` Grants administration privilege to the specified S_DirectoruUser.
`void` | `DMHandleAuditEventDispatchRequests(java.util.ArrayList reqList, java.lang.String tableName)` Handle a list of AuditEvent dispatch requests.
`void` | `DMInsertRetainedEvent(RetainedEvent event)` Add a retained event
`void` | `DMIntegrateIntoVersionSeries(java.lang.Long sid, java.lang.Long sclassId, java.lang.Long tid, java.lang.Long tclassId)` Integrates an S_VersionSeries at a specified S_VersionDescription into a second S_VersionSeries at that series's latest S_VersionDescription, creating a new S_BranchRelationship.
`void` | `DMInvalidateTokenCredentials(java.lang.Long userId)` Invalidates all the token credentials for a given user.
`java.lang.Object` | `DMInvokeOperation(java.lang.Long id, java.lang.Long classId, OperationContext op)` Invokes a server-side operation.
`java.io.Serializable` | `DMInvokeServerMethod(java.lang.Long id, java.lang.Long classId, java.lang.String methodName, java.io.Serializable payload)` Invokes an S_LibrarySession or S_LibraryObject DYN method.
`boolean` | `DMIsAclIndexUpdateModeSynchronous()` determine if ACL index update mode is synchronous
`boolean` | `DMIsAttributeValueInValueDomain(java.lang.Long id, java.lang.Long classId, AttributeValue av)` Determines whether the specified attribute value lies within this ValueDomain.
`boolean` | `DMIsContentReadByUser(java.lang.Long id, java.lang.Long classId)` Gets the read state of the specified S_ContentObject.
`boolean` | `DMIsContextIndexEnabled()` whether Context has ben enabled on this schema
`boolean` | `DMIsDirectMemberOfDirectoryGroup(java.lang.Long groupId, java.lang.Long groupClassId, java.lang.Long memberId, java.lang.Long memberClassId)` Check whether the specified DirectoryObject is a direct member of the specified group.
`boolean` | `DMIsExecutionMode(int mode)` Gets whether this S_LibrarySession is in at least the specified execution mode.
`boolean` | `DMIsInstanceOfClassVersionable(java.lang.Long classId)` Gets whether an instance of the specified S_ClassObject is versionable.
`boolean` | `DMIsLockObjectShared(java.lang.Long id, java.lang.Long classid)` Verifies if the LockObject is shared
`boolean` | `DMIsMemberOfDirectoryGroup(java.lang.Long groupId, java.lang.Long groupClassId, java.lang.Long memberId, java.lang.Long memberClassId)` Check whether the specified DirectoryObject is a member of the specified group, directly or indirectly.
`boolean` | `DMIsTransactionInProgress()` Gets whether this S_LibrarySession is in a transaction, explicit or implicit.
`boolean` | `DMIsVersionable(java.lang.Long id, java.lang.Long classId)` Gets whether the specified S_PublicObject is versionable.
`java.util.Vector` | `DMListItems(java.lang.Long folder_id, java.lang.Long classid, java.lang.String folderRelClassname, SortSpecification sort)` Gets the items in the specified S_Folder.
`java.util.Vector` | `DMListPreparedSelectorItems(java.lang.String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, java.lang.String searchDefinition, boolean recursive, java.lang.String language, int maxItemCount, int rowNumber, java.lang.String hint, SortSpecification sort, AttributeValue[] bindValues)` Constructs an S_PreparedSelector and gets its items.
`java.util.Vector` | `DMListSelectorItems(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive, int maxItemCount, SortSpecification sort)` Constructs an S_Selector and gets its items.
`java.util.Vector` | `DMListWastebasketSelectorItems(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive, SortSpecification sort)` Constructs a wastebasket S_Selector and gets its items.
`void` | `DMLockRows(java.lang.Long id, java.lang.Long classId)` Obtain a row-level lock on the specified object.
`java.lang.String[]` | `DMLookupAuditEventOperationTypeKeys(int[] opTypes)` Looks up audit event operation type keys by their numeric values, returning the string keys.
`int[]` | `DMLookupAuditEventOperationTypes(java.lang.String[] opTypeKeys)` Looks up audit event operation types by their string key, returning the corresponding numeric equivalents.
`AuditTargetCode` | `DMLookupAuditTargetCode(java.lang.String className)` Looks up an audit target code structure from the specified Class name or other registered alias for the desired type.
`S_LibraryObjectData` | `DMNewBranchedVersionSeries(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition def)` Branches an S_VersionSeries at the specified S_VersionDescription, resulting in a new S_VersionSeries, S_VersionDescription, and S_BranchRelationship.
`ContentStreamSerializer` | `DMNewContentStreamSerializer()` Constructs and returns a ContentStreamSerializer appropriate to the runtime process model.
`S_LibraryObjectData` | `DMNewPublicObject(S_LibraryObjectDefinition def)` Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition.
`S_LibraryObjectData` | `DMNewRevision(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition def)` Creates a new S_VersionDescription in the specified S_VersionSeries.
`S_LibraryObjectData` | `DMNewSchemaObject(S_LibraryObjectDefinition def)` Creates a new S_SchemaObject based on the specified S_LibraryObjectDefinition.
`java.lang.Long` | `DMNewSearch()` Constructs a new S_Search whose SearchSpecification is undefined.
`java.lang.Long` | `DMNewSearchFromObject(java.lang.Long searchObjectId)` Constructs a new S_Search whose SearchSpecification is defined by the specified S_SearchObject.
`S_LibraryObjectData` | `DMNewSystemObject(S_LibraryObjectDefinition def)` Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition.
`S_LibraryObjectData` | `DMNewVersionSeries(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition def)` Creates a secondary S_VersionSeries for the specified S_Family.
`S_LibraryObjectData` | `DMNextFolderItem(java.lang.Long folder_id, java.lang.Long classid)` Gets the next item in the specified S_Folder.
`java.util.Vector` | `DMNextSearchItems(java.lang.Long srchId, int batchCount)` Gets the next batch of items in the specified S_Search.
`java.util.Vector` | `DMNextSelectorBatch(long selId, int batchSize)` Gets the next batch of items for the specified selector.
`S_LibraryObjectData` | `DMNextSelectorItem(long selId)` Gets the next item in the specified selector.
`void` | `DMOpenFolder(java.lang.Long folder_id, java.lang.Long classid, java.lang.String folderRelClassname, SortSpecification sort)` Opens the items in the specified S_Folder.
`void` | `DMOpenSearch(java.lang.Long srchId, java.util.Vector bindValues, java.lang.String language, int timeout)` Opens the specified S_Search.
`long` | `DMOpenSelector(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive, SortSpecification sort)` Constructs and opens an S_Selector.
`long` | `DMOpenWastebasketSelector(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive, SortSpecification sort)` Constructs and opens a wastebasket S_Selector.
`void` | `DMPersistTokenCredential(TokenCredential credential)` Makes the specified TokenCredential persistent.
`void` | `DMPopTemporaryAccessCheckMode()` Bean-side cover to `popTemporaryAccessCheckMode`.
`void` | `DMPopTemporaryExecutionMode()` Restore previous temporary execution mode for this session.
`void` | `DMPostAuditEvent(AuditEvent event, int mode)` Create an audit event.
`void` | `DMPostEvent(IfsEvent event)` Posts the specified event.
`void` | `DMProcessEvents()` Processes any events after ticking the event exchanger.
`java.util.Vector` | `DMProcessEventsInBackground()` Processes any events server-side after ticking the event exchanger, and then returns these events to the bean-side caller for bean-side processing.
`void` | `DMPushTemporaryAccessCheckMode(boolean mode)` Bean-side cover to `pushTemporaryAccessCheckMode`.
`void` | `DMPushTemporaryExecutionMode(int mode)` Establishes a temporary execution mode for this session.
`void` | `DMRandomAccessorClose(S_RandomAccessorImpl ra)` Closes the specified RandomAccessor, saving any changes to the document.
`void` | `DMRandomAccessorDispose(S_RandomAccessorImpl ra)` Disposes the specified RandomAccessor, discarding any changes to the document.
`java.lang.Long` | `DMRandomAccessorGetContentObjectId(S_RandomAccessorImpl ra)` Gets the id of the ContentObject being accessed by the specified RandomAccessor.
`java.lang.Long` | `DMRandomAccessorGetDocumentId(S_RandomAccessorImpl ra)` Gets the id of the Document being accessed by the specified RandomAccessor.
`boolean` | `DMRandomAccessorIsWriteable(S_RandomAccessorImpl ra)` Gets whether the specified RandomAccessor is writeable.
`long` | `DMRandomAccessorLength(S_RandomAccessorImpl ra)` Gets the content length from the specified RandomAccessor.
`int` | `DMRandomAccessorRead(S_RandomAccessorImpl ra, long pos, byte[] b, int off, int len)` Reads bytes from the specified RandomAccessor.
`void` | `DMRandomAccessorSetSession(S_RandomAccessorImpl ra)` Binds the specified RandomAccessor to this session.
`void` | `DMRandomAccessorTruncate(S_RandomAccessorImpl ra, long len)` Truncates the content of the specified RandomAccessor.
`void` | `DMRandomAccessorWrite(S_RandomAccessorImpl ra, long pos, byte[] b, int off, int len)` Writes bytes to the specified RandomAccessor.
`void` | `DMReassociateLinks(java.lang.Long oldId, java.lang.Long oldClassId, java.lang.Long newId, java.lang.Long newClassId)` Reassociate the Links for the specified PublicObject to new specified PublicObject.
`boolean` | `DMReauthenticate(Credential credential, ConnectOptions options)` Reauthenticates the DIRECTORYUSER for which this S_LibrarySession was created (this is the DIRECTORYUSER returned by the method `getAuthenticatedUser`).
`int` | `DMRegisterAuditEventOperationType(java.lang.String opTypeKey, int targetCode, java.lang.String targetClass, int opCode, java.lang.Boolean createOrFree)` Register a new event type.
`void` | `DMRegisterClassEventHandler(java.lang.Long classId)` Receive notification that the bean-side has a registered event handler for the specified ClassObject.
`int` | `DMRegisterCustomAuditEventOperationCodeKey(java.lang.String opCodeKey)` Register a new custom operation code key.
`void` | `DMRegisterEventHandler(java.lang.Long id)` Receive notification that the bean-side has a registered event handler for the specified object.
`void` | `DMRegisterServiceEventHandler(IfsEventHandler handler)` Register a Service event handler.
`int` | `DMReleaseExpiredLockObject(java.lang.Long id, java.lang.Long classId)` Release an expired LockObject.
`void` | `DMRemoveAccessControlEntry(java.lang.Long id, java.lang.Long classId, java.lang.Long aceId, java.lang.Long aceClassId)` Removes an S_AccessControlEntry in the specified S_AccessControlList.
`void` | `DMremoveAllAccessControlEntries(java.lang.Long id, java.lang.Long classId)` Removes all S_AccessControlEntries from the specified S_AccessControlList.
`void` | `DMRemoveAttributeFromClassObject(java.lang.Long id, S_LibraryObjectDefinition def)` Removes an attribute from an existing classobject.
`void` | `DMRemoveAuditEvents(long[] eventIds, java.lang.String tableName)` Remove audit events.
`void` | `DMRemoveAuditEventsForTarget(java.lang.Long specId, java.lang.Long targetId)` Free audit events from a specific Audit history, by target ID.
`void` | `DMRemoveFromFolder(java.lang.Long folder_id, java.lang.Long classid, java.lang.Long rightObj, java.lang.Long rightObjClassid, S_LibraryObjectDefinition def)` Removes the specified item from the specified S_Folder.
`void` | `DMRemoveMemberFromDirectoryGroup(java.lang.Long group_id, java.lang.Long classid, java.lang.Long member_id, java.lang.Long memberClassid)` Removes the specified S_DirectoryObject from the specified S_DirectoryGroup.
`void` | `DMRemoveMembersFromDirectoryGroup(java.lang.Long group_id, java.lang.Long classid, java.lang.Long[] rightObjIds, java.lang.Long[] rightObjClassids)` Removes the specified S_DirectoryObjects from the specified S_DirectoryGroup.
`void` | `DMRemoveRawAuditEvents(RawAuditEvent[] rawEvents)` Remove raw audit events.
`void` | `DMRemoveRelationship(java.lang.Long id, java.lang.Long classId, java.lang.Long relId, java.lang.Long relClassId)` Removes a relationship from the specified S_PublicObject.
`ContentStreamSerializer` | `DMRender(java.lang.Long id, java.lang.Long classId, java.lang.String rendererType, java.lang.String rendererName, java.util.Hashtable options, boolean reader)` Deprecated. iFS 9.0.3 see release notes for more information
`void` | `DMReserveNext(java.lang.Long id, java.lang.Long classId, java.lang.String contentPath, java.lang.String comment)` Reserves the specified S_VersionSeries.
`void` | `DMResolveObjects(java.lang.Long[] ids, java.lang.Long[] classIds, ObjectResolverSpecification spec)` Force deeper resolution for the specified LibraryObjects
`void` | `DMRollback()` Discards all pending changes for all in-progress Transactions for this S_LibrarySession.
`long` | `DMSchemaVersionNumber()` Gets the schema version as a long.
`java.lang.String` | `DMSchemaVersionString()` Gets the schema version as a string.
`AttributeValue[]` | `DMSelectAggregateAuditEventColumns(java.lang.Long auditSpec, java.lang.String aggFunction, java.lang.String[] columnNames, java.lang.String[] innerColNames, java.lang.String filterClause, java.lang.String sortClause)` Returns the list of distinct values of the specified AuditEvent columns, along with an optional aggregate function.
`AuditEvent[]` | `DMSelectAuditEvents(java.lang.Long auditSpec, java.lang.String filterClause, java.lang.String sortClause, int maxItems)` Select audit events.
`RawAuditEvent[]` | `DMSelectRawAuditEvents(java.lang.String filterClause, int maxItems)` Select raw audit events.
`AuditFolderPath` | `DMSelectSpecificAuditFolderPath(long folderPathId)` Select the specific AuditFolderPath for a given primary key.
`void` | `DMSendClientVersionInformation(long versionNumber, java.lang.String versionString)` Sets the LibrarySession version for this S_LibrarySession.
`void` | `DMSetApplicationName(java.lang.String name)` Sets the application name.
`S_LibraryObjectDefinition` | `DMSetAttributes(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition def)` Updates the specified S_LibraryObject.
`void` | `DMSetContentReadByUser(java.lang.Long id, java.lang.Long classId, boolean readState, java.lang.Long refObjId, java.lang.Long refObjClassId)` Sets the read state of the specified S_ContentObject.
`void` | `DMSetEncryptedRepositoryParameter(java.lang.String name, java.lang.String value)` Sets the value of the specified repository parameter.
`void` | `DMSetExecutionMode(int mode)` Sets whether the new execution mode for the session
`void` | `DMSetLibrarySession(LibrarySession session)` Sets the LibrarySession callback for this S_LibrarySession.
`void` | `DMSetRepositoryParameter(java.lang.String name, java.lang.String value)` Sets the value of the specified repository parameter.
`void` | `DMSetSearchSpecification(java.lang.Long srchId, SearchSpecification sp)` Sets the SearchSpecification of the specified S_Search.
`void` | `DMSetServiceTraceLoggerLevels(int[] levels)` Sets the trace levels of the S_LibraryServiceTraceLogger.
`void` | `DMSetSessionTraceLoggerLevels(int[] levels)` Sets the trace levels of the S_LibrarySessionTraceLogger.
`void` | `DMTrace(int channel, int level, java.lang.Long serviceId, java.lang.Long sessionId, java.lang.Long id, java.lang.String className, java.lang.String payload)` Sends a trace request to the S_LibrarySessionTraceLogger.
`void` | `DMUndelete(java.lang.Long id, java.lang.Long classId, S_LibraryObjectDefinition def)` Undeletes the specified S_PublicObject.
`void` | `DMUnregisterAuditEventOperationType(java.lang.String opTypeKey)` Unregister an event type.
`void` | `DMUnReserve(java.lang.Long id, java.lang.Long classId)` Unreserves the specified S_VersionSeries.
`void` | `DMupdateAccessControlEntry(java.lang.Long id, java.lang.Long classId, java.lang.Long aceId, java.lang.Long aceClassId, S_LibraryObjectDefinition sdef)` Updates an S_AccessControlEntry in the specified S_AccessControlList.
`RandomAccessor` | `DMUpdateContentByRandomAccess(java.lang.Long docId, java.lang.Long docClassId, S_LibraryObjectDefinition sdocdef, java.lang.Long expirationPeriod)` Gets a RandomAccessor for randomly writing and reading the content of the specified document.
`void` | `DMUpdateLocalizer(java.util.Hashtable properties)` Updates the Localizer of this S_LibrarySession to reflect the Localizer properties specified as name/value pairs.
`void` | `DMUpdateSessionDefaults(java.util.Hashtable properties)` Updates the S_LibrarySession preferences, including the name of the default folder relationship classobject and the folder path delimiter.
`long` | `DMVersionNumber()` Gets the version of the S_LibraryService hosting this S_LibrarySession as a long.
`java.lang.String` | `DMVersionString()` Gets the version of the S_LibraryService hosting this S_LibrarySession as a string.
`java.io.Serializable` | `DYNChangeAclResolutionMode(java.io.Serializable payload)` Change ACL resolution mode to either synchronous or asynchronous.
`java.io.Serializable` | `DYNChangeFolderIndexUpdateMode(java.io.Serializable payload)` Change folder index update mode to either synchronous or asynchronous.
`java.io.Serializable` | `DYNCleanUpDanglingArrayReferences(java.io.Serializable payload)` Clears elements of array-type object-type attributes that reference invalid objects.
`java.io.Serializable` | `DYNCleanUpDanglingObjectReferences(java.io.Serializable payload)` Clears scalar object-type attributes that reference invalid objects.
`java.io.Serializable` | `DYNCleanupDeadServices(java.io.Serializable payload)` Cleans up S_LibraryServices that have abnormally terminated.
`java.io.Serializable` | `DYNCompleteIndexCreation(java.io.Serializable payload)` Complete the creation of the folder index.
`java.io.Serializable` | `DYNCreateAdminDirectoryObjects(java.io.Serializable payload)` Creates the admin DirectoryUser and the world DirectoryGroup.
`java.io.Serializable` | `DYNCreateInitialDeferredEntries(java.io.Serializable payload)` Create the initial deferred set of folder relationships for the Folder index.
`java.io.Serializable` | `DYNCreateInitialSelfRows(java.io.Serializable payload)` Create the initial set of self-referencing rows inthe folder index
`java.io.Serializable` | `DYNCredentialManagerAuthenticate(java.io.Serializable payload)` Authenticates the specified credential.
`java.io.Serializable` | `DYNCredentialManagerCreateInitialContext(java.io.Serializable payload)` Creates a JNDI connection to the OiD instance for the specified OidCredentialManager and returns the DirContext of that connection.
`java.io.Serializable` | `DYNCredentialManagerCreateUser(java.io.Serializable payload)` Deprecated. iFS 9.0.2 added options element
`java.io.Serializable` | `DYNCredentialManagerDeleteUser(java.io.Serializable payload)` Deprecated. iFS 9.0.2 added options element
`java.io.Serializable` | `DYNCredentialManagerGetProperty(java.io.Serializable payload)` Gets the value of the specified dynamic property for the specified CredentialManager.
`java.io.Serializable` | `DYNCredentialManagerListUsers(java.io.Serializable payload)` Deprecated. iFS 9.0.2 changed payload to Vector of two elements
`java.io.Serializable` | `DYNCredentialManagerSetPassword(java.io.Serializable payload)` Deprecated. iFS 9.0.2 added options element
`java.io.Serializable` | `DYNCredentialManagerSupportsCreateUser(java.io.Serializable payload)` Determines whether the specified CredentialManager supports the `DYNCredentialManagerCreateUser` method.
`java.io.Serializable` | `DYNCredentialManagerSupportsDeleteUser(java.io.Serializable payload)` Determines whether the specified CredentialManager supports the `DYNCredentialManagerDeleteUser` method.
`java.io.Serializable` | `DYNCredentialManagerSupportsListUsers(java.io.Serializable payload)` Determines whether the specified CredentialManager supports the `DYNCredentialManagerListUsers` method.
`java.io.Serializable` | `DYNCredentialManagerSupportsSetPassword(java.io.Serializable payload)` Determines whether the specified CredentialManager supports the `DYNCredentialManagerSetPassword` method.
`java.io.Serializable` | `DYNCredentialManagerUserExists(java.io.Serializable payload)` Determines whether the specified CredentialManager can authenticate the specified user.
`java.io.Serializable` | `DYNDeleteExpiredAuditFolderPaths(java.io.Serializable payload)` Delete any expired Audit folder paths, that have expired longer than the specified period.
`java.io.Serializable` | `DYNDeleteExpiredGlobalAuditEvents(java.io.Serializable payload)` Delete any expired audit events from global audit history.
`java.io.Serializable` | `DYNDeleteOldFilteredContent(java.io.Serializable payload)` Garbage collects old filtered content rows.
`java.io.Serializable` | `DYNDeleteUnusedAuditFolderPathOverflowEntries(java.io.Serializable payload)` Delete any unused overflow entries for Audit folder paths.
`java.io.Serializable` | `DYNDeleteUnusedAuditProperties(java.io.Serializable payload)` Delete any unreferenced Audit event properties.
`java.io.Serializable` | `DYNExplainPlan(java.io.Serializable payload)` Generates the query plan for a S_Search.
`java.io.Serializable` | `DYNExtractContentForIndexing(java.io.Serializable payload)` DYN wrapper for the `extractContentForIndexing` method of S_LibrarySessionContentStorageManager.
`java.io.Serializable` | `DYNGetAbsolutePath(java.io.Serializable payload)` Gets an absolute path, on the database-tier file system, for the specified path.
`java.io.Serializable` | `DYNGetCommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload)` Gets the cache performance of the committed S_LibraryObjectData cache, as a string.
`java.io.Serializable` | `DYNGetCommittedResolvedAclCachePerformanceString(java.io.Serializable payload)` Gets the cache performance of the committed Resolved ACL cache, as a string.
`java.io.Serializable` | `DYNGetFolderIndexMaxLevel(java.io.Serializable payload)` Get the max level parameter from FolderIndexService.
`java.io.Serializable` | `DYNGetFolderPathCachePerformanceString(java.io.Serializable payload)` Deprecated. CM SDK 10g removed explicit Folder path cache
`java.io.Serializable` | `DYNGetFoldersNeedingPromotion(java.io.Serializable payload)` Get the list of folders that are in need of promotion.
`java.io.Serializable` | `DYNGetLibraryObjectCachePerformanceString(java.io.Serializable payload)` Gets the cache performance of the S_LibraryObject cache, as a string.
`java.io.Serializable` | `DYNGetReadonlyConnectionPoolPerformanceString(java.io.Serializable payload)` Gets performance statistics of the readonly connection pool.
`java.io.Serializable` | `DYNGetRichMediaDocsWithoutRichMediaCategories(java.io.Serializable payload)` Gets all Docs that are in the "InterMedia" media but are not associated with an InterMedia category.
`java.io.Serializable` | `DYNGetSystemUserToken(java.io.Serializable payload)` Gets the system token that can be used to efficiently clone system sessions.
`java.io.Serializable` | `DYNGetUncommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload)` Gets the cache performance of the uncommitted S_LibraryObjectData cache, as a string.
`java.io.Serializable` | `DYNGetUncommittedResolvedAclCachePerformanceString(java.io.Serializable payload)` Gets the cache performance of the uncommitted Resolved ACL cache, as a string.
`java.io.Serializable` | `DYNGetUnreferencedContentObjectList(java.io.Serializable payload)` Gets List of all unreferenced ContentObjects
`java.io.Serializable` | `DYNGetWriteableConnectionPoolPerformanceString(java.io.Serializable payload)` Gets performance statistics of the writeable connection pool.
`java.io.Serializable` | `DYNInitializeFolderIndexTables(java.io.Serializable payload)` Creates folder index tables.
`java.io.Serializable` | `DYNIsFolderIndexEnabled(java.io.Serializable payload)` Returns indication of whether a folder index service is in use.
`java.io.Serializable` | `DYNIsFolderIndexUpdateModeSynchronous(java.io.Serializable payload)` Get indication of theFolderIndexService update mode.
`java.io.Serializable` | `DYNListAllFoldersWithSubfolders(java.io.Serializable payload)` Gets all S_Folders that have one or more subfolders.
`java.io.Serializable` | `DYNPurgeEvents(java.io.Serializable payload)` Purges events older than a threshold age.
`java.io.Serializable` | `DYNRemoveInvalidTokenCredentials(java.io.Serializable payload)` Remove Token Credentials that have expired or have been expended.
`java.io.Serializable` | `DYNResetFolderIndex(java.io.Serializable payload)` Resets Folder index so that the only rows included are "self" rows.
`java.io.Serializable` | `DYNSelectUnusedAuditTypeLists(java.io.Serializable payload)` Get a list of unused audit type list IDs.
`java.io.Serializable` | `DYNSyncContentIndex(java.io.Serializable payload)` Syncs the Oracle Text index.
`java.io.Serializable` | `DYNTruncateFolderIndexTables(java.io.Serializable payload)` Truncates the folder index tables.
`protected void` | `emptyWastebasket(S_DirectoryObject user)` Empties the user's (or feigned user's, if applicable) wastebasket.
`boolean` | `execute(java.sql.PreparedStatement stmt)` Covers a JDBC execute statement, so that this statement can be cancelled if it blocks.
`boolean` | `execute(java.sql.Statement stmt, java.lang.String sql)` Covers a JDBC execute statement, so that this statement can be cancelled if it blocks.
`int[]` | `executeBatch(java.sql.Statement stmt)` Covers a JDBC executeBatch statement, so that this statement can be cancelled if it blocks.
`java.sql.ResultSet` | `executeQuery(java.sql.PreparedStatement stmt)` Covers a JDBC executeQuery statement, so that this statement can be cancelled if it blocks.
`java.sql.ResultSet` | `executeQuery(java.sql.Statement stmt, java.lang.String sql)` Covers a JDBC executeQuery statement, so that this statement can be cancelled if it blocks.
`int` | `executeUpdate(java.sql.PreparedStatement stmt)` Covers a JDBC executeUpdate statement, so that this statement can be cancelled if it blocks.
`int` | `executeUpdate(java.sql.Statement stmt, java.lang.String sql)` Covers a JDBC executeUpdate statement, so that this statement can be cancelled if it blocks.
`S_ClassObjectData` | `findClassData(java.lang.String className)` Returns an S_ClassObjectData given a class name.
`protected S_LibraryObjectCursor` | `findLibraryObjectCursor(long cursorId)` Finds a S_LibraryObjectCursor.
`protected S_LibraryObjectData` | `findLibraryObjectData(java.lang.Long id)` Finds the S_LibraryObjectData in the data cache
`protected AccessControlListResolver` | `findOrConstructAclResolver(java.lang.Long key)` Finds a previously constructed uncommitted AccessControlListResolver, or failing that, a commited AccessControlListResolver for the specified id.
`protected S_LibraryObjectSelector` | `findSelectorInCache(java.lang.Long classId)` Gets the S_LibraryObjectSelector for the specified classobject.
`S_LibraryObjectSelector` | `findSelectorInCache(java.lang.String className)` Gets the S_LibraryObjectSelector for the specified classobject.
`protected S_Selector` | `findSSelector(long selId)` Get the specified S_Selector from the set of S_Selectors for this S_LibrarySession.
`void` | `flushEvents()` Flush any pending outgoing events.
`protected void` | `forceOriginalSessionState()` Clears discover administration mode and set deleted object filtering mode to the default value for this S_LibrarySession.
`protected java.lang.String` | `generateInsertStatement(java.lang.String tableName, S_ClassObjectData clssdef)` Generates a INSERT statement string for the specified classobject.
`protected java.sql.PreparedStatement` | `generateUpdateStatement(java.lang.String tableName, S_ClassObjectData classData, AttributeValue[] avs, LibraryConnection lconn, java.sql.Connection conn, long id)` Generates an UPDATE statement for the specified object, classobject, and values.
`protected java.lang.String` | `getApplicationName()` Gets the name of the application that created this session.
`protected java.lang.Object[]` | `getArrayAttributeValueEntries(int dataType, AttributeValue av)` Gets the array of objects corresponding to an array-type AttributeValue.
`AttributeValue` | `getArrayTypeAttributeValue(AttributeValueArray av, long objectId, long attributeId, long auditId, int count)` Gets a fully resolved array-type AttributeValue with non-transient elements that is a copy of the specified array-type AttributeValue.
`static AttributeValue` | `getArrayTypeAttributeValue(AttributeValueArray av, long objectId, long attributeId, long auditId, S_LibrarySession session, LibraryConnection lconn, java.sql.Connection conn)` Gets a fully resolved array-type AttributeValue with non-transient elements that is a copy of the specified array-type AttributeValue.
`java.lang.String` | `getAttributeSortName(java.lang.String classname, java.lang.String attributename)` Gets the database object name of the specified attribute.
`protected BoundedCache` | `getAuditCertificateCache()` Gets the AuditCertificate cache.
`AuditCertificate[]` | `getAuditCertificates(java.lang.Long[] objectIds)` Select AuditCertificates for the specified object IDs.
`protected BoundedCache` | `getAuditInlineStringCache()` Gets the Audit cache for inline strings.
`protected BoundedCache` | `getAuditInlineStringReferenceCache()` Gets the Audit cache for references to inline strings.
`AttributeValue[]` | `getAuditTypesForClass(java.lang.String className, boolean includeNested)` Gets the audit operation type values for a specified class name, optionally including any types that are applicable to a class that is considered a descendent of the specified class.
`AttributeValue[]` | `getAuditTypesForCreateOperations()` Gets the audit operation type values that correspond to "CREATED" operations.
`AttributeValue[]` | `getAuditTypesForFreeOperations()` Gets the audit operation type values that correspond to "FREE" operations.
`S_DirectoryUser` | `getAuthenticatedUser()` Gets the S_DirectoryUser for which this S_LibrarySession was authenticated.
`java.lang.Long` | `getAuthenticatedUserId()` Gets the id of the S_DirectoryUser for which this S_LibrarySession was authenticated.
`protected java.lang.String` | `getAuthenticatedUserName()` Gets the name of the S_DirectoryUser for which this S_LibrarySession was authenticated.
`protected long` | `getBeansVersionNumber()` Gets the beans-side version number, as a long.
`protected java.lang.String` | `getBeansVersionString()` Gets the beans-side version number, as a string.
`Collection` | `getClassAccessControlListCollection()` Gets a reference to the ClassAccessControlList collection.
`Collection` | `getClassDomainCollection()` Gets a reference to the S_ClassDomain collection.
`protected java.lang.String` | `getClassName(java.lang.Long classid)` Gets the name of the S_ClassObject for the specified class id.
`S_ClassObject` | `getClassObject(java.lang.Long classid)` Gets the S_ClassObject for the specified class id.
`S_ClassObject` | `getClassObjectByName(java.lang.String classname)` Returns a class object given a class name.
`Collection` | `getClassObjectCollection()` Gets a reference to the S_ClassObject collection.
`AttributeValue` | `getClassObjectValueByName(java.lang.String name)` Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.
`java.lang.Long` | `getClockOffset()` Gets the clock offset, representing the number of milliseconds the DBMS clock is ahead of this mid tier.
`protected java.lang.Long` | `getComponentAclsAttributeId()` Returns the ID of the Attribute object for the AccessControlList.ComponentAcls attribute.
`S_LibrarySessionContentStorageManager` | `getContentStorageManager()` Gets the S_LibrarySessionContentStorageManager for this S_LibrarySession.
`java.util.Date` | `getCurrentDate()` Gets the current Date, with the clock offset applied.
`long` | `getCurrentTimeMillis()` Gets the current time in milliseconds, with the clock offset applied.
`AttributeValue[]` | `getCustomAuditTypes()` Gets the custom audit operation type values.
`protected S_LibraryObjectData` | `getDataInstance(long selectClassId, S_ClassObjectData classData, S_LibraryObjectData[] selectAttributeDatas, java.sql.ResultSet rset)` Gets an S_LibraryObjectData based on the specified ResultSet.
`protected S_LibraryObjectData` | `getDataInstance(long selectClassId, S_ClassObjectData classData, S_LibraryObjectData[] selectAttributeDatas, java.sql.ResultSet rset, int rsetStartIndex)` Gets an S_LibraryObjectData based on the specified ResultSet.
`S_ContentQuota` | `getDefaultContentQuota()` Gets the default ContentQuota to be used when creating new content
`java.lang.String` | `getDefaultFolderRelationshipClassname()` Deprecated. CM SDK 10g: no replacement functionality; FolderPathRelationship is now used as the class name
`S_DirectoryObject` | `getDirectoryObject(java.lang.Long id)` Gets an S_DirectoryObject by id.
`S_DirectoryObject` | `getDirectoryObject(java.lang.Long id, java.lang.Long classId)` Gets an S_DirectoryObject by id and classId.
`DirectoryObjectInterface` | `getDirectoryObjectInterface(java.lang.Long id)` Gets the DirectoryObjectInterface for the specified id.
`DirectoryObjectInterface[]` | `getDirectoryObjectInterfaces(java.lang.Long[] ids)` Gets the DirectoryObjectInterfaces for the specified ids.
`DirectoryService` | `getDirectoryService()` Gets the DirectoryService of the S_LibraryService of this S_LibrarySession.
`Collection` | `getDirectoryUserCollection()` Gets a reference to the DirectoryUser collection.
`protected java.lang.Long[]` | `getDiscoverabilityOfPublicObjectsIds(java.lang.Long[] ids)` Return indication as to which PublicObject objects specified (by ID) the current user can discover.
`protected java.lang.String` | `getDistinguishedUserName()` Gets the distinguished name of the current S_DirectoryUser for this S_LibrarySession.
`S_PropertyBundle` | `getDomainPropertyBundle()` Gets the domain PropertyBundle.
`AttributeValue` | `getDomainPropertyValue(java.lang.String name)` Gets the value of a domain property, by name.
`protected java.lang.String` | `getEncryptedRepositoryParameter(java.lang.String name)` Gets the value of the specified repository parameter.
`Collection` | `getExtendedPermissionCollection()` Gets a reference to the S_ExtendedPermission collection.
`Collection` | `getExtendedUserProfileCollection()` Gets a reference to the S_ExtendedUserProfile collection for this S_LibrarySessions user.
`java.lang.String` | `getFolderPathDelimiter()` Gets the Folder Path Delimiter for this session
`Collection` | `getFormatCollection()` Gets a reference to the S_Format collection, organized by name.
`Collection` | `getFormatExtensionCollection()` Gets a reference to the S_Format collection, organized by extension.
`long` | `getHighestAuditId()` Get the highest Audit Id in use.
`java.lang.Long` | `getId()` Gets the id of this S_LibrarySession.
`java.lang.Long` | `getIdForNewObject(S_LibraryObjectDefinition def)` Gets the next available id value.
`IfsConnection` | `getIfsConnection()` Returns an IfsConnection for this S_LibrarySession.
`protected static java.sql.PreparedStatement` | `getInvalidateTokenCredentialsStatement(LibraryConnection lconn, java.sql.Connection conn)` Gets the PreparedStatement to invalidate user's token credentials
`protected long` | `getLastOperationTime()` Gets the time at which `setLastOperationTime` was last invoked.
`LibraryConnection` | `getLibraryConnection()` Gets the LibraryConnection for this S_LibrarySession.
`S_LibraryObject` | `getLibraryObject(java.lang.Long id, java.lang.Long classId)` Gets an S_LibraryObject by id and classId.
`S_LibraryObject` | `getLibraryObject(java.lang.Long id, java.lang.String className)` Gets an S_LibraryObject by id and classobject name.
`S_LibraryObject` | `getLibraryObject(S_LibraryObjectData data)` Gets an S_LibraryObject by S_LibraryObjectData.
`BoundedLibraryObjectCache` | `getLibraryObjectCache()` Return a reference to the LibaryObject cache.
`CachePerformance` | `getLibraryObjectCachePerformance()` Gets the cache performance object for the S_LibraryObject cache.
`protected S_LibraryObjectData` | `getLibraryObjectData(java.lang.Long id, java.lang.Long classId, java.lang.String attributeName, boolean selectFully)` Gets the S_LibraryObjectData for the specified id and class id.
`java.util.Vector` | `getLibraryObjectDataVector(S_LibraryObject[] objs)` Gets the S_LibraryObjectDatas for the specified S_LibraryObjects.
`S_LibraryObject[]` | `getLibraryObjects(java.util.Vector vData)` Get the S_LibraryObjects for the specified S_LibraryObjectDatas.
`LibrarySession` | `getLibrarySession()` Gets the bean-side session context
`Localizer` | `getLocalizer()` Gets the Localizer of this S_LibrarySession.
`Collection` | `getMediaCollection()` Gets a reference to the Media collection.
`protected static java.sql.PreparedStatement` | `getNextSequenceQueryStatement(LibraryConnection lconn, java.sql.Connection conn)` Gets the PreparedStatement to get the next available id value.
`protected java.lang.String` | `getNLSDatabaseParameterValue(java.lang.String parameter)` Gets the value for the specified NLS database parameter.
`protected OperationDriver` | `getOperationDriver()` Gets the OperationDriver instance in use by the in-progress operation (if any).
`Collection` | `getPermissionBundleCollection()` Gets a reference to the S_PermissionBundle collection.
`protected PolicyAction` | `getPolicyAction(java.lang.String className)` Finds a PolicyAction specified by fully-qualified classname, as kept by the service.
`Collection` | `getPolicyCollection()` Gets a reference to the S_Policy collection.
`Collection` | `getPolicyListCollection()` Gets a reference to the S_PolicyList collection.
`S_PrimaryUserProfile` | `getPrimaryUserProfile()` Gets the S_PrimaryUserProfile of current S_DirectoryUser for this S_LibrarySession.
`S_PublicObject` | `getPublicObject(java.lang.Long id)` Gets an S_PublicObject by id.
`S_PublicObject` | `getPublicObject(java.lang.Long id, java.lang.Long classId)` Gets an S_PublicObject by id and classId.
`PublicObjectInterface` | `getPublicObjectInterface(java.lang.Long id)` Gets the PublicObjectInterface for the specified id.
`PublicObjectInterface[]` | `getPublicObjectInterfaces(java.lang.Long[] ids)` Gets the PublicObjectInterfaces for the specified ids.
`protected java.util.Vector` | `getPublicObjectsByIds(java.lang.Long[] ids)` Gets a set of S_PublicObjects from a set of IDs.
`protected java.lang.String` | `getRepositoryParameter(java.lang.String name)` Gets the value of the specified repository parameter.
`protected java.lang.String[]` | `getRepositoryParameterNames(java.lang.String prefix)` Gets the repository parameter names that start with the specified prefix.
`java.lang.String` | `getResourceString(java.lang.String key)` Gets the resource string for the specified key.
`java.lang.String` | `getResourceString(java.lang.String key, java.lang.Object[] params)` Gets the resource string for the specified key, and substitutes the specified parameters into that resource string.
`S_Folder` | `getRootFolder()` Return the top-most Folder in the CM SDK folder hierarchy.
`S_SchemaObject` | `getSchemaObject(java.lang.Long id)` Gets an S_SchemaObject by id.
`S_SchemaObject` | `getSchemaObject(java.lang.Long id, java.lang.Long classId)` Gets an S_SchemaObject by id and classId.
`SchemaObjectInterface` | `getSchemaObjectInterface(java.lang.Long id)` Gets the SchemaObjectInterface for the specified id.
`SchemaObjectInterface[]` | `getSchemaObjectInterfaces(java.lang.Long[] ids)` Gets the SchemaObjectInterfaces for the specified ids.
`protected java.util.Vector` | `getSchemaObjectsByIds(java.lang.Long[] ids)` Gets a set of S_SchemaObjects from a set of IDs.
`S_LibraryService` | `getService()` Gets the S_LibraryService hosting this S_LibrarySession.
`AttributeValue` | `getServiceConfigurationProperty(java.lang.String name)` Gets the specified service configuration property.
`boolean` | `getServiceConfigurationProperty(java.lang.String name, boolean defaultValue)` Gets the value of the specified service configuration property, as a boolean.
`int` | `getServiceConfigurationProperty(java.lang.String name, int defaultValue)` Gets the value of the specified service configuration property, as an integer.
`java.lang.String` | `getServiceConfigurationProperty(java.lang.String name, java.lang.String defaultValue)` Gets the value of the specified service configuration property, as a string.
`java.lang.Long` | `getServiceId()` Gets the id of the S_LibraryService hosting this S_LibrarySession.
`protected long` | `getSessionCreationTime()` Gets the time at which this session was created.
`java.lang.Long` | `getSessionId()` Gets the id of this S_LibrarySession.
`java.lang.String` | `getSessionIdentifier()` Gets a session identifier.
`protected S_LibraryObjectDataSharedStateFactory` | `getSharedStateFactory()` Returns the Shared State factory in effect for the domain.
`protected java.sql.Statement` | `getStatementInProgress()` Return the current JDBC statement in progress on this session.
`Collection` | `getSystemAccessControlListCollection()` Gets a reference to the SystemAccessControlList collection.
`Collection` | `getSystemLockObjectCollection()` Gets a reference to the SystemLockObject collection.
`S_SystemObject` | `getSystemObject(java.lang.Long id)` Gets an S_SystemObject by id.
`S_SystemObject` | `getSystemObject(java.lang.Long id, java.lang.Long classId)` Gets an S_SystemObject by id and classId.
`SystemObjectInterface` | `getSystemObjectInterface(java.lang.Long id)` Gets the SystemObjectInterface for the specified id.
`SystemObjectInterface[]` | `getSystemObjectInterfaces(java.lang.Long[] ids)` Gets the SystemObjectInterfaces for the specified ids.
`protected java.util.Vector` | `getSystemObjectsByIds(java.lang.Long[] ids)` Gets a set of S_SystemObjects from a set of IDs.
`TraceLogger` | `getTraceLogger()` Gets the trace logger of this session.
`CachePerformance` | `getUncommittedLibraryObjectDataCachePerformance()` Gets the cache performance object for the uncommitted S_LibraryObjectData cache.
`CachePerformance` | `getUncommittedResolvedAclCachePerformance()` Gets the cache performance object for the uncommitted Resolved ACL cache.
`S_DirectoryUser` | `getUser()` Gets the current S_DirectoryUser for this S_LibrarySession.
`java.lang.Long` | `getUserId()` Gets the id of the current S_DirectoryUser for this S_LibrarySession.
`java.lang.String` | `getUserIdentifier()` Return the identifer for the user associated with the current session.
`protected java.lang.String` | `getUserName()` Gets the name of the current S_DirectoryUser for this S_LibrarySession.
`protected S_UserState` | `getUserState()` Gets the user state of the current S_DirectoryUser for this S_LibrarySession.
`Collection` | `getValueDefaultCollection()` Gets a reference to the S_ValueDefault collection.
`Collection` | `getValueDomainCollection()` Gets a reference to the S_ValueDomain collection.
`static AttributeValue` | `getValueFromResultSet(java.sql.ResultSet rset, int position, int datatype, java.lang.Long attributeId, long auditId, long objectId)` Gets the value of the specified bind variable in a ResultSet.
`protected S_Selector` | `getWastebasketSelector(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive)` Constructs a wastebasket S_Selector.
`void` | `handleEvent(IfsEvent event)` Handles the specified event.
`protected void` | `insertIntoSessionTable(java.lang.Long user)` Add this S_LibrarySession into the odmz_session table.
`protected void` | `interrupt()` Interrupt the session.
`void` | `invalidateTokenCredentials(java.lang.Long userId)` Invalidates any previously-created TokenCredential for the specified user.
`protected java.io.Serializable` | `invokeServerMethod(java.lang.Object obj, java.lang.String methodName, java.io.Serializable payload)` Invokes a DYN method on the specified object.
`protected boolean` | `isAccessCheckMode()` Gets the access check mode for the session.
`protected boolean` | `isAdministrationDiscoverMode()` Gets whether this S_LibrarySession is in discover administration mode, either because that mode was explicitly set or implicitly because the session is in adminstration mode.
`protected boolean` | `isAdministrationDiscoverStateEnabled()` Gets whether this S_LibrarySession has been explicitly placed in discover administration mode.
`boolean` | `isAdministrationMode()` Gets whether this S_LibrarySession is in administration mode.
`boolean` | `isCompositeAclSupported()` See if the instance property indicates that composite ACLs are supported.
`boolean` | `isExecutionMode(int mode)` Gets whether this S_LibrarySession is in at least the specified execution mode.
`protected boolean` | `isFilterDeletedObjectsEnabled()` Deprecated. iFS 9.0.3 always returns false
`protected boolean` | `isFullTextIndexingEnabled()` Gets whether full-text indexing is enabled.
`protected boolean` | `isInstallationMode()` Gets whether this S_LibrarySession is in installation mode.
`protected boolean` | `isInstanceOfClassVersionable(java.lang.Long classId)` Gets whether an instance of the specified S_ClassObject is versionable.
`protected boolean` | `isInterrupted()` Return true if this session has been interrupted, either explicitly or as a result of a timeout.
`protected boolean` | `isPartitioningEnabled()` checks whether or not partitioning is being used in this instnace.
`boolean` | `isPolicyMode()` Gets whether this S_LibrarySession is in policy mode.
`protected boolean` | `isStatementInProgressCancelled()` Return true if there's a JDBC statement in progress and it has been cancelled, either explicitly or as a result of a timeout.
`boolean` | `isSystemAdministrationMode()` Gets whether this S_LibrarySession is in system administration mode.
`boolean` | `isTraced(int channel, int level)` Gets whether tracing is enabled for the specified channel and level.
`protected boolean` | `isTransactionInProgress()` Gets whether there is a transaction in-progress.
`boolean` | `isUpgradeInProgress()` See if the session behaves as though an upgrade is in progress.
`protected boolean` | `isWriteableTransactionInProgress()` Gets whether there is a writeable transaction in-progress.
`protected java.util.Vector` | `listWastebasketSelectorItems(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive, SortSpecification sort)` Constructs a wastebasket S_Selector and gets its items.
`java.lang.String` | `lookupAuditEventOperationTypeKey(int opType)` Looks up an audit event operation type key by its numeric value, returning the string key.
`java.lang.String[]` | `lookupAuditEventOperationTypeKeys(int[] opTypes)` Looks up audit event operation type keys by their numeric values, returning the string keys.
`int[]` | `lookupAuditEventOperationTypes(java.lang.String[] opTypeKeys)` Looks up audit event operation types by their string key, returning the corresponding numeric equivalents.
`AuditTargetCode` | `lookupAuditTargetCode(java.lang.String className)` Looks up an audit target code structure from the specified Class name or other registered alias for the desired type.
`ContentStreamSerializer` | `newContentStreamSerializer()` Constructs and returns a ContentStreamSerializer appropriate to the runtime process model.
`protected S_LibraryObject` | `newLibraryObject(OperationState opState, S_LibraryObjectDefinition def)` Creates a new S_LibraryObject based on the specified S_LibraryObjectDefinition within an OperationState context.
`protected S_LibraryObject` | `newLibraryObject(S_LibraryObjectDefinition def)` Creates a new S_LibraryObject based on the specified S_LibraryObjectDefinition.
`S_PublicObject` | `newPublicObject(OperationState opState, S_LibraryObjectDefinition def)` Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition within the specified OperationState context.
`S_PublicObject` | `newPublicObject(S_LibraryObjectDefinition def)` Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition.
`S_SchemaObject` | `newSchemaObject(OperationState opState, S_LibraryObjectDefinition def)` Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition within the specified OperationState context.
`S_SchemaObject` | `newSchemaObject(S_LibraryObjectDefinition def)` Creates a new S_SchemaObject based on the specified S_LibraryObjectDefinition.
`S_SystemObject` | `newSystemObject(OperationState opState, S_LibraryObjectDefinition def)` Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition within the specified OperationState context.
`S_SystemObject` | `newSystemObject(S_LibraryObjectDefinition def)` Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition.
`protected void` | `notifyUncommittedDataCacheEnabled()` Notifies this S_LibrarySession that its uncommitted data cache has been enabled.
`protected void` | `popSessionState()` Deprecated. iFS 10.0 use `popTemporaryExecutionMode()`
`void` | `popTemporaryAccessCheckMode()` Resets any temporary access check mode back to the previous temporary access check mode.
`void` | `popTemporaryExecutionMode()` Resets any temporary execution state back to the previous temporary execution mode.
`void` | `postAuditEvent(AuditEvent event, int mode)` Create an audit event.
`protected void` | `postAuditEventsUponCommit(LibraryConnection lconn, java.sql.Connection conn, java.util.List rawEventList)` Create audit events as a result of a normal completeTransaction occurring.
`protected void` | `postEvent(IfsEvent event)` Post the specified event.
`protected void` | `postFailedAuditEventsUponRollback(LibraryConnection lconn, java.sql.Connection conn, java.util.List rawEventList)` Post failed audit events as a result of an abortTransaction.
`void` | `pushDiscoverAdministrationMode(boolean adminDiscoverMode)` Sets whether this S_LibrarySession is in discover administration mode.
`protected void` | `pushSessionState(boolean adminDiscoverMode)` Deprecated. iFS 10.0 use `pushTemporaryExecutionMode(EXECUTIONMODE_DISCOVERYADMINISTRATION)`
`void` | `pushTemporaryAccessCheckMode(boolean mode)` Establishes a temporary access check mode for the session.
`void` | `pushTemporaryExecutionMode(int executionMode)` Establishes a temporary execution mode for the session.
`protected void` | `putPolicyAction(java.lang.String className, PolicyAction pa)` Caches a PolicyAction specified by fully-qualified classname, managed by the service.
`protected void` | `queueEventForProcessing(IfsEvent event)` Queues the specified event for processing by this S_LibrarySession.
`boolean` | `reauthenticate(Credential credential, ConnectOptions options)` Reauthenticates the DIRECTORYUSER for which this S_LibrarySession was created (this is the DIRECTORYUSER returned by the method `getAuthenticatedUser`).
`int` | `registerAuditEventOperationType(java.lang.String opTypeKey, int targetCode, java.lang.String targetClass, int opCode, java.lang.Boolean createOrFree)` Register a new event type.
`void` | `registerClassEventHandler(S_ClassObject co, boolean includeSubclasses, IfsEventHandler handler)` Registers the specified IfsEventHandler to receive events for all objects in the specified class.
`void` | `registerCollection(Collection collection, java.lang.String classname)` Registers a Collection so that it can be automatically reset by handleEvent as needed when new S_LibraryObjects are created, updated, or freed.
`int` | `registerCustomAuditEventOperationCodeKey(java.lang.String opCodeKey)` Register a new custom operation code key.
`void` | `registerEventHandler(S_LibraryObject lo, IfsEventHandler handler)` Registers the specified IfsEventHandler to receive events for the specified S_LibraryObject.
`void` | `releaseAuxiliaryConnection(java.sql.Connection conn)` Releases an auxiliary Connection previously acquired by this LibrarySession.
`void` | `releaseAuxiliaryLibraryConnection(LibraryConnection lconn)` Releases an auxiliary LibraryConnection previously acquired by this LibrarySession.
`void` | `removeAuditEvents(long[] eventIds, java.lang.String tableName)` Remove audit events.
`void` | `removeAuditEventsForTarget(java.lang.Long specId, java.lang.Long targetId)` Free audit events from a specific Audit history, by target ID.
`protected void` | `removeLibraryObjectCursor(long cursorId)` Removes a S_LibraryObjectCursor.
`protected void` | `removeLibraryObjectCursor(S_LibraryObjectCursor cursor)` Removes a S_LibraryObjectCursor.
`protected void` | `removeLockedForSessionObject(java.lang.Long objid)` Removes the specified S_PublicObject from this S_LibrarySession's internal table of session-locked objects.
`protected void` | `removeLockedForSessionObject(S_PublicObject obj)` Removes the specified S_PublicObject from this S_LibrarySession's internal table of session-locked objects.
`protected void` | `removeSSelector(long selId)` Removes the specified S_Selector from the set of S_Selectors for this S_LibrarySession.
`protected void` | `removeSSelector(S_Selector sel)` Removes the specified S_Selector from the set of S_Selectors for this S_LibrarySession.
`protected void` | `resetUserState()` Force user state to get reset or initialized for the first time
`protected java.lang.String` | `resolveSelectorWhereclause(java.lang.String searchClass, java.lang.String searchDefinition, boolean recursive)` Adds a "classid = n" expression to the specified S_Selector WHERE clause, if appropriate.
`void` | `rollback()` Discards all pending changes for all in-progress Transactions for this S_LibrarySession.
`protected void` | `scheduleRawAuditEvent(AuditExecutor.PreparedRawAuditEvent rawEvent, int postMode)` Schedule an event with the transaction manager, to be posted with the AuditExecutor upon complete or abort of the current transaction.
`AttributeValue[]` | `selectAggregateAuditEventColumns(java.lang.Long auditSpec, java.lang.String aggFunction, java.lang.String[] columnNames, java.lang.String[] innerColNames, java.lang.String filterClause, java.lang.String sortClause)` Returns the list of distinct values of the specified AuditEvent columns, along with an optional aggregate function.
`AuditEvent[]` | `selectAuditEvents(java.lang.Long auditSpec, java.lang.String filterClause, java.lang.String sortClause, int maxItems)` Select audit events.
`protected AuditFolderPath` | `selectLatestAuditFolderPath(java.lang.Long folderId)` Select the latest AuditFolderPath for a folder.
`AuditFolderPath` | `selectSpecificAuditFolderPath(long folderPathId)` Select the specific AuditFolderPath for a given primary key.
`java.util.ArrayList` | `selectUnusedAuditTypeLists(long expirationPeriod)` Select any unreferenced Audit type lists.
`protected void` | `setApplicationName(java.lang.String name)` Sets the name of the application that created this session.
`protected void` | `setDirectoryUser(S_DirectoryUser user)` Sets the S_DirectoryUser of this S_LibrarySession.
`protected void` | `setEncryptedRepositoryParameter(java.lang.String name, java.lang.String value)` Sets the value of the specified repository parameter.
`protected void` | `setLastOperationTime()` Provides a watchdog timer for this S_LibrarySession.
`protected void` | `setRepositoryParameter(java.lang.String name, java.lang.String value)` Sets the value of the specified repository parameter.
`protected void` | `setSpecifiedInsertColumns(AttributeValue[] avs, S_ClassObjectData classData, int position_offset, java.sql.PreparedStatement stmt)` Sets the specified bind variables of the specified INSERT statement for the specified classobject.
`void` | `setValueInStatement(java.sql.PreparedStatement stmt, AttributeValue av, int position, int datatype)` Sets a bind variable in the specified PreparedStatement, coercing the datatype as necessary.
`void` | `setValueInStatement(java.sql.PreparedStatement stmt, AttributeValue av, int position, int datatype, int datalength)` Sets a bind variable in the specified PreparedStatement, coercing the datatype as necessary.
`void` | `trace(int channel, int level, java.lang.String payload)` Issues a trace request to the trace logger.
`void` | `unregisterAuditEventOperationType(java.lang.String opTypeKey)` Unregister an event type.
`protected boolean` | `usesSecureSqlSyntax(java.lang.String whereclause)` Gets whether the specified WHERE clause references secured database objects in the CM SDK schema.
`protected void` | `verifyAdminEnabled()` Verifies that this S_LibrarySession can enter administration mode.
`void` | `verifyAdministrationMode()` Verify that the effective execution mode for the session is at least administration mode.
`void` | `verifyConnected()` Asserts that this S_LibrarySession is connected.
`protected S_DirectoryObject` | `verifyDirectoryObject(S_LibraryObject obj)` Verifies that the specified S_LibraryObject is an S_DirectoryObject.
`void` | `verifyExecutionMode(int mode)` Verify that the effective execution mode for the session is at least the mode specified.
`protected void` | `verifyHasLegalSyntax(java.lang.String searchDefinition)` Ensures the specified WHERE clause does not reference secured database objects, unless in at least administration discover mode.
`protected void` | `verifyHasSelectorAccess(java.lang.String classname)` Verifies that the specified classobject has ACCESSLEVEL_SELECTORACCESS.
`protected void` | `verifyInstallationMode()` Verify that the effective execution mode for the session is at least installation mode.
`protected void` | `verifyInstallEnabled()` Verifies that this S_LibrarySession can enter installation mode.
`protected void` | `verifyNotInterrupted()` Return true if this session has been interrupted, either explicitly or as a result of a timeout.
`protected S_PublicObject` | `verifyPublicObject(S_LibraryObject obj)` Verifies that the specified S_LibraryObject is an S_PublicObject.
`protected S_SchemaObject` | `verifySchemaObject(S_LibraryObject obj)` Verifies that the specified S_LibraryObject is an S_SchemaObject.
`protected void` | `verifySystemAdminEnabled()` Verifies that this S_LibrarySession can enter system administration mode.
`void` | `verifySystemAdministrationMode()` Verify that the effective execution mode for the session is at least system administration mode.
`protected S_SystemObject` | `verifySystemObject(S_LibraryObject obj)` Verifies that the specified S_LibraryObject is an S_SystemObject.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### m_Id

    protected java.lang.Long m_Id

  Description copied from class: `S_LibrarySession`
  The id of this S_LibrarySession.

  (Published)

### m_LibrarySession

    protected LibrarySession m_LibrarySession

  Description copied from class: `S_LibrarySession`
  The LibrarySession for this S_LibrarySession.

  (Published)

### m_ClientVersionString

    protected java.lang.String m_ClientVersionString

  Description copied from class: `S_LibrarySession`
  The version of LibrarySession as a string.

  (Unpublished)

### m_ClientVersionNumber

    protected long m_ClientVersionNumber

  Description copied from class: `S_LibrarySession`
  The version of LibrarySession as a long.

  (Unpublished)

### m_Service

    protected S_LibraryService m_Service

  Description copied from class: `S_LibrarySession`
  The S_LibraryService hosting this S_LibrarySession.

  (Published)

### m_SessionCreationTime

    protected long m_SessionCreationTime

  Description copied from class: `S_LibrarySession`
  The time at which this session was created.

  (Published)

### m_ApplicationName

    protected java.lang.String m_ApplicationName

  Description copied from class: `S_LibrarySession`
  The name of the application that created this session.

  (Published)

### m_AuxiliaryConnections

    protected java.util.Hashtable m_AuxiliaryConnections

  Description copied from class: `S_LibrarySession`
  The auxiliary LibraryConnections acquired by this S_LibrarySession, hashed by Connection.

  (Unpublished)

### m_LockedForSessionObjects

    protected java.util.Hashtable m_LockedForSessionObjects

  Description copied from class: `S_LibrarySession`
  The self-hashed ids of the objects for which this S_LibrarySession has acquired a session lock.

  (Unpublished)

### m_LastOperationTime

    protected long m_LastOperationTime

  Description copied from class: `S_LibrarySession`
  The time at which the most-recent DMFoo operation was performed.

  (Published)

### m_TransactionManager

    protected oracle.ifs.server.S_LibrarySessionTransactionManager m_TransactionManager

  Description copied from class: `S_LibrarySession`
  The S_LibrarySessionTransactionManager for this S_LibrarySession.

  (Published)

### m_OperationDriver

    protected OperationDriver m_OperationDriver

  Description copied from class: `S_LibrarySession`
  The class which drives policy-driven operations.

  (Unpublished)

### m_UncommittedLibraryObjectDataCache

    protected UncommittedLibraryObjectDataCache m_UncommittedLibraryObjectDataCache

  Description copied from class: `S_LibrarySession`
  The uncommitted S_LibraryObjectData cache for this S_LibrarySession.

  (Published)

### m_UncommittedResolvedAclCache

    protected UncommittedResolvedAclCache m_UncommittedResolvedAclCache

  Description copied from class: `S_LibrarySession`
  The uncommitted Resolved ACL cache for this S_LibrarySession.

  (Published)

### m_IsContextEnabled

    protected java.lang.Boolean m_IsContextEnabled

  Description copied from class: `S_LibrarySession`
  Remember if context is installed in this schema.

### m_ServiceEventExchanger

    protected oracle.ifs.server.S_LibraryServiceEventExchanger m_ServiceEventExchanger

  Description copied from class: `S_LibrarySession`
  The S_LibraryServiceEventExchanger of the S_LibraryService hosting this S_LibrarySession.

  (Published)

### m_SharedStateFactory

    protected S_LibraryObjectDataSharedStateFactory m_SharedStateFactory

  Description copied from class: `S_LibrarySession`
  The Shared state factory

  (Published)

### m_PublicObjectClassId

    protected java.lang.Long m_PublicObjectClassId

  Description copied from class: `S_LibrarySession`
  The id of the PUBLICOBJECT classobject.

  (Published)

### m_SchemaObjectClassId

    protected java.lang.Long m_SchemaObjectClassId

  Description copied from class: `S_LibrarySession`
  The id of the SCHEMAOBJECT classobject.

  (Published)

### m_SystemObjectClassId

    protected java.lang.Long m_SystemObjectClassId

  Description copied from class: `S_LibrarySession`
  The id of the SYSTEMOBJECT classobject.

  (Published)

### m_DirectoryObjectClassId

    protected java.lang.Long m_DirectoryObjectClassId

  Description copied from class: `S_LibrarySession`
  The id of the DIRECTORYOBJECT classobject.

  (Published)

### m_User

    protected S_DirectoryUser m_User

  Description copied from class: `S_LibrarySession`
  The S_DirectoryUser that was authenticated to create this S_LibrarySession.

  (Published)

### m_UserName

    protected java.lang.String m_UserName

  Description copied from class: `S_LibrarySession`
  The name of the S_DirectoryUser that was authenticated to create this S_LibrarySession.

  (Published)

### m_FeignedUser

    protected S_DirectoryUser m_FeignedUser

  Description copied from class: `S_LibrarySession`
  The current S_DirectoryUser. The same as m_User unless a feign operation has been performed.

  (Published)

### m_FeignedUserName

    protected java.lang.String m_FeignedUserName

  Description copied from class: `S_LibrarySession`
  The name of the current S_DirectoryUser. Preresolved so SessionManager can get it without operating on this session, causing thread-safety problems.

  (Published)

### m_FeignedUserId

    protected java.lang.Long m_FeignedUserId

  Description copied from class: `S_LibrarySession`
  The ID of the current S_DirectoryUser.

  (Published)

### m_PrimaryUserProfile

    protected S_PrimaryUserProfile m_PrimaryUserProfile

  Description copied from class: `S_LibrarySession`
  The S_PrimaryUserProfile of m_FeignedUser.

  (Published)

### m_UserState

    protected S_UserState m_UserState

  Description copied from class: `S_LibrarySession`
  The S_UserState (for example, read indication) for m_FeignedUser.

  (Unpublished)

### m_DomainPropertyBundle

    protected S_PropertyBundle m_DomainPropertyBundle

  Description copied from class: `S_LibrarySession`
  The domain PropertyBundle.

  (Published)

### m_RootFolder

    protected S_Folder m_RootFolder

  Description copied from class: `S_LibrarySession`
  The root folder.

  (Published)

### m_SessionStateStack

    protected java.util.Stack m_SessionStateStack

  Description copied from class: `S_LibrarySession`
  A stack of S_SessionStates. S_SessionState encapsulates values for the temporary execution state for the session.

  (Published)

### m_ExecutionMode

    protected int m_ExecutionMode

  Description copied from class: `S_LibrarySession`
  The current execution mode of the session. Has one of the values defined in LibrarySessionInterface.

  See Also:
    `LibrarySessionInterface`
  (Published)

### m_TemporaryExecutionMode

    protected int m_TemporaryExecutionMode

  Description copied from class: `S_LibrarySession`
  The temporarily expanded execution mode.

  This can be expanded as a result of pushTemporaryExecutionMode(), either directly (as in the case of enabling Admin discover mode) or as a result of the OperationDriver enabling a privileged state for a policy-driven operation. A value of EXECUTIONMODE_PREEXISTING (numerical value 0) indicates that there is no temporary execution mode in effect, and that the normal mode of the session is in effect.

  (Published)

### m_TemporyDiscoveredAclsEnabled

    protected boolean m_TemporyDiscoveredAclsEnabled

  Description copied from class: `S_LibrarySession`
  Indication if ACL discoverability should be cached in a temporary HashMap. Used during the conversion of a set of object IDs to the discoverable set of PublicObjects for the session.

  (Unpublished)

### m_TemporyDiscoveredAcls

    protected java.util.HashMap m_TemporyDiscoveredAcls

  Description copied from class: `S_LibrarySession`
  The table used to track discoverability when m_TemporyDiscoveredAclsEnabled is true. The key for this map is the ACL ID, and the value is a Boolen that indicates the discoverability for the ACL; Boolean.TRUE dor ACLs that are discoverable and Boolean.FALSE for ACLs that are not discoverable.

  (Unpublished)

### m_AccessCheckModeStack

    protected java.util.Stack m_AccessCheckModeStack

  Description copied from class: `S_LibrarySession`
  A stack of temporary access check modes, stored as Boolean objects.

  (Unpublished)

### m_AccessCheckMode

    protected boolean m_AccessCheckMode

  Description copied from class: `S_LibrarySession`
  Indication if access checks for other than Discover permssion should be performed.

  (Unpublished)

### m_Localizer

    protected Localizer m_Localizer

  Description copied from class: `S_LibrarySession`
  The Localizer for this S_LibrarySession.

  (Published)

### m_DefaultFolderRelationshipClassname

    protected java.lang.String m_DefaultFolderRelationshipClassname

  Description copied from class: `S_LibrarySession`
  The name of the default classobject used to represent new folder relationships.

  (Unpublished)

### m_FolderPathDelimiter

    protected java.lang.String m_FolderPathDelimiter

  Description copied from class: `S_LibrarySession`
  The delimiter for elements in folder paths (e.g. "/").

  (Unpublished)

### m_DefaultContentQuota

    protected S_ContentQuota m_DefaultContentQuota

  Description copied from class: `S_LibrarySession`
  the default ContentQuota object that will be used for any new Documents

  (Unpublished)

### m_PreventSessionTimeouts

    protected boolean m_PreventSessionTimeouts

  Description copied from class: `S_LibrarySession`
  Indication as to whether session timeouts are suppressed

  (Unpublished)

### m_EventProcessingEnabled

    protected boolean m_EventProcessingEnabled

  Description copied from class: `S_LibrarySession`
  Whether event processing is enabled for this S_LibrarySession.

  (Unpublished)

### m_EventsQueuedForProcessing

    protected oracle.ifs.server.S_LibrarySession.Fifo m_EventsQueuedForProcessing

  Description copied from class: `S_LibrarySession`
  A queue of events awaiting processing by this S_LibrarySession.

  (Unpublished)

### m_RegisteredEventHandlers

    protected java.util.Hashtable m_RegisteredEventHandlers

  Description copied from class: `S_LibrarySession`
  Registered event handlers (see registerEventHandler()).

  (Unpublished)

### m_RegisteredClassEventHandlers

    protected java.util.Hashtable m_RegisteredClassEventHandlers

  Description copied from class: `S_LibrarySession`
  Registered class event handlers (see registerClassEventHandler()).

  (Unpublished)

### m_StatementInProgress

    protected java.sql.Statement m_StatementInProgress

  Description copied from class: `S_LibrarySession`
  The current JDBC statement being executed on beahlf on this session

  (Unpublished)

### m_StatementInProgressCancelled

    protected boolean m_StatementInProgressCancelled

  Description copied from class: `S_LibrarySession`
  Has the current JDBC statement being executed on beahlf on this session been cancelled?

  (Unpublished)

### m_Interrupted

    protected boolean m_Interrupted

  Description copied from class: `S_LibrarySession`
  Has the session been interrupted?

  (Unpublished)

### m_Cancelled

    protected boolean m_Cancelled

  Description copied from class: `S_LibrarySession`
  Has the session been interrupted due to an explicit cancel?

  (Unpublished)

### m_PolicyMode

    protected boolean m_PolicyMode

  Description copied from class: `S_LibrarySession`
  Is the session in "Policy Mode", indicating that non-settable attributes added to definitions will be honored?

  (Unpublished)

### m_SelectorMap

    protected java.util.HashMap m_SelectorMap

  Description copied from class: `S_LibrarySession`
  The S_LibraryObjectSelectors for every S_ClassObject, hashed by class id.

  (Unpublished)

### m_SSelectors

    protected java.util.Hashtable m_SSelectors

  Description copied from class: `S_LibrarySession`
  The S_Selectors created by this S_LibrarySession, hashed by selector sequence.

  (Unpublished)

### m_SSelectorSequence

    protected long m_SSelectorSequence

  Description copied from class: `S_LibrarySession`
  The last used selector sequence.

  (Unpublished)

### m_Cursors

    protected java.util.Hashtable m_Cursors

  Description copied from class: `S_LibrarySession`
  The S_LibraryObjectCursors created by this S_LibrarySession, hashed by cursor sequence.

  (Unpublished)

### m_SearchCursors

    protected java.util.Hashtable m_SearchCursors

  Description copied from class: `S_LibrarySession`
  The S_Search objects created by this S_LibrarySession, hashed by cursor sequence.

  (Unpublished)

### m_CursorSequence

    protected long m_CursorSequence

  Description copied from class: `S_LibrarySession`
  The last used cursor sequence.

  (Unpublished)

### m_ComponentAclsAttributeId

    protected java.lang.Long m_ComponentAclsAttributeId

  Description copied from class: `S_LibrarySession`
  The ID of the AccessControlList.ComponentAcls attribute

  (Unpublished)

Constructor Detail

### S_LibrarySession

    protected S_LibrarySession(S_LibraryService service)
                        throws IfsException

  Constructs an unauthenticated S_LibrarySession.

  Parameters:
    `service` - the service
  Throws:
    `IfsException` - if the operation fails
  (Published)

Method Detail

### setDirectoryUser

    protected void setDirectoryUser(S_DirectoryUser user)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the S_DirectoryUser of this S_LibrarySession.

  This is invoked immediately after successful authentication.

  Parameters:
    `user` - the user
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDisconnect

    public void DMDisconnect()
                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Disconnects this S_LibrarySession.

  Specified by:
    `DMDisconnect` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### disconnect

    protected final void disconnect()

  Description copied from class: `S_LibrarySession`
  Disconnects this S_LibrarySession.

  This method terminates the session with extreme prejudice. All thrown Exceptions are ignored.

  This method should only be called by LibrarySession.disconnect().

  (Published)

### insertIntoSessionTable

    protected void insertIntoSessionTable(java.lang.Long user)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Add this S_LibrarySession into the odmz_session table.

  Parameters:
    `user` - the id of the authenticating S_DirectoryUser
  Throws:
    `IfsException` - if the operation fails
  (Published)

### verifyConnected

    public final void verifyConnected()
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Asserts that this S_LibrarySession is connected.

  Throws:
    `IfsException` - (IFS-21000) if the session is not connected
  (Published)

### isUpgradeInProgress

    public boolean isUpgradeInProgress()
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  See if the session behaves as though an upgrade is in progress.

  Indicates the default setting (stored as a domain property) if not explicitly set on the session.

  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.

  Returns:
    true if session behaves as though an upgrade is in progress
  Throws:
    `IfsException` - if operation fails.
  (Published)

### isCompositeAclSupported

    public boolean isCompositeAclSupported()
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  See if the instance property indicates that composite ACLs are supported.

  Returns:
    true if composite ACLs are supported
  Throws:
    `IfsException` - if operation fails.
  (Published)

### DMGetSessionId

    public java.lang.Long DMGetSessionId()
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of this S_LibrarySession.

  Specified by:
    `DMGetSessionId` in interface `S_LibrarySessionInterface`
  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getId

    public java.lang.Long getId()
                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of this S_LibrarySession.

  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSessionId

    public java.lang.Long getSessionId()
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of this S_LibrarySession.

  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getContentStorageManager

    public S_LibrarySessionContentStorageManager getContentStorageManager()

  Description copied from class: `S_LibrarySession`
  Gets the S_LibrarySessionContentStorageManager for this S_LibrarySession.

  Returns:
    the content storage manager; non-null

### getUserIdentifier

    public java.lang.String getUserIdentifier()

  Description copied from class: `S_LibrarySession`
  Return the identifer for the user associated with the current session.

  Specified by:
    `getUserIdentifier` in interface `LogInfo`
  Returns:
    a String that identifes the current user
  (Published)

### getSessionIdentifier

    public java.lang.String getSessionIdentifier()

  Description copied from class: `S_LibrarySession`
  Gets a session identifier.

  Specified by:
    `getSessionIdentifier` in interface `LogInfo`
  Returns:
    a String containing the id of the session
  (Published)

### getService

    public S_LibraryService getService()
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryService hosting this S_LibrarySession.

  Returns:
    the service
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetServiceId

    public java.lang.Long DMGetServiceId()
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of the S_LibraryService hosting this S_LibrarySession.

  Specified by:
    `DMGetServiceId` in interface `S_LibrarySessionInterface`
  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetClockOffset

    public java.lang.Long DMGetClockOffset()
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the clock offset, representing the number of milliseconds the DBMS clock is ahead of this mid tier.

  Specified by:
    `DMGetClockOffset` in interface `S_LibrarySessionInterface`
  Returns:
    the clock offset
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getServiceId

    public java.lang.Long getServiceId()
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of the S_LibraryService hosting this S_LibrarySession.

  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getClockOffset

    public java.lang.Long getClockOffset()
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the clock offset, representing the number of milliseconds the DBMS clock is ahead of this mid tier.

  Returns:
    the clock offset
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getCurrentTimeMillis

    public long getCurrentTimeMillis()
                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the current time in milliseconds, with the clock offset applied.

  Will return the value from `System.currentTimeMillis` with an offset applied equal to the number of milliseconds the DBMS clock is ahead of the mid tier.

  Returns:
    the current time, adjusted with the clock offset
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getCurrentDate

    public java.util.Date getCurrentDate()
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the current Date, with the clock offset applied.

  Will return a Date value constructed from `System.currentTimeMillis` with an offset applied equal to the number of milliseconds the DBMS clock is ahead of the mid tier.

  Returns:
    the current date, adjusted with the clock offset
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSessionCreationTime

    protected long getSessionCreationTime()
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the time at which this session was created.

  Returns:
    the session creation time
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getApplicationName

    protected java.lang.String getApplicationName()
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the name of the application that created this session.

  The application name is specified by the ConnectOptions passed to `LibraryService.connect`. The value is not used internally; it is purely informational.

  Returns:
    the application name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### setApplicationName

    protected void setApplicationName(java.lang.String name)
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the name of the application that created this session.

  The application name is specified by the ConnectOptions passed to `LibraryService.connect`. The value is not used internally; it is purely informational.

  Parameters:
    `name` - the application name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetAttributesRsn

    public long DMGetAttributesRsn()
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the attributes RSN of the service.

  Specified by:
    `DMGetAttributesRsn` in interface `S_LibrarySessionInterface`
  Returns:
    the attributes RSN
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMVersionString

    public java.lang.String DMVersionString()
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the version of the S_LibraryService hosting this S_LibrarySession as a string.

  Specified by:
    `DMVersionString` in interface `S_LibrarySessionInterface`
  Returns:
    the version
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMVersionNumber

    public long DMVersionNumber()
                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the version of the S_LibraryService hosting this S_LibrarySession as a long.

  Specified by:
    `DMVersionNumber` in interface `S_LibrarySessionInterface`
  Returns:
    the version
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSchemaVersionString

    public java.lang.String DMSchemaVersionString()
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the schema version as a string.

  Specified by:
    `DMSchemaVersionString` in interface `S_LibrarySessionInterface`
  Returns:
    the version
  Throws:
    `IfsException` - (IFS-20001) if the operation fails
  (Unpublished)

### DMSchemaVersionNumber

    public long DMSchemaVersionNumber()
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the schema version as a long.

  Specified by:
    `DMSchemaVersionNumber` in interface `S_LibrarySessionInterface`
  Returns:
    the version
  Throws:
    `IfsException` - (IFS-20001) if the operation fails
  (Unpublished)

### DMGetNLSDatabaseParameterValue

    public java.lang.String DMGetNLSDatabaseParameterValue(java.lang.String parameter)
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value for the specified NLS database parameter.

  Specified by:
    `DMGetNLSDatabaseParameterValue` in interface `S_LibrarySessionInterface`
  Returns:
    the value
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getNLSDatabaseParameterValue

    protected final java.lang.String getNLSDatabaseParameterValue(java.lang.String parameter)
                                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value for the specified NLS database parameter.

  Parameters:
    `parameter` - the parameter
  Returns:
    the value
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMCreateDefaultPropertyBundle

    public S_LibraryObjectData DMCreateDefaultPropertyBundle(java.lang.Long id,
                                                             java.lang.Long classId)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a default PropertyBundle.

  Specified by:
    `DMCreateDefaultPropertyBundle` in interface `S_LibrarySessionInterface`
  Returns:
    the value
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCreateDefaultPolicyPropertyBundle

    public S_LibraryObjectData DMCreateDefaultPolicyPropertyBundle(java.lang.Long id,
                                                                   java.lang.Long classId)
                                                            throws IfsException

  Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework

  Description copied from class: `S_LibrarySession`
  Creates a default PolicyPropertyBundle.

  Specified by:
    `DMCreateDefaultPolicyPropertyBundle` in interface `S_LibrarySessionInterface`
  Returns:
    the value
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSendClientVersionInformation

    public void DMSendClientVersionInformation(long versionNumber,
                                               java.lang.String versionString)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the LibrarySession version for this S_LibrarySession.

  Specified by:
    `DMSendClientVersionInformation` in interface `S_LibrarySessionInterface`
  Parameters:
    `versionNumber` - the LibrarySession version number
    `versionString` - the LibrarySession version string
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getBeansVersionString

    protected java.lang.String getBeansVersionString()
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the beans-side version number, as a string.

  Returns:
    the version number
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getBeansVersionNumber

    protected long getBeansVersionNumber()
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the beans-side version number, as a long.

  Returns:
    the version number
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSetApplicationName

    public void DMSetApplicationName(java.lang.String name)
                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the application name.

  Specified by:
    `DMSetApplicationName` in interface `S_LibrarySessionInterface`
  Parameters:
    `name` - the application name
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSetLibrarySession

    public void DMSetLibrarySession(LibrarySession session)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the LibrarySession callback for this S_LibrarySession.

  Specified by:
    `DMSetLibrarySession` in interface `S_LibrarySessionInterface`
  Parameters:
    `session` - the LibrarySession
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getLibrarySession

    public LibrarySession getLibrarySession()

  Description copied from class: `S_LibrarySession`
  Gets the bean-side session context

  Returns:
    the bean-side session context
  (Published)

### getLocalizer

    public final Localizer getLocalizer()
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the Localizer of this S_LibrarySession.

  Specified by:
    `getLocalizer` in interface `LibrarySessionInterface`
  Returns:
    the Localizer
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getFolderPathDelimiter

    public final java.lang.String getFolderPathDelimiter()
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the Folder Path Delimiter for this session

  Returns:
    the delimiter
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getRootFolder

    public S_Folder getRootFolder()
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Return the top-most Folder in the CM SDK folder hierarchy.

  Returns:
    the top-most root folder
  Throws:
    `IfsException` - if operation fails.
  (Published)

### getDefaultContentQuota

    public final S_ContentQuota getDefaultContentQuota()
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the default ContentQuota to be used when creating new content

  Returns:
    the delimiter
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMUpdateLocalizer

    public final void DMUpdateLocalizer(java.util.Hashtable properties)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Updates the Localizer of this S_LibrarySession to reflect the Localizer properties specified as name/value pairs.

  Specified by:
    `DMUpdateLocalizer` in interface `S_LibrarySessionInterface`
  Parameters:
    `properties` - the Localizer properties
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getDefaultFolderRelationshipClassname

    public java.lang.String getDefaultFolderRelationshipClassname()
                                                           throws IfsException

  Deprecated. CM SDK 10g: no replacement functionality; FolderPathRelationship is now used as the class name

  Description copied from class: `S_LibrarySession`
  Gets the default class name of the relationship class used to represent folder relationships. This always returns "FOLDERPATHRELATIONSHIP".

  Returns:
    the default Relationship subclass name
  Throws:
    `IfsException` - if operation fails.
  (Published)

### DMUpdateSessionDefaults

    public final void DMUpdateSessionDefaults(java.util.Hashtable properties)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Updates the S_LibrarySession preferences, including the name of the default folder relationship classobject and the folder path delimiter.

  Specified by:
    `DMUpdateSessionDefaults` in interface `S_LibrarySessionInterface`
  Parameters:
    `properties` - the preferences, hashed by name
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getResourceString

    public java.lang.String getResourceString(java.lang.String key)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the resource string for the specified key.

  The method looks-up the key in each extended resource bundle. If no extended resource bundle contains the key, the default resource bundle (LibraryResources) is used.

  Parameters:
    `key` - the resource bundle key
  Returns:
    the resource string
  Throws:
    `IfsException` - IFS-12001 if the operation fails
  (Published)

### getResourceString

    public java.lang.String getResourceString(java.lang.String key,
                                              java.lang.Object[] params)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the resource string for the specified key, and substitutes the specified parameters into that resource string.

  The method looks-up the key using `getResourceString(key)`. Next, `java.text.MessageFormat` is used to substitute the parameters specified by `params` into the key's value. If a string element of `params` is delimited by brackets, i.e. "`{param}`", then that element is replaced with the value returned by `getResourceString("param")` before being passed to `MessageFormat`.

  Parameters:
    `key` - the resource bundle key
    `params` - an array of Objects to be substituted into the resource bundle message using using `java.text.MessageFormat`
  Returns:
    the formatted resource string
  Throws:
    `IfsException` - IFS-12006 if the operation fails
  (Published)

### getLibraryObjectCache

    public BoundedLibraryObjectCache getLibraryObjectCache()

  Description copied from class: `S_LibrarySession`
  Return a reference to the LibaryObject cache. This is needed for access by oracle.ifs.server.cache.ConnectionLibraryObjectCache.

  Returns:
    the server-side LibraryObject cache.
  (Published)

### getServiceConfigurationProperty

    public AttributeValue getServiceConfigurationProperty(java.lang.String name)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the specified service configuration property.

  Parameters:
    `name` - the property name
  Returns:
    the property, or null if there is no such property
  Throws:
    `IfsException` - (IFS-20004) if the operation fails
  (Published)

### getServiceConfigurationProperty

    public java.lang.String getServiceConfigurationProperty(java.lang.String name,
                                                            java.lang.String defaultValue)
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified service configuration property, as a string.

  Parameters:
    `name` - the property name
    `defaultValue` - the default value
  Returns:
    the property value
  Throws:
    `IfsException` - (IFS-20004) if the operation fails
  (Published)

### getServiceConfigurationProperty

    public boolean getServiceConfigurationProperty(java.lang.String name,
                                                   boolean defaultValue)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified service configuration property, as a boolean.

  Parameters:
    `name` - the property name
    `defaultValue` - the default value
  Returns:
    the property value
  Throws:
    `IfsException` - (IFS-20004) if the operation fails
  (Published)

### getServiceConfigurationProperty

    public int getServiceConfigurationProperty(java.lang.String name,
                                               int defaultValue)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified service configuration property, as an integer.

  Parameters:
    `name` - the property name
    `defaultValue` - the default value
  Returns:
    the property value
  Throws:
    `IfsException` - (IFS-20004) if the operation fails
  (Published)

### DMGetServiceConfigurationProperties

    public final java.util.Hashtable DMGetServiceConfigurationProperties()

  Description copied from class: `S_LibrarySession`
  Gets the service properties.

  Specified by:
    `DMGetServiceConfigurationProperties` in interface `S_LibrarySessionInterface`
  Returns:
    the service properties Hashtable
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetRepositoryParameterNames

    public java.lang.String[] DMGetRepositoryParameterNames(java.lang.String prefix)
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the repository parameter names that start with the specified prefix.

  Specified by:
    `DMGetRepositoryParameterNames` in interface `S_LibrarySessionInterface`
  Parameters:
    `prefix` - the prefix with which repository parameter names must start to be returned; if null or zero-length, all repository parameter names are returned
  Returns:
    the repository parameter names, or null if none
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getRepositoryParameterNames

    protected java.lang.String[] getRepositoryParameterNames(java.lang.String prefix)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the repository parameter names that start with the specified prefix.

  Parameters:
    `prefix` - the prefix with which repository parameter names must start to be returned; if null or zero-length, all repository parameter names are returned
  Returns:
    the repository parameter names, or null if none
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetRepositoryParameter

    public java.lang.String DMGetRepositoryParameter(java.lang.String name)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified repository parameter.

  Specified by:
    `DMGetRepositoryParameter` in interface `S_LibrarySessionInterface`
  Parameters:
    `name` - the parameter name
  Returns:
    the parameter value, or null if there is no parameter with the specified name
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getRepositoryParameter

    protected java.lang.String getRepositoryParameter(java.lang.String name)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified repository parameter.

  Parameters:
    `name` - the parameter name
  Returns:
    the parameter value, or null if there is no parameter with the specified name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMSetRepositoryParameter

    public void DMSetRepositoryParameter(java.lang.String name,
                                         java.lang.String value)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the value of the specified repository parameter.

  Specified by:
    `DMSetRepositoryParameter` in interface `S_LibrarySessionInterface`
  Parameters:
    `name` - the parameter name
    `value` - the parameter value
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### setRepositoryParameter

    protected void setRepositoryParameter(java.lang.String name,
                                          java.lang.String value)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the value of the specified repository parameter.

  Parameters:
    `name` - the parameter name
    `value` - the parameter value
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMDeleteRepositoryParameter

    public void DMDeleteRepositoryParameter(java.lang.String name)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Deletes the specified repository parameter.

  Specified by:
    `DMDeleteRepositoryParameter` in interface `S_LibrarySessionInterface`
  Parameters:
    `name` - the parameter name
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### deleteRepositoryParameter

    protected void deleteRepositoryParameter(java.lang.String name)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Deletes the specified repository parameter.

  Parameters:
    `name` - the parameter name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetEncryptedRepositoryParameter

    public java.lang.String DMGetEncryptedRepositoryParameter(java.lang.String name)
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified repository parameter.

  The specified repository parameter's value is stored encrypted.

  Specified by:
    `DMGetEncryptedRepositoryParameter` in interface `S_LibrarySessionInterface`
  Parameters:
    `name` - the parameter name
  Returns:
    the parameter value, or null if there is no parameter with the specified name
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getEncryptedRepositoryParameter

    protected java.lang.String getEncryptedRepositoryParameter(java.lang.String name)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified repository parameter.

  The specified repository parameter's value is stored encrypted.

  Parameters:
    `name` - the parameter name
  Returns:
    the parameter value, or null if there is no parameter with the specified name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMSetEncryptedRepositoryParameter

    public void DMSetEncryptedRepositoryParameter(java.lang.String name,
                                                  java.lang.String value)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the value of the specified repository parameter.

  The specified repository parameter's value is stored encrypted.

  Specified by:
    `DMSetEncryptedRepositoryParameter` in interface `S_LibrarySessionInterface`
  Parameters:
    `name` - the parameter name
    `value` - the parameter value, up to 127 characters
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### setEncryptedRepositoryParameter

    protected void setEncryptedRepositoryParameter(java.lang.String name,
                                                   java.lang.String value)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the value of the specified repository parameter.

  The specified repository parameter's value is stored encrypted.

  Parameters:
    `name` - the parameter name
    `value` - the parameter value, up to 127 characters
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMInvokeServerMethod

    public java.io.Serializable DMInvokeServerMethod(java.lang.Long id,
                                                     java.lang.Long classId,
                                                     java.lang.String methodName,
                                                     java.io.Serializable payload)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Invokes an S_LibrarySession or S_LibraryObject DYN method.

  Specified by:
    `DMInvokeServerMethod` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the S_LibraryObject on which to operate, or null for S_LibrarySession
    `classId` - the class id of the S_LibraryObject on which to operate, or null for S_LibrarySession
    `methodName` - the name of the method to invoke
    `payload` - the parameter value
  Returns:
    the return value
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMInvokeOperation

    public java.lang.Object DMInvokeOperation(java.lang.Long id,
                                              java.lang.Long classId,
                                              OperationContext op)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Invokes a server-side operation.

  Specified by:
    `DMInvokeOperation` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the S_LibraryObject on which to operate
    `classId` - the class id of the S_LibraryObject on which to operate
    `op` - the operation specification
  Returns:
    the return value
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### invokeServerMethod

    protected java.io.Serializable invokeServerMethod(java.lang.Object obj,
                                                      java.lang.String methodName,
                                                      java.io.Serializable payload)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Invokes a DYN method on the specified object.

  Parameters:
    `obj` - the object on which to operate
    `methodName` - the name of the method to invoke
    `payload` - the parameter value
  Returns:
    the return value
  Throws:
    `IfsException` - if the operation fails
  (Published)

### setLastOperationTime

    protected final void setLastOperationTime()

  Description copied from class: `S_LibrarySession`
  Provides a watchdog timer for this S_LibrarySession.

  This method is invoked by each DMFoo to capture the time that this S_LibrarySession was last active. If any S_LibrarySession falls idle for more than a service properties-file specified period, it is disconnected.

  (Published)

### getLastOperationTime

    protected final long getLastOperationTime()

  Description copied from class: `S_LibrarySession`
  Gets the time at which `setLastOperationTime` was last invoked.

  Returns:
    the time
  (Published)

### getAuthenticatedUser

    public S_DirectoryUser getAuthenticatedUser()
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_DirectoryUser for which this S_LibrarySession was authenticated.

  Returns:
    the user
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getAuthenticatedUserId

    public java.lang.Long getAuthenticatedUserId()
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of the S_DirectoryUser for which this S_LibrarySession was authenticated.

  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getAuthenticatedUserName

    protected java.lang.String getAuthenticatedUserName()
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the name of the S_DirectoryUser for which this S_LibrarySession was authenticated.

  Returns:
    the user name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getUser

    public S_DirectoryUser getUser()
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the current S_DirectoryUser for this S_LibrarySession.

  This is the same as the authenticated user, unless a "feign user" operation has been performed.

  Returns:
    the current user
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getUserId

    public java.lang.Long getUserId()
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of the current S_DirectoryUser for this S_LibrarySession.

  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getUserName

    protected java.lang.String getUserName()
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the name of the current S_DirectoryUser for this S_LibrarySession.

  Returns:
    the name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDistinguishedUserName

    protected java.lang.String getDistinguishedUserName()
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the distinguished name of the current S_DirectoryUser for this S_LibrarySession.

  Returns:
    the distinguished name
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getUserState

    protected S_UserState getUserState()
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the user state of the current S_DirectoryUser for this S_LibrarySession.

  Returns:
    the user state
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### resetUserState

    protected void resetUserState()
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Force user state to get reset or initialized for the first time

  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetDirectoryUserData

    public S_LibraryObjectData DMGetDirectoryUserData()
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectData for the current S_DirectoryUser for this S_LibrarySession.

  Specified by:
    `DMGetDirectoryUserData` in interface `S_LibrarySessionInterface`
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetOurPrimaryUserProfile

    public S_LibraryObjectData DMGetOurPrimaryUserProfile()
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_PrimaryUserProfile of current S_DirectoryUser for this S_LibrarySession.

  Specified by:
    `DMGetOurPrimaryUserProfile` in interface `S_LibrarySessionInterface`
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getPrimaryUserProfile

    public S_PrimaryUserProfile getPrimaryUserProfile()
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_PrimaryUserProfile of current S_DirectoryUser for this S_LibrarySession.

  Returns:
    the primary user profile
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMFeignUser

    public void DMFeignUser(java.lang.Long id,
                            java.lang.Long classid)
                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Feigns the specified S_DirectoryUser.

  This makes this S_LibrarySession behave as though it were for the impersonated user, even though a different user was originally authenticated.

  Specified by:
    `DMFeignUser` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the user impersonate, or null to return to the authenticated user
    `classid` - the class id of the user to impersonate, or null to return to the authenticated user
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSetExecutionMode

    public void DMSetExecutionMode(int mode)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets whether the new execution mode for the session

  Specified by:
    `DMSetExecutionMode` in interface `S_LibrarySessionInterface`
  Parameters:
    `mode` - the desired execution mode
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsExecutionMode

    public boolean DMIsExecutionMode(int mode)
                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in at least the specified execution mode. NOTE: this method intentionally deviates from the standard DMFoo pattern.

  Specified by:
    `DMIsExecutionMode` in interface `S_LibrarySessionInterface`
  Parameters:
    `mode` - specified mode being checked
  Returns:
    whether in at least the specified mode
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### isExecutionMode

    public final boolean isExecutionMode(int mode)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in at least the specified execution mode.

  Parameters:
    `mode` - specified mode being checked
  Returns:
    whether in at least the specified mode
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isAdministrationDiscoverMode

    protected boolean isAdministrationDiscoverMode()
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in discover administration mode, either because that mode was explicitly set or implicitly because the session is in adminstration mode.

  Returns:
    whether in discover administration mode
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isAdministrationMode

    public final boolean isAdministrationMode()
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in administration mode.

  Returns:
    whether in administration mode
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isSystemAdministrationMode

    public final boolean isSystemAdministrationMode()
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in system administration mode.

  Returns:
    whether in system administration mode
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isInstallationMode

    protected final boolean isInstallationMode()
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in installation mode.

  Returns:
    whether in installation mode
  Throws:
    `IfsException` - if the operation fails
  (Published)

### verifyExecutionMode

    public void verifyExecutionMode(int mode)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Verify that the effective execution mode for the session is at least the mode specified.

  Throw an exception otherwise.

  Throws:
    `IfsException` - if not in at least the mode specified
  (Published)

### verifyAdministrationMode

    public void verifyAdministrationMode()
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Verify that the effective execution mode for the session is at least administration mode.

  Throws:
    `IfsException` - (IFS-21051) if not in administration mode
  (Published)

### verifySystemAdministrationMode

    public void verifySystemAdministrationMode()
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Verify that the effective execution mode for the session is at least system administration mode.

  Throws:
    `IfsException` - (IFS-21051) if not in system administration mode
  (Published)

### verifyInstallationMode

    protected void verifyInstallationMode()
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Verify that the effective execution mode for the session is at least installation mode.

  Throws:
    `IfsException` - (IFS-21051) if not in installation mode
  (Published)

### verifyInstallEnabled

    protected final void verifyInstallEnabled()
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that this S_LibrarySession can enter installation mode.

  Throws:
    `IfsException` - (IFS-21050) if cannot enter installation mode
  (Unpublished)

### verifyAdminEnabled

    protected final void verifyAdminEnabled()
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that this S_LibrarySession can enter administration mode.

  Throws:
    `IfsException` - (IFS-21050) if cannot enter administration mode
  (Published)

### verifySystemAdminEnabled

    protected final void verifySystemAdminEnabled()
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that this S_LibrarySession can enter system administration mode.

  Throws:
    `IfsException` - (IFS-21050) if cannot enter system administration mode
  (Published)

### isAdministrationDiscoverStateEnabled

    protected boolean isAdministrationDiscoverStateEnabled()
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession has been explicitly placed in discover administration mode.

  Returns:
    whether explicitly in discover administration mode
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isFilterDeletedObjectsEnabled

    protected boolean isFilterDeletedObjectsEnabled()
                                             throws IfsException

  Deprecated. iFS 9.0.3 always returns false

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in deleted object filtering mode.

  Returns:
    whether the session filters out deleted objects
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFilterDeletedObjects

    public void DMFilterDeletedObjects(boolean mode)
                                throws IfsException

  Deprecated. iFS 9.0.3 Has no effect

  Description copied from class: `S_LibrarySession`
  Sets the "default deleted object filtering mode" of the session.

  Specified by:
    `DMFilterDeletedObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `mode` - whether the session filters out deleted objects
  Throws:
    `IfsException` - if the operation fails

### DMPushTemporaryAccessCheckMode

    public void DMPushTemporaryAccessCheckMode(boolean mode)

  Description copied from class: `S_LibrarySession`
  Bean-side cover to `pushTemporaryAccessCheckMode`.

  NOTE: this method intentionally deviates from the standard DMFoo pattern.

  Specified by:
    `DMPushTemporaryAccessCheckMode` in interface `S_LibrarySessionInterface`
  Parameters:
    `mode` - new temporary access check mode; false indicates that access checks are disabled; true indicates that they are enabled (the normal mode for the session)
  (Unpublished)

### DMPopTemporaryAccessCheckMode

    public void DMPopTemporaryAccessCheckMode()

  Description copied from class: `S_LibrarySession`
  Bean-side cover to `popTemporaryAccessCheckMode`.

  NOTE: this method intentionally deviates from the standard DMFoo pattern.

  Specified by:
    `DMPopTemporaryAccessCheckMode` in interface `S_LibrarySessionInterface`
  (Unpublished)

### pushTemporaryAccessCheckMode

    public void pushTemporaryAccessCheckMode(boolean mode)

  Description copied from class: `S_LibrarySession`
  Establishes a temporary access check mode for the session.

  The caller must guarantee that `popTemporaryAccessCheckMode` is called to clear this temporary access check mode once it is no longer needed, typically in try/finally blocks.

  Parameters:
    `mode` - new temporary access check mode; false indicates that access checks are disabled; true indicates that they are enabled (the normal mode for the session)
  (Published)

### popTemporaryAccessCheckMode

    public void popTemporaryAccessCheckMode()

  Description copied from class: `S_LibrarySession`
  Resets any temporary access check mode back to the previous temporary access check mode.

  (Published)

### isAccessCheckMode

    protected final boolean isAccessCheckMode()

  Description copied from class: `S_LibrarySession`
  Gets the access check mode for the session.

  Normally this returns true, but can be overridden temporarily via `pushTemporaryAccessCheckMode`

  Returns:
    whether in access check mode
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMPushTemporaryExecutionMode

    public void DMPushTemporaryExecutionMode(int mode)

  Description copied from class: `S_LibrarySession`
  Establishes a temporary execution mode for this session.

  NOTE: this method intentionally deviates from the standard DMFoo pattern.

  Specified by:
    `DMPushTemporaryExecutionMode` in interface `S_LibrarySessionInterface`
  Parameters:
    `mode` - the new temporary mode
  (Unpublished)

### DMPopTemporaryExecutionMode

    public void DMPopTemporaryExecutionMode()

  Description copied from class: `S_LibrarySession`
  Restore previous temporary execution mode for this session.

  NOTE: this method intentionally deviates from the standard DMFoo pattern.

  Specified by:
    `DMPopTemporaryExecutionMode` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### pushDiscoverAdministrationMode

    public void pushDiscoverAdministrationMode(boolean adminDiscoverMode)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets whether this S_LibrarySession is in discover administration mode.

  Equivalent to: `pushTemporaryExecutionMode(adminDiscoverMode)`

  Parameters:
    `adminDiscoverMode` - whether the session can discover any object regardless of its ACL
  Throws:
    `IfsException` - if the operation fails
  (Published)

### pushSessionState

    protected void pushSessionState(boolean adminDiscoverMode)

  Deprecated. iFS 10.0 use `pushTemporaryExecutionMode(EXECUTIONMODE_DISCOVERYADMINISTRATION)`

  Description copied from class: `S_LibrarySession`
  Sets the discover administration mode of this S_LibrarySession.

  Equivalent to `pushTemporaryExecutionMode(EXECUTIONMODE_DISCOVERYADMINISTRATION)`

  Parameters:
    `adminDiscoverMode` - whether the session can discover any object regardless of its ACL
  (Unpublished)

### pushTemporaryExecutionMode

    public void pushTemporaryExecutionMode(int executionMode)

  Description copied from class: `S_LibrarySession`
  Establishes a temporary execution mode for the session.

  The caller must guarantee that `popTemporaryExecutionMode()` is called to clear this temprary execution mode once it is no longer needed.

  If the specified mode is less than the regular mode of the session, any previous temporary execution mode is cancelled.

  Parameters:
    `executionMode` - new temporary execution mode
  (Published)

### popSessionState

    protected void popSessionState()

  Deprecated. iFS 10.0 use `popTemporaryExecutionMode()`

  Description copied from class: `S_LibrarySession`
  Resets both the discover administration mode and the deleted object filtering mode of this S_LibrarySession to their values before the most recent call to `pushTemporaryExecutionMode`.

  (Unpublished)

### popTemporaryExecutionMode

    public void popTemporaryExecutionMode()

  Description copied from class: `S_LibrarySession`
  Resets any temporary execution state back to the previous temporary execution mode.

  (Published)

### forceOriginalSessionState

    protected void forceOriginalSessionState()

  Description copied from class: `S_LibrarySession`
  Clears discover administration mode and set deleted object filtering mode to the default value for this S_LibrarySession.

  (Published)

### isPolicyMode

    public boolean isPolicyMode()
                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in policy mode. This is orthogonal to the execution mode of the session.

  Returns:
    whether the session is in policy mode
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### addSelectorToHashMap

    protected S_LibraryObjectSelector addSelectorToHashMap(java.lang.Long classId)
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates an S_LibraryObjectSelector for the specified classobject and adds it to the hashtable of S_LibraryObjectSelectors.

  Parameters:
    `classId` - the id of the classobject of interest
  Throws:
    `IfsException` - if the operation fails
  (Published)

### findSelectorInCache

    protected S_LibraryObjectSelector findSelectorInCache(java.lang.Long classId)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectSelector for the specified classobject.

  Parameters:
    `classId` - the class id of interest
  Returns:
    the selector
  Throws:
    `IfsException` - if the operation fails
  (Published)

### findSelectorInCache

    public S_LibraryObjectSelector findSelectorInCache(java.lang.String className)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectSelector for the specified classobject.

  Parameters:
    `className` - the class name
  Returns:
    the selector
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMListSelectorItems

    public java.util.Vector DMListSelectorItems(java.lang.String searchClass,
                                                java.lang.String searchDefinition,
                                                boolean recursive,
                                                int maxItemCount,
                                                SortSpecification sort)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs an S_Selector and gets its items.

  Specified by:
    `DMListSelectorItems` in interface `S_LibrarySessionInterface`
  Parameters:
    `searchClass` - the classobject to search
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
    `sort` - the sort order
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSelectorItemCount

    public long DMGetSelectorItemCount(java.lang.String searchClass,
                                       java.lang.String searchDefinition,
                                       boolean recursive)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs an S_Selector and gets its number of items.

  Specified by:
    `DMGetSelectorItemCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `searchClass` - the classobject to search
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
  Returns:
    the number of items
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMOpenSelector

    public long DMOpenSelector(java.lang.String searchClass,
                               java.lang.String searchDefinition,
                               boolean recursive,
                               SortSpecification sort)
                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs and opens an S_Selector.

  Specified by:
    `DMOpenSelector` in interface `S_LibrarySessionInterface`
  Parameters:
    `searchClass` - the classobject to search
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
    `sort` - the sort order
  Returns:
    the selector sequence
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNextSelectorItem

    public S_LibraryObjectData DMNextSelectorItem(long selId)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the next item in the specified selector.

  Specified by:
    `DMNextSelectorItem` in interface `S_LibrarySessionInterface`
  Parameters:
    `selId` - the selector sequence
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNextSelectorBatch

    public java.util.Vector DMNextSelectorBatch(long selId,
                                                int batchSize)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the next batch of items for the specified selector.

  Specified by:
    `DMNextSelectorBatch` in interface `S_LibrarySessionInterface`
  Parameters:
    `selId` - the selector sequence
    `batchSize` - the maximum number of items to get
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCloseSelector

    public void DMCloseSelector(long selId)
                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Closes the specified selector.

  Specified by:
    `DMCloseSelector` in interface `S_LibrarySessionInterface`
  Parameters:
    `selId` - the selector sequence
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMListPreparedSelectorItems

    public java.util.Vector DMListPreparedSelectorItems(java.lang.String statementKey,
                                                        boolean distinct,
                                                        AttributeValue searchTarget,
                                                        AttributeValue[] auxSearchTargets,
                                                        java.lang.String searchDefinition,
                                                        boolean recursive,
                                                        java.lang.String language,
                                                        int maxItemCount,
                                                        int rowNumber,
                                                        java.lang.String hint,
                                                        SortSpecification sort,
                                                        AttributeValue[] bindValues)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs an S_PreparedSelector and gets its items.

  Specified by:
    `DMListPreparedSelectorItems` in interface `S_LibrarySessionInterface`
  Parameters:
    `statementKey` - the key to use for the prepared Selector
    `distinct` - whether to search using "distinct" clause
    `searchTarget` - the primary search target
    `auxSearchTargets` - the auxiliary search targets
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
    `language` - the search language to use
    `maxItemCount` - the maximum number of items to return
    `rowNumber` - the starting row number for the returned results
    `hint` - SQL hint for the main select
    `sort` - the sort order
    `bindValues` - the bind values
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetPreparedSelectorItemCount

    public int DMGetPreparedSelectorItemCount(java.lang.String statementKey,
                                              boolean distinct,
                                              AttributeValue searchTarget,
                                              AttributeValue[] auxSearchTargets,
                                              java.lang.String searchDefinition,
                                              boolean recursive,
                                              java.lang.String hint,
                                              AttributeValue[] bindValues)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs an S_PreparedSelector and gets its item count.

  Specified by:
    `DMGetPreparedSelectorItemCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `statementKey` - the key to use for the prepared Selector
    `distinct` - whether to search using "distinct" clause
    `searchTarget` - the primary search target
    `auxSearchTargets` - the auxiliary search targets
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
    `hint` - SQL hint to use for the main select
    `bindValues` - the bind values
  Returns:
    result count for the search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### verifyHasSelectorAccess

    protected void verifyHasSelectorAccess(java.lang.String classname)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that the specified classobject has ACCESSLEVEL_SELECTORACCESS.

  Parameters:
    `classname` - the name of the classobject
  Throws:
    `IfsException` - if the operation fails
  (Published)

### addSSelector

    protected void addSSelector(S_Selector sel)

  Description copied from class: `S_LibrarySession`
  Add the specified S_Selector to the set of S_Selectors for this S_LibrarySession.

  Parameters:
    `sel` - the selector
  (Published)

### findSSelector

    protected S_Selector findSSelector(long selId)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Get the specified S_Selector from the set of S_Selectors for this S_LibrarySession.

  Parameters:
    `selId` - the selector sequence
  Returns:
    the selector
  Throws:
    `IfsException` - if the operation fails
  (Published)

### removeSSelector

    protected void removeSSelector(long selId)

  Description copied from class: `S_LibrarySession`
  Removes the specified S_Selector from the set of S_Selectors for this S_LibrarySession.

  Parameters:
    `selId` - the selector sequence
  (Published)

### removeSSelector

    protected void removeSSelector(S_Selector sel)

  Description copied from class: `S_LibrarySession`
  Removes the specified S_Selector from the set of S_Selectors for this S_LibrarySession.

  Parameters:
    `sel` - the selector
  (Published)

### resolveSelectorWhereclause

    protected java.lang.String resolveSelectorWhereclause(java.lang.String searchClass,
                                                          java.lang.String searchDefinition,
                                                          boolean recursive)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds a "classid = n" expression to the specified S_Selector WHERE clause, if appropriate.

  Parameters:
    `searchClass` - the name of the classobject
    `searchDefinition` - the existing WHERE clause
    `recursive` - whether to include subclasses of `searchClass`
  Returns:
    the revised WHERE clause
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isPartitioningEnabled

    protected boolean isPartitioningEnabled()
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  checks whether or not partitioning is being used in this instnace. Defers to the service.

  Returns:
    true if partitioning is enabled
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMNewSearch

    public java.lang.Long DMNewSearch()
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs a new S_Search whose SearchSpecification is undefined.

  Specified by:
    `DMNewSearch` in interface `S_LibrarySessionInterface`
  Returns:
    the cursor sequence identifying the S_Search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNewSearchFromObject

    public java.lang.Long DMNewSearchFromObject(java.lang.Long searchObjectId)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs a new S_Search whose SearchSpecification is defined by the specified S_SearchObject.

  Specified by:
    `DMNewSearchFromObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `searchObjectId` - the id of the S_SearchObject
  Returns:
    the cursor sequence identifying the S_Search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSearchSpecification

    public SearchSpecification DMGetSearchSpecification(java.lang.Long srchId)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the SearchSpecification of the specified S_Search.

  Specified by:
    `DMGetSearchSpecification` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
  Returns:
    the search specification
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSetSearchSpecification

    public void DMSetSearchSpecification(java.lang.Long srchId,
                                         SearchSpecification sp)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the SearchSpecification of the specified S_Search.

  Specified by:
    `DMSetSearchSpecification` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMOpenSearch

    public void DMOpenSearch(java.lang.Long srchId,
                             java.util.Vector bindValues,
                             java.lang.String language,
                             int timeout)
                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Opens the specified S_Search.

  Specified by:
    `DMOpenSearch` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
    `bindValues` - the bind values
    `language` - the language to be used for search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMgetSearchItemCount

    public int DMgetSearchItemCount(java.lang.Long srchId,
                                    java.util.Vector bindValues,
                                    java.lang.String language,
                                    int timeout)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the item count for the specified S_Search.

  Specified by:
    `DMgetSearchItemCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
    `bindValues` - the bind values
    `language` - the language to be used for search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMgetSearchSQLString

    public java.lang.String DMgetSearchSQLString(java.lang.Long srchId)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the SQL string for the specified S_Search.

  Specified by:
    `DMgetSearchSQLString` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
  Returns:
    the SQL string for the search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNextSearchItems

    public java.util.Vector DMNextSearchItems(java.lang.Long srchId,
                                              int batchCount)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the next batch of items in the specified S_Search.

  Specified by:
    `DMNextSearchItems` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
    `batchCount` - the maximum number of items to get
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCloseSearch

    public void DMCloseSearch(java.lang.Long srchId)
                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Closes the specified S_Search.

  Specified by:
    `DMCloseSearch` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDisposeSearch

    public void DMDisposeSearch(java.lang.Long srchId)
                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Disposes the specified S_Search.

  Specified by:
    `DMDisposeSearch` in interface `S_LibrarySessionInterface`
  Parameters:
    `srchId` - the cursor sequence identifying the S_Search
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCreateView

    public void DMCreateView(ViewSpecification vsp)
                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a view for the specified ViewSpecification.

  Specified by:
    `DMCreateView` in interface `S_LibrarySessionInterface`
  Parameters:
    `vsp` - the ViewSpecification
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNExplainPlan

    public java.io.Serializable DYNExplainPlan(java.io.Serializable payload)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Generates the query plan for a S_Search.

  Parameters:
    `payload` - a Hashtable that holds the cursor sequence of the S_Search, bind values, plan name, plan table name, and whether to clear the plan table
  Returns:
    the contents of the plan table
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### registerCollection

    public void registerCollection(Collection collection,
                                   java.lang.String classname)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Registers a Collection so that it can be automatically reset by handleEvent as needed when new S_LibraryObjects are created, updated, or freed.

  Parameters:
    `collection` - the collection to register
    `classname` - the classobject name corresponding to the Java classname specified at collection construction
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### deregisterCollection

    public void deregisterCollection(Collection collection,
                                     java.lang.String classname)
                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Deregisters a collection, cancelling the event registration.

  Parameters:
    `collection` - the collection itself
    `classname` - the classname corresponding to the ClassObject name specified at collection construction
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getClassObjectCollection

    public final Collection getClassObjectCollection()
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_ClassObject collection.

  Specified by:
    `getClassObjectCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getClassObjectByName

    public final S_ClassObject getClassObjectByName(java.lang.String classname)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns a class object given a class name. This uses the ClassObjectCollection and is simply a convenience method.

  Parameters:
    `classname` - the name of a class
  Returns:
    the S_ClassObject
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getClassObjectValueByName

    public AttributeValue getClassObjectValueByName(java.lang.String name)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.

  Specified by:
    `getClassObjectValueByName` in interface `LibrarySessionInterface`
  Returns:
    the CLASSOBJECT value
  Throws:
    `IfsException` - if the operation fails
  (Published)

### findClassData

    public final S_ClassObjectData findClassData(java.lang.String className)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns an S_ClassObjectData given a class name. This uses the ClassObjectCollection and is simply a convenience method.

  Parameters:
    `className` - the name of a class
  Returns:
    the S_ClassObjectData
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getClassDomainCollection

    public final Collection getClassDomainCollection()
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_ClassDomain collection.

  Specified by:
    `getClassDomainCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getValueDefaultCollection

    public final Collection getValueDefaultCollection()
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_ValueDefault collection.

  Specified by:
    `getValueDefaultCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getValueDomainCollection

    public final Collection getValueDomainCollection()
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_ValueDomain collection.

  Specified by:
    `getValueDomainCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPolicyCollection

    public final Collection getPolicyCollection()
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_Policy collection.

  Specified by:
    `getPolicyCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPolicyListCollection

    public final Collection getPolicyListCollection()
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_PolicyList collection.

  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPermissionBundleCollection

    public final Collection getPermissionBundleCollection()
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_PermissionBundle collection.

  Specified by:
    `getPermissionBundleCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getExtendedPermissionCollection

    public final Collection getExtendedPermissionCollection()
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_ExtendedPermission collection.

  Specified by:
    `getExtendedPermissionCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getExtendedUserProfileCollection

    public final Collection getExtendedUserProfileCollection()
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_ExtendedUserProfile collection for this S_LibrarySessions user.

  Specified by:
    `getExtendedUserProfileCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getFormatCollection

    public final Collection getFormatCollection()
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_Format collection, organized by name.

  Specified by:
    `getFormatCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getFormatExtensionCollection

    public final Collection getFormatExtensionCollection()
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the S_Format collection, organized by extension.

  Specified by:
    `getFormatExtensionCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getMediaCollection

    public final Collection getMediaCollection()
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the Media collection.

  Specified by:
    `getMediaCollection` in interface `LibrarySessionInterface`
  Returns:
    the CachedSelectorCollection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSystemAccessControlListCollection

    public final Collection getSystemAccessControlListCollection()
                                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the SystemAccessControlList collection.

  Specified by:
    `getSystemAccessControlListCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSystemLockObjectCollection

    public final Collection getSystemLockObjectCollection()
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the SystemLockObject collection.

  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getClassAccessControlListCollection

    public final Collection getClassAccessControlListCollection()
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the ClassAccessControlList collection.

  Specified by:
    `getClassAccessControlListCollection` in interface `LibrarySessionInterface`
  Returns:
    the Collection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDirectoryUserCollection

    public final Collection getDirectoryUserCollection()
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a reference to the DirectoryUser collection.

  Specified by:
    `getDirectoryUserCollection` in interface `LibrarySessionInterface`
  Returns:
    the UncachedPreparedSelectorCollection
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDomainPropertyValue

    public final AttributeValue getDomainPropertyValue(java.lang.String name)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of a domain property, by name. If no property exists for the name specified, a null is returned.

  Parameters:
    `name` - the property name
  Returns:
    the property value, or null if no property exists for the name specified
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDomainPropertyBundle

    public final S_PropertyBundle getDomainPropertyBundle()
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the domain PropertyBundle. Can return null if there is no domain PropertyBundle, a condition that should only occur during an upgrade of a pre-9.0.3 schema.

  Returns:
    the domain PropertyBundle
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetArrayTypeAttributeValue

    public AttributeValue DMGetArrayTypeAttributeValue(long objectId,
                                                       long attributeId,
                                                       long auditId,
                                                       int count)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a fully resolved array-type AttributeValue with non-transient elements for the the specified object/attribute combination.

  This method is invoked when a bean-side array-type AttributeValue needs to obtains its elements from the server.

  Specified by:
    `DMGetArrayTypeAttributeValue` in interface `S_LibrarySessionInterface`
  Parameters:
    `objectId` - if this AttributeValue represents the value of a LibraryObject's Attribute, this is the id of that LibraryObject; -1 if this AttributeValue represents the value of a system audit entry property
    `attributeId` - if this AttributeValue represents the value of a LibraryObject's Attribute, this is the id of that Attribute; if this AttributeValue represents the value of a system audit entry property, this is the system audit entry property id
    `auditId` - if this AttributeValue represents the value of a system audit entry property or an audited LibraryObject's Attribute, this is the audit id; 0 if this AttributeValue represents the current value of a LibraryObject's Attribute
    `count` - the number of elements in the AttributeValue
  Returns:
    the AttributeValue
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getArrayTypeAttributeValue

    public AttributeValue getArrayTypeAttributeValue(AttributeValueArray av,
                                                     long objectId,
                                                     long attributeId,
                                                     long auditId,
                                                     int count)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  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.

  Specified by:
    `getArrayTypeAttributeValue` in interface `LibrarySessionInterface`
  Parameters:
    `av` - the AttributeValue of interest
    `objectId` - if this AttributeValue represents the value of a LibraryObject's Attribute, this is the id of that LibraryObject; -1 if this AttributeValue represents the value of a system audit entry property
    `attributeId` - if this AttributeValue represents the value of a LibraryObject's Attribute, this is the id of that Attribute; if this AttributeValue represents the value of a system audit entry property, this is the system audit entry property id
    `auditId` - if this AttributeValue represents the value of a system audit entry property or an audited LibraryObject's Attribute, this is the audit id; 0 if this AttributeValue represents the current value of a LibraryObject's Attribute
    `count` - the number of elements in the AttributeValue
  Returns:
    a fully-resolved copy of the AttributeValue
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getArrayTypeAttributeValue

    public static AttributeValue getArrayTypeAttributeValue(AttributeValueArray av,
                                                            long objectId,
                                                            long attributeId,
                                                            long auditId,
                                                            S_LibrarySession session,
                                                            LibraryConnection lconn,
                                                            java.sql.Connection conn)
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  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` - if this AttributeValue represents the value of a LibraryObject's Attribute, this is the id of that LibraryObject; -1 if this AttributeValue represents the value of a system audit entry property
    `attributeId` - if this AttributeValue represents the value of a LibraryObject's Attribute, this is the id of that Attribute; if this AttributeValue represents the value of a system audit entry property, this is the system audit entry property id
    `auditId` - if this AttributeValue represents the value of a system audit entry property or an audited LibraryObject's Attribute, this is the audit id; 0 if this AttributeValue represents the current value of a LibraryObject's Attribute
    `session` - the session, or null if not called from session context
    `lconn` - the LibraryConnection, or null if not called from session context
    `conn` - the JDBC connection
  Returns:
    a fully-resolved copy of the AttributeValue
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getArrayAttributeValueEntries

    protected java.lang.Object[] getArrayAttributeValueEntries(int dataType,
                                                               AttributeValue av)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the array of objects corresponding to an array-type AttributeValue.

  For internal use only. Do not use this method.

  There are two users of this method. S_LibraryObject uses this to get the primitive array of values used to create the rows in the array tables. S_LibrarySession uses this method to create system audit entry properties that are of array datatypes.

  Parameters:
    `dataType` - the dataType of the expected values
    `av` - the AttributeValue of interest
  Returns:
    the array of values
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetObjectReferenceAttribute

    public java.io.Serializable DMGetObjectReferenceAttribute(java.lang.Long id,
                                                              java.lang.Long classId,
                                                              java.lang.String attrName)
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified object-reference type attribute.

  Specified by:
    `DMGetObjectReferenceAttribute` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `attrName` - the name of the attribute
  Returns:
    the value
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetArrayReferencingObjects

    public java.util.Vector DMGetArrayReferencingObjects(java.lang.Long attributeId,
                                                         AttributeValue referencedValue,
                                                         SortSpecification sort)
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the set of object data for objects that are instances of the class on which the specified Attribute is defined, and whose array value contains the specified referenced value. This can be used, for example, to obtain all ACLs, whose "ComponentAcls" attribute (a PublicObjectArray) contains a specified ACL.

  Specified by:
    `DMGetArrayReferencingObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `attributeId` - the id of the array-type Attribute
    `referencedValue` - the referenced value
    `sort` - how the referencing objects will be sorted
  Returns:
    the set of S_LibraryObjectData objects for the objects that reference the value via the specified attribute
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMgetLibraryObjectData

    public S_LibraryObjectData DMgetLibraryObjectData(java.lang.Long id,
                                                      java.lang.Long classId,
                                                      java.lang.String attributeName,
                                                      boolean selectFully)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectData for the specified id and class id.

  Specified by:
    `DMgetLibraryObjectData` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
    `classId` - the id of the class
    `attributeName` - if non-null, the returned data will be selected at least as deeply as this attribute
    `selectFully` - if true, the returned data will be fully selected (i.e. as deep as possible)
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getLibraryObjectData

    protected S_LibraryObjectData getLibraryObjectData(java.lang.Long id,
                                                       java.lang.Long classId,
                                                       java.lang.String attributeName,
                                                       boolean selectFully)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectData for the specified id and class id.

  Parameters:
    `id` - the id of interest
    `classId` - the id of the class
    `attributeName` - if non-null, the returned data will be selected at least as deeply as this attribute
    `selectFully` - if true, the returned data will be fully selected (i.e. as deep as possible)
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Published)

### findLibraryObjectData

    protected final S_LibraryObjectData findLibraryObjectData(java.lang.Long id)
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Finds the S_LibraryObjectData in the data cache

  Parameters:
    `id` - the id of interest
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Published)

### constructLibraryObjectData

    protected S_LibraryObjectData constructLibraryObjectData(S_LibraryObjectSelector sel,
                                                             java.lang.Long id)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Construct an S_LibraryObjectData by singleton-selecting the specified object using the specified S_LibraryObjectSelector.

  Parameters:
    `sel` - the selector
    `id` - the id of the object
  Returns:
    the data; return null if the data cannot be discovered
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetPublicObjectData

    public S_LibraryObjectData DMGetPublicObjectData(java.lang.Long id,
                                                     java.lang.Long classId)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectData for the specified S_PublicObject.

  Specified by:
    `DMGetPublicObjectData` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
    `classId` - the classId of interest
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSystemObjectData

    public S_LibraryObjectData DMGetSystemObjectData(java.lang.Long id,
                                                     java.lang.Long classId)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectData for the specified S_SystemObject.

  Specified by:
    `DMGetSystemObjectData` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
    `classId` - the classId of interest
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSchemaObjectData

    public S_LibraryObjectData DMGetSchemaObjectData(java.lang.Long id,
                                                     java.lang.Long classId)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectData for the specified S_SchemaObject.

  Specified by:
    `DMGetSchemaObjectData` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
    `classId` - the classId of interest
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMResolveObjects

    public void DMResolveObjects(java.lang.Long[] ids,
                                 java.lang.Long[] classIds,
                                 ObjectResolverSpecification spec)
                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Force deeper resolution for the specified LibraryObjects

  Specified by:
    `DMResolveObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `ids` - the ids for the objects of interest
    `classIds` - the classIds for the objects of interest
    `spec` - the resolution specification
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getLibraryObjectDataVector

    public java.util.Vector getLibraryObjectDataVector(S_LibraryObject[] objs)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_LibraryObjectDatas for the specified S_LibraryObjects.

  Parameters:
    `objs` - the objects
  Returns:
    the datas
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getLibraryObject

    public S_LibraryObject getLibraryObject(java.lang.Long id,
                                            java.lang.Long classId)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_LibraryObject by id and classId.

  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### discoverLibraryObject

    public S_LibraryObject discoverLibraryObject(java.lang.Long id,
                                                 java.lang.Long classId)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_LibraryObject by ID and classId.

  If unable to discover it because of security, return null instead of throwing an exception

  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### discoverLibraryObject

    public S_LibraryObject discoverLibraryObject(java.lang.Long id)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_LibraryObject by ID, without knowing the class ID.

  If unable to discover it because of security, return null instead of throwing an exception

  Parameters:
    `id` - the id
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getLibraryObject

    public S_LibraryObject getLibraryObject(java.lang.Long id,
                                            java.lang.String className)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_LibraryObject by id and classobject name.

  Parameters:
    `id` - the id
    `className` - the name of the classobject
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getLibraryObject

    public S_LibraryObject getLibraryObject(S_LibraryObjectData data)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_LibraryObject by S_LibraryObjectData.

  Parameters:
    `data` - the data
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getLibraryObjects

    public S_LibraryObject[] getLibraryObjects(java.util.Vector vData)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Get the S_LibraryObjects for the specified S_LibraryObjectDatas.

  Parameters:
    `vData` - a Vector of S_LibraryObjectDatas
  Returns:
    the objects
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPublicObjectsByIds

    protected java.util.Vector getPublicObjectsByIds(java.lang.Long[] ids)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a set of S_PublicObjects from a set of IDs. Only return objects that are discoverable by the user.

  Parameters:
    `ids` - the ids
  Returns:
    the set of S_PublicObject that represent objects discoverable by this session; a null result can be returned if there are no objects
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetDiscoverabilityOfPublicObjectsIds

    public java.lang.Long[] DMGetDiscoverabilityOfPublicObjectsIds(java.lang.Long[] ids)
                                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Return indication as to which PublicObject objects specified (by ID) the current user can discover.

  The array specified contains the set of PublicObject IDs that are to be checked. A corresponding array is returned, which will be a clone of the one specified, with null values replaced for the IDs that correspond to objects the user cannot discover.

  Specified by:
    `DMGetDiscoverabilityOfPublicObjectsIds` in interface `S_LibrarySessionInterface`
  Parameters:
    `ids` - array of PublicObject IDs
  Returns:
    array containing the original values reflecting the objects that are discoverable by the user, and null values in the corresponding elements for objects the user cannot discover.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getDiscoverabilityOfPublicObjectsIds

    protected java.lang.Long[] getDiscoverabilityOfPublicObjectsIds(java.lang.Long[] ids)
                                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Return indication as to which PublicObject objects specified (by ID) the current user can discover.

  The array specified contains the set of PublicObject IDs that are to be checked. A corresponding array is returned, which will be a clone of the one specified, with null values replaced for the IDs that correspond to objects the user cannot discover.

  Parameters:
    `ids` - array of PublicObject IDs
  Returns:
    array containing the original values reflecting the objects that are discoverable by the user, and null values in the corresponding elements for objects the user cannot discover.
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPublicObject

    public S_PublicObject getPublicObject(java.lang.Long id,
                                          java.lang.Long classId)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_PublicObject by id and classId.

  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPublicObject

    public S_PublicObject getPublicObject(java.lang.Long id)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_PublicObject by id.

  Parameters:
    `id` - the id
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### discoverPublicObject

    public S_PublicObject discoverPublicObject(java.lang.Long id)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_PublicObject by id.

  Parameters:
    `id` - the id
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSystemObject

    public S_SystemObject getSystemObject(java.lang.Long id,
                                          java.lang.Long classId)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_SystemObject by id and classId.

  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSystemObject

    public S_SystemObject getSystemObject(java.lang.Long id)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_SystemObject by id.

  Parameters:
    `id` - the id
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSystemObjectsByIds

    protected java.util.Vector getSystemObjectsByIds(java.lang.Long[] ids)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a set of S_SystemObjects from a set of IDs.

  Parameters:
    `ids` - the ids
  Returns:
    the set of S_SystemObjects that represent objects discoverable by this session; a null result can be returned if there are no objects
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSchemaObject

    public S_SchemaObject getSchemaObject(java.lang.Long id,
                                          java.lang.Long classId)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_SchemaObject by id and classId.

  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSchemaObject

    public S_SchemaObject getSchemaObject(java.lang.Long id)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_SchemaObject by id.

  Parameters:
    `id` - the id
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSchemaObjectsByIds

    protected java.util.Vector getSchemaObjectsByIds(java.lang.Long[] ids)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a set of S_SchemaObjects from a set of IDs.

  Parameters:
    `ids` - the ids
  Returns:
    the set of S_SchemaObjects that represent objects discoverable by this session; a null result can be returned if there are no objects
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDirectoryObject

    public S_DirectoryObject getDirectoryObject(java.lang.Long id,
                                                java.lang.Long classId)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_DirectoryObject by id and classId.

  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDirectoryObject

    public S_DirectoryObject getDirectoryObject(java.lang.Long id)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an S_DirectoryObject by id.

  Parameters:
    `id` - the id
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPublicObjectInterface

    public PublicObjectInterface getPublicObjectInterface(java.lang.Long id)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the PublicObjectInterface for the specified id.

  Specified by:
    `getPublicObjectInterface` in interface `LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
  Returns:
    the PublicObjectInterface
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getPublicObjectInterfaces

    public PublicObjectInterface[] getPublicObjectInterfaces(java.lang.Long[] ids)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the PublicObjectInterfaces for the specified ids.

  Specified by:
    `getPublicObjectInterfaces` in interface `LibrarySessionInterface`
  Parameters:
    `ids` - the ids of interest
  Returns:
    the PublicObjectInterfaces
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSystemObjectInterface

    public SystemObjectInterface getSystemObjectInterface(java.lang.Long id)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the SystemObjectInterface for the specified id.

  Specified by:
    `getSystemObjectInterface` in interface `LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
  Returns:
    the SystemObjectInterface
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSystemObjectInterfaces

    public SystemObjectInterface[] getSystemObjectInterfaces(java.lang.Long[] ids)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the SystemObjectInterfaces for the specified ids.

  Specified by:
    `getSystemObjectInterfaces` in interface `LibrarySessionInterface`
  Parameters:
    `ids` - the ids of interest
  Returns:
    the SystemObjectInterfaces
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSchemaObjectInterface

    public SchemaObjectInterface getSchemaObjectInterface(java.lang.Long id)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the SchemaObjectInterface for the specified id.

  Specified by:
    `getSchemaObjectInterface` in interface `LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
  Returns:
    the SchemaObjectInterface
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getSchemaObjectInterfaces

    public SchemaObjectInterface[] getSchemaObjectInterfaces(java.lang.Long[] ids)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the SchemaObjectInterfaces for the specified ids.

  Specified by:
    `getSchemaObjectInterfaces` in interface `LibrarySessionInterface`
  Parameters:
    `ids` - the ids of interest
  Returns:
    the SchemaObjectInterfaces
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDirectoryObjectInterface

    public DirectoryObjectInterface getDirectoryObjectInterface(java.lang.Long id)
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the DirectoryObjectInterface for the specified id.

  Specified by:
    `getDirectoryObjectInterface` in interface `LibrarySessionInterface`
  Parameters:
    `id` - the id of interest
  Returns:
    the DirectoryObjectInterface
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getDirectoryObjectInterfaces

    public DirectoryObjectInterface[] getDirectoryObjectInterfaces(java.lang.Long[] ids)
                                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the DirectoryObjectInterfaces for the specified ids.

  Specified by:
    `getDirectoryObjectInterfaces` in interface `LibrarySessionInterface`
  Parameters:
    `ids` - the ids of interest
  Returns:
    the DirectoryObjectInterfaces
  Throws:
    `IfsException` - if the operation fails
  (Published)

### verifyPublicObject

    protected S_PublicObject verifyPublicObject(S_LibraryObject obj)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that the specified S_LibraryObject is an S_PublicObject.

  Parameters:
    `obj` - the object to test
  Throws:
    `(IFS-30003)` - if the object is not an S_PublicObject
    `IfsException`
  (Published)

### verifySystemObject

    protected S_SystemObject verifySystemObject(S_LibraryObject obj)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that the specified S_LibraryObject is an S_SystemObject.

  Parameters:
    `obj` - the object to test
  Throws:
    `(IFS-30003)` - if the object is not an S_SystemObject
    `IfsException`
  (Published)

### verifySchemaObject

    protected S_SchemaObject verifySchemaObject(S_LibraryObject obj)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that the specified S_LibraryObject is an S_SchemaObject.

  Parameters:
    `obj` - the object to test
  Throws:
    `(IFS-30003)` - if the object is not an S_SchemaObject
    `IfsException`
  (Published)

### verifyDirectoryObject

    protected S_DirectoryObject verifyDirectoryObject(S_LibraryObject obj)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies that the specified S_LibraryObject is an S_DirectoryObject.

  Parameters:
    `obj` - the object to test
  Throws:
    `(IFS-30003)` - if the object is not an S_DirectoryObject
    `IfsException`
  (Published)

### DMNewPublicObject

    public S_LibraryObjectData DMNewPublicObject(S_LibraryObjectDefinition def)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition.

  Specified by:
    `DMNewPublicObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `def` - the definition
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNewSystemObject

    public S_LibraryObjectData DMNewSystemObject(S_LibraryObjectDefinition def)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition.

  Specified by:
    `DMNewSystemObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `def` - the definition
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNewSchemaObject

    public S_LibraryObjectData DMNewSchemaObject(S_LibraryObjectDefinition def)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SchemaObject based on the specified S_LibraryObjectDefinition.

  Specified by:
    `DMNewSchemaObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `def` - the definition
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### newLibraryObject

    protected S_LibraryObject newLibraryObject(S_LibraryObjectDefinition def)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_LibraryObject based on the specified S_LibraryObjectDefinition.

  Parameters:
    `def` - the definition
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### newLibraryObject

    protected S_LibraryObject newLibraryObject(OperationState opState,
                                               S_LibraryObjectDefinition def)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_LibraryObject based on the specified S_LibraryObjectDefinition within an OperationState context.

  Parameters:
    `opState` - the operation state
    `def` - the definition
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### newPublicObject

    public S_PublicObject newPublicObject(S_LibraryObjectDefinition def)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition.

  Parameters:
    `def` - the definition for the new PublicObject
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### newPublicObject

    public S_PublicObject newPublicObject(OperationState opState,
                                          S_LibraryObjectDefinition def)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition within the specified OperationState context.

  If this isn't the originating operation (`opState` is non-null), the returned S_PublicObject will not have an ID until the originating operation completes. For this reason, consider using `createPublicObjectInstance`, which returns an AttributeValue, instead.

  Parameters:
    `opState` - the operation state
    `def` - the definition
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### newSystemObject

    public S_SystemObject newSystemObject(S_LibraryObjectDefinition def)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition.

  If this isn't the originating operation (`opState` is non-null), the returned S_SystemObject will not have an ID until the originating operation completes. For this reason, consider using `createSystemObjectInstance`, which returns an AttributeValue, instead.

  Parameters:
    `def` - the definition
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### newSystemObject

    public S_SystemObject newSystemObject(OperationState opState,
                                          S_LibraryObjectDefinition def)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition within the specified OperationState context.

  Parameters:
    `opState` - the operation state
    `def` - the definition
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### newSchemaObject

    public S_SchemaObject newSchemaObject(S_LibraryObjectDefinition def)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SchemaObject based on the specified S_LibraryObjectDefinition.

  Parameters:
    `def` - the definition
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### newSchemaObject

    public S_SchemaObject newSchemaObject(OperationState opState,
                                          S_LibraryObjectDefinition def)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition within the specified OperationState context.

  If this isn't the originating operation (`opState` is non-null), the returned S_SchemaObject will not have an ID until the originating operation completes. For this reason, consider using `createSchemaObjectInstance`, which returns an AttributeValue, instead.

  Parameters:
    `opState` - the operation state
    `def` - the definition
  Returns:
    the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### createPublicObjectInstance

    public AttributeValue createPublicObjectInstance(OperationState opState,
                                                     S_LibraryObjectDefinition sdef)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition within an OperationState context.

  This is identical to `newPublicObject`, except that the new object is returned as an AttributeValue.

  Parameters:
    `opState` - the operation state
    `sdef` - the definition
  Returns:
    an AttributeValue containing the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### createVersionedPublicObjectInstance

    protected AttributeValue createVersionedPublicObjectInstance(OperationState opState,
                                                                 S_LibraryObjectDefinition sdef)
                                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_PublicObject based on the specified S_LibraryObjectDefinition within an OperationState context.

  This is identical to `createPublicObjectInstance`, except that an exception is thrown if the new object would not be versionable.

  Parameters:
    `opState` - the operation state
    `sdef` - the definition
  Returns:
    an AttributeValue containing the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### createSystemObjectInstance

    public AttributeValue createSystemObjectInstance(OperationState opState,
                                                     S_LibraryObjectDefinition sdef)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SystemObject based on the specified S_LibraryObjectDefinition within an OperationState context.

  This is identical to `newSystemObject`, except that the new object is returned as an AttributeValue.

  Parameters:
    `opState` - the operation state
    `sdef` - the definition
  Returns:
    an AttributeValue containing the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### createSchemaObjectInstance

    public AttributeValue createSchemaObjectInstance(OperationState opState,
                                                     S_LibraryObjectDefinition sdef)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_SchemaObject based on the specified S_LibraryObjectDefinition within an OperationState context.

  This is identical to `newSchemaObject`, except that the new object is returned as an AttributeValue.

  Parameters:
    `opState` - the operation state
    `sdef` - the definition
  Returns:
    an AttributeValue containing the new object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### constructLibraryObject

    protected S_LibraryObject constructLibraryObject(S_LibraryObjectData data)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs an S_LibraryObject for the specified S_LibraryObjectData.

  Parameters:
    `data` - the data
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### constructLibraryObject

    protected S_LibraryObject constructLibraryObject(java.lang.Long class_id)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs a new, non-persistent S_LibraryObject.

  Parameters:
    `class_id` - the class id
  Returns:
    the object
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMSetAttributes

    public S_LibraryObjectDefinition DMSetAttributes(java.lang.Long id,
                                                     java.lang.Long classId,
                                                     S_LibraryObjectDefinition def)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Updates the specified S_LibraryObject.

  Specified by:
    `DMSetAttributes` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the classId
    `def` - the definition describing the update
  Returns:
    the definition specified, which might also include mutations applied during the update
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMLockRows

    public void DMLockRows(java.lang.Long id,
                           java.lang.Long classId)
                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Obtain a row-level lock on the specified object.

  Specified by:
    `DMLockRows` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the classId
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFree

    public void DMFree(java.lang.Long id,
                       java.lang.Long classId,
                       S_LibraryObjectDefinition def)
                throws IfsException

  Description copied from class: `S_LibrarySession`
  Frees the specified S_LibraryObject.

  Specified by:
    `DMFree` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the classId
    `def` - the definition describing the free
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRender

    public ContentStreamSerializer DMRender(java.lang.Long id,
                                            java.lang.Long classId,
                                            java.lang.String rendererType,
                                            java.lang.String rendererName,
                                            java.util.Hashtable options,
                                            boolean reader)
                                     throws IfsException

  Deprecated. iFS 9.0.3 see release notes for more information

  Description copied from class: `S_LibrarySession`
  Renders the specified S_LibraryObject.

  Specified by:
    `DMRender` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the class id
    `rendererType` - the type of the desired renderer
    `rendererName` - the name of the desired renderer
    `options` - any renderer-specific options
  Returns:
    a ContentStreamSerializer encapsulating the rendered representation of the S_LibraryObject
  Throws:
    `IfsException` - (IFS-30110) if the operation fails
  (Unpublished)

### DMCopyLibraryObject

    public S_LibraryObjectData DMCopyLibraryObject(java.lang.Long id,
                                                   java.lang.Long classId,
                                                   S_LibraryObjectDefinition sdef)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Copies the specified S_LibraryObject.

  Specified by:
    `DMCopyLibraryObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the classId
    `sdef` - the definition describing the copy
  Returns:
    the data of the copied object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSLibraryObjectDefinition

    public S_LibraryObjectDefinition DMGetSLibraryObjectDefinition(java.lang.Long id,
                                                                   java.lang.Long classId)
                                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Generates an S_LibraryObjectDefinition for the specified S_LibraryObject.

  Specified by:
    `DMGetSLibraryObjectDefinition` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    the definition
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetIdsForNewObjects

    public java.lang.Long[] DMGetIdsForNewObjects(int length)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns a set of objects that can be used to import new objects.

  Specified by:
    `DMGetIdsForNewObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `length` - the number of ids to return
  Returns:
    the array of Ids
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getClassObject

    public final S_ClassObject getClassObject(java.lang.Long classid)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_ClassObject for the specified class id.

  Do not use.

  Parameters:
    `classid` - the class id
  Returns:
    the classobject
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getClassName

    protected final java.lang.String getClassName(java.lang.Long classid)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the name of the S_ClassObject for the specified class id.

  Do not use.

  Parameters:
    `classid` - the class id
  Returns:
    the name
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsInstanceOfClassVersionable

    public boolean DMIsInstanceOfClassVersionable(java.lang.Long classId)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether an instance of the specified S_ClassObject is versionable.

  Specified by:
    `DMIsInstanceOfClassVersionable` in interface `S_LibrarySessionInterface`
  Parameters:
    `classId` - the class id of interest
  Returns:
    whether instances of that classobject are versionable
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### isInstanceOfClassVersionable

    protected boolean isInstanceOfClassVersionable(java.lang.Long classId)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether an instance of the specified S_ClassObject is versionable.

  Parameters:
    `classId` - the class id of interest
  Returns:
    whether instances of that classobject are versionable
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMAddAttributeToClassObject

    public java.lang.Long DMAddAttributeToClassObject(java.lang.Long id,
                                                      S_LibraryObjectDefinition def)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds an attribute to an existing classobject.

  Specified by:
    `DMAddAttributeToClassObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the existing classobject
    `def` - the definition of the new attribute
  Returns:
    the id of the new attribute
  Throws:
    `IfsException` - (IFS-30820) if the operation fails
  (Unpublished)

### DMRemoveAttributeFromClassObject

    public void DMRemoveAttributeFromClassObject(java.lang.Long id,
                                                 S_LibraryObjectDefinition def)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes an attribute from an existing classobject.

  Specified by:
    `DMRemoveAttributeFromClassObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the attribute
    `def` - a definition that influences how the attribute is removed, or null for default behavior
  Throws:
    `IfsException` - (IFS-30821) if the operation fails
  (Unpublished)

### getAttributeSortName

    public java.lang.String getAttributeSortName(java.lang.String classname,
                                                 java.lang.String attributename)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the database object name of the specified attribute.

  Specified by:
    `getAttributeSortName` in interface `LibrarySessionInterface`
  Parameters:
    `classname` - the name of the classobject
    `attributename` - the name of the attribute
  Returns:
    the database object name of the attribute
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetResolvedClassObjectData

    public S_ClassObjectData DMGetResolvedClassObjectData(java.lang.Long id)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the fully-resolved S_ClassObjectData.

  Specified by:
    `DMGetResolvedClassObjectData` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsVersionable

    public boolean DMIsVersionable(java.lang.Long id,
                                   java.lang.Long classId)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether the specified S_PublicObject is versionable.

  Specified by:
    `DMIsVersionable` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the classId
  Returns:
    whether the object is versionable
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDelete

    public void DMDelete(java.lang.Long id,
                         java.lang.Long classId,
                         S_LibraryObjectDefinition def)
                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Deletes the specified S_PublicObject.

  Specified by:
    `DMDelete` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the class id
    `def` - the definition object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMUndelete

    public void DMUndelete(java.lang.Long id,
                           java.lang.Long classId,
                           S_LibraryObjectDefinition def)
                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Undeletes the specified S_PublicObject.

  Specified by:
    `DMUndelete` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the class id
    `def` - the definition object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getWastebasketSelector

    protected S_Selector getWastebasketSelector(java.lang.String searchClass,
                                                java.lang.String searchDefinition,
                                                boolean recursive)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs a wastebasket S_Selector.

  Parameters:
    `searchClass` - the classobject to search, e.g. FOLDER
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
  Returns:
    the selector
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMListWastebasketSelectorItems

    public java.util.Vector DMListWastebasketSelectorItems(java.lang.String searchClass,
                                                           java.lang.String searchDefinition,
                                                           boolean recursive,
                                                           SortSpecification sort)
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs a wastebasket S_Selector and gets its items.

  Specified by:
    `DMListWastebasketSelectorItems` in interface `S_LibrarySessionInterface`
  Parameters:
    `searchClass` - the classobject to search, e.g. FOLDER
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
    `sort` - the sort order
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### listWastebasketSelectorItems

    protected java.util.Vector listWastebasketSelectorItems(java.lang.String searchClass,
                                                            java.lang.String searchDefinition,
                                                            boolean recursive,
                                                            SortSpecification sort)
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs a wastebasket S_Selector and gets its items.

  Parameters:
    `searchClass` - the classobject to search, e.g. FOLDER
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
    `sort` - the sort order
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetWastebasketSelectorItemCount

    public long DMGetWastebasketSelectorItemCount(java.lang.String searchClass,
                                                  java.lang.String searchDefinition,
                                                  boolean recursive)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs a wastebasket S_Selector and gets its number of items.

  Specified by:
    `DMGetWastebasketSelectorItemCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `searchClass` - the classobject to search, e.g. FOLDER
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMOpenWastebasketSelector

    public long DMOpenWastebasketSelector(java.lang.String searchClass,
                                          java.lang.String searchDefinition,
                                          boolean recursive,
                                          SortSpecification sort)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs and opens a wastebasket S_Selector.

  Specified by:
    `DMOpenWastebasketSelector` in interface `S_LibrarySessionInterface`
  Parameters:
    `searchClass` - the classobject to search
    `searchDefinition` - the WHERE clause
    `recursive` - whether to search subclasses of `searchClass`
    `sort` - the sort order
  Returns:
    the selector sequence
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMEmptyWastebasket

    public void DMEmptyWastebasket()
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Empties the user's (or feigned user's, if applicable) wastebasket.

  Specified by:
    `DMEmptyWastebasket` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### emptyWastebasket

    protected void emptyWastebasket(S_DirectoryObject user)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Empties the user's (or feigned user's, if applicable) wastebasket.

  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### addLockedForSessionObject

    protected void addLockedForSessionObject(S_PublicObject obj)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds the specified S_PublicObject to this S_LibrarySession's internal table of session-locked objects.

  Parameters:
    `obj` - the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### addLockedForSessionObject

    protected void addLockedForSessionObject(java.lang.Long objid)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds the specified S_PublicObject to this S_LibrarySession's internal table of session-locked objects.

  Parameters:
    `objid` - the id of the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### removeLockedForSessionObject

    protected void removeLockedForSessionObject(S_PublicObject obj)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes the specified S_PublicObject from this S_LibrarySession's internal table of session-locked objects.

  Parameters:
    `obj` - the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### removeLockedForSessionObject

    protected void removeLockedForSessionObject(java.lang.Long objid)

  Description copied from class: `S_LibrarySession`
  Removes the specified S_PublicObject from this S_LibrarySession's internal table of session-locked objects.

  Parameters:
    `objid` - the id of the object
  (Unpublished)

### DMGetLockedForSessionObjects

    public java.util.Vector DMGetLockedForSessionObjects()
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the objects in this S_LibrarySession's internal table of session-locked objects.

  Specified by:
    `DMGetLockedForSessionObjects` in interface `S_LibrarySessionInterface`
  Returns:
    a Vector of S_LibraryObjectData
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetPublicObjectsReferringToLockObject

    public java.util.Vector DMGetPublicObjectsReferringToLockObject(java.lang.Long id,
                                                                    java.lang.Long classid,
                                                                    SortSpecification sort)
                                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the PO's that reference this LockObject

  Specified by:
    `DMGetPublicObjectsReferringToLockObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the lockobject
    `classid` - the class id of the lockobject
    `sort` - the sortspecification to be used
  Returns:
    a Vector of S_LibraryObjectData
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsLockObjectShared

    public boolean DMIsLockObjectShared(java.lang.Long id,
                                        java.lang.Long classid)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Verifies if the LockObject is shared

  Specified by:
    `DMIsLockObjectShared` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the lockobject
    `classid` - the class id of the lockobject
  Returns:
    true or false depending on if this lockobject is shared
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMConvertToPrivateACL

    public S_LibraryObjectData DMConvertToPrivateACL(java.lang.Long id,
                                                     java.lang.Long classId,
                                                     S_LibraryObjectDefinition sdef)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Makes the specified S_PublicObject have a private S_AccessControlList.

  Specified by:
    `DMConvertToPrivateACL` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `sdef` - the definition to use in performing the ACL copy
  Returns:
    the data of the private ACL
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMfetchACEs

    public java.lang.Long[] DMfetchACEs(java.lang.Long id,
                                        java.lang.Long classId)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_AccessControlEntries for the specified S_AccessControlList.

  Specified by:
    `DMfetchACEs` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id the ACL
    `classId` - the class id of the ACL
  Returns:
    an array of ACE IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetAccessLevel

    public AccessLevel DMGetAccessLevel(java.lang.Long id,
                                        java.lang.Long classId,
                                        java.lang.Long userId)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the AccessLevel of the specified S_DirectoryUser for the specified S_AccessControlList.

  Specified by:
    `DMGetAccessLevel` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the ACL
    `classId` - the class id of the ACL
    `userId` - the id of the user
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMaddAccessControlEntry

    public S_LibraryObjectData DMaddAccessControlEntry(java.lang.Long id,
                                                       java.lang.Long classId,
                                                       S_LibraryObjectDefinition sdef)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds an S_AccessControlEntry to the specified S_AccessControlList.

  Specified by:
    `DMaddAccessControlEntry` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id the ACL
    `classId` - the class id of the ACL
    `sdef` - the access control entry definition
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMupdateAccessControlEntry

    public void DMupdateAccessControlEntry(java.lang.Long id,
                                           java.lang.Long classId,
                                           java.lang.Long aceId,
                                           java.lang.Long aceClassId,
                                           S_LibraryObjectDefinition sdef)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Updates an S_AccessControlEntry in the specified S_AccessControlList.

  Specified by:
    `DMupdateAccessControlEntry` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id the ACL
    `classId` - the class id of the ACL
    `aceId` - the id of the ACE
    `aceClassId` - the class id of the ACE
    `sdef` - the access control entry definition
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRemoveAccessControlEntry

    public void DMRemoveAccessControlEntry(java.lang.Long id,
                                           java.lang.Long classId,
                                           java.lang.Long aceId,
                                           java.lang.Long aceClassId)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes an S_AccessControlEntry in the specified S_AccessControlList.

  Specified by:
    `DMRemoveAccessControlEntry` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id the ACL
    `classId` - the class id of the ACL
    `aceId` - the id of the ACE
    `aceClassId` - the class id of the ACE
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMremoveAllAccessControlEntries

    public void DMremoveAllAccessControlEntries(java.lang.Long id,
                                                java.lang.Long classId)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes all S_AccessControlEntries from the specified S_AccessControlList.

  Specified by:
    `DMremoveAllAccessControlEntries` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id the ACL
    `classId` - the class id of the ACL
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMApplyAclIndexDeferredUpdate

    public void DMApplyAclIndexDeferredUpdate(AccessControlListDeferredUpdate entry,
                                              boolean deleteAfterProcessing)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Forces re-calculation of an ACL's discoverer table.

  Specified by:
    `DMApplyAclIndexDeferredUpdate` in interface `S_LibrarySessionInterface`
  Parameters:
    `entry` - the ACL index deferred entry
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetAclIndexDeferredUpdates

    public java.util.Vector DMGetAclIndexDeferredUpdates(int maxItems)
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  gets a set of Deferred ACL Resolution Entries

  Specified by:
    `DMGetAclIndexDeferredUpdates` in interface `S_LibrarySessionInterface`
  Parameters:
    `maxItems` - the maximum number of entries to return
  Returns:
    a vector of AccessControlListDeferredUpdate, or null if no entries
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDeleteAclIndexDeferredUpdates

    public void DMDeleteAclIndexDeferredUpdates(java.lang.Long[] ids)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  deletes a set of Deferred ACL Resolution Entries

  Specified by:
    `DMDeleteAclIndexDeferredUpdates` in interface `S_LibrarySessionInterface`
  Parameters:
    `ids` - the set of AccessControlListDeferredUpdate IDs to delete
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsAclIndexUpdateModeSynchronous

    public boolean DMIsAclIndexUpdateModeSynchronous()
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  determine if ACL index update mode is synchronous

  Specified by:
    `DMIsAclIndexUpdateModeSynchronous` in interface `S_LibrarySessionInterface`
  Returns:
    true if update mode is synchronous; false otherwise
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### findOrConstructAclResolver

    protected AccessControlListResolver findOrConstructAclResolver(java.lang.Long key)
                                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Finds a previously constructed uncommitted AccessControlListResolver, or failing that, a commited AccessControlListResolver for the specified id.

  Parameters:
    `key` - the id
  Returns:
    the ACL resolver
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getComponentAclsAttributeId

    protected java.lang.Long getComponentAclsAttributeId()
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns the ID of the Attribute object for the AccessControlList.ComponentAcls attribute. This is used to select all composite ACLs that reference a specific ACL as a component ACL.

  Returns:
    the ACL resolver
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCreateRetainedEventDatabaseObjects

    public void DMCreateRetainedEventDatabaseObjects(RetainedEvent event)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Create tables associated with a RetainedEvent type

  Specified by:
    `DMCreateRetainedEventDatabaseObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `event` - the RetainedEvent
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDropRetainedEventDatabaseObjects

    public void DMDropRetainedEventDatabaseObjects(RetainedEvent event)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Drop tables associated with a RetainedEvent type

  Specified by:
    `DMDropRetainedEventDatabaseObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `event` - the RetainedEvent
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMInsertRetainedEvent

    public void DMInsertRetainedEvent(RetainedEvent event)
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Add a retained event

  Specified by:
    `DMInsertRetainedEvent` in interface `S_LibrarySessionInterface`
  Parameters:
    `event` - the RetainedEvent
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDeleteRetainedEvent

    public void DMDeleteRetainedEvent(RetainedEvent event)
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete a RetainedEvent

  Specified by:
    `DMDeleteRetainedEvent` in interface `S_LibrarySessionInterface`
  Parameters:
    `event` - the RetainedEvent
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetRetainedEvents

    public RetainedEvent[] DMGetRetainedEvents(RetainedEvent event,
                                               int maxItems)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Select RetainedEvents

  Specified by:
    `DMGetRetainedEvents` in interface `S_LibrarySessionInterface`
  Parameters:
    `event` - the RetainedEvent type to select
    `maxItems` - the maximum items to return
  Returns:
    the set of RetainedEvents
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMAddRelationship

    public S_LibraryObjectData DMAddRelationship(java.lang.Long id,
                                                 java.lang.Long classId,
                                                 S_LibraryObjectDefinition rdef)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds a relationship for the specified S_PublicObject.

  Specified by:
    `DMAddRelationship` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
  Returns:
    the data of the new relationship
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRemoveRelationship

    public void DMRemoveRelationship(java.lang.Long id,
                                     java.lang.Long classId,
                                     java.lang.Long relId,
                                     java.lang.Long relClassId)
                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes a relationship from the specified S_PublicObject.

  Specified by:
    `DMRemoveRelationship` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `relId` - the id of the relationship
    `relClassId` - the class id of the relationship
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetRightwardRelationships

    public java.util.Vector DMGetRightwardRelationships(java.lang.Long id,
                                                        java.lang.Long classId,
                                                        java.lang.Long relClassId,
                                                        SortSpecification sort)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the rightward relationships for the specified S_PublicObject.

  Specified by:
    `DMGetRightwardRelationships` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `relClassId` - the class id of the relationship
    `sort` - the sort specification
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetRightwardRelationshipObjects

    public java.util.Vector DMGetRightwardRelationshipObjects(java.lang.Long id,
                                                              java.lang.Long classId,
                                                              java.lang.Long relClassId,
                                                              SortSpecification sort)
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the target objects of the rightward relationships for the specified S_PublicObject.

  Specified by:
    `DMGetRightwardRelationshipObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `relClassId` - the class id of the relationship
    `sort` - the sort specification
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetLeftwardRelationships

    public java.util.Vector DMGetLeftwardRelationships(java.lang.Long id,
                                                       java.lang.Long classId,
                                                       java.lang.Long relClassId,
                                                       SortSpecification sort)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the leftward relationships for the specified S_PublicObject.

  Specified by:
    `DMGetLeftwardRelationships` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `relClassId` - the class id of the relationship
    `sort` - the sort specification
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetLeftwardRelationshipObjects

    public java.util.Vector DMGetLeftwardRelationshipObjects(java.lang.Long id,
                                                             java.lang.Long classId,
                                                             java.lang.Long relClassId,
                                                             SortSpecification sort)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the target objects of the leftward relationships for the specified S_PublicObject.

  Specified by:
    `DMGetLeftwardRelationshipObjects` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `relClassId` - the class id of the relationship
    `sort` - the sort specification
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetLeftwardRelationshipsCount

    public long DMGetLeftwardRelationshipsCount(java.lang.Long id,
                                                java.lang.Long classId,
                                                java.lang.Long relClassId)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the number of leftward relationships for the specified S_PublicObject.

  Specified by:
    `DMGetLeftwardRelationshipsCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classId` - the class id of the object
    `relClassId` - the class id of the relationship
  Returns:
    the relationship count
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMAddToFolder

    public void DMAddToFolder(java.lang.Long folder_id,
                              java.lang.Long classid,
                              java.lang.Long rightObj,
                              java.lang.Long rightObjClassid)
                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds the specified item to the specified S_Folder.

  Specified by:
    `DMAddToFolder` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id of the folder
    `classid` - the class id of the folder
    `rightObj` - the id of the item
    `rightObjClassid` - the class id of the item
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMAddFolderRelationship

    public void DMAddFolderRelationship(java.lang.Long id,
                                        java.lang.Long classid,
                                        S_LibraryObjectDefinition rdef)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds an item to the specified S_Folder.

  Specified by:
    `DMAddFolderRelationship` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the folder
    `classid` - the class id of the folder
    `rdef` - the definition of the folder relationship
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRemoveFromFolder

    public void DMRemoveFromFolder(java.lang.Long folder_id,
                                   java.lang.Long classid,
                                   java.lang.Long rightObj,
                                   java.lang.Long rightObjClassid,
                                   S_LibraryObjectDefinition def)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes the specified item from the specified S_Folder.

  Specified by:
    `DMRemoveFromFolder` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id of the folder
    `classid` - the class id of the folder
    `rightObj` - the id of the item
    `rightObjClassid` - the class id of the item
    `def` - the definition containing options
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetFolderItemCount

    public long DMGetFolderItemCount(java.lang.Long id,
                                     java.lang.Long classId,
                                     java.lang.String folderRelClassname)
                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the number of items in the specified S_Folder.

  Specified by:
    `DMGetFolderItemCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the class id
    `folderRelClassname` - the name of the folder relationship classobject
  Returns:
    the item count
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSubfolderCount

    public long DMGetSubfolderCount(java.lang.Long id,
                                    java.lang.Long classId,
                                    java.lang.String folderRelClassname)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the number of folders in the specified S_Folder.

  Specified by:
    `DMGetSubfolderCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the class id
    `folderRelClassname` - the name of the folder relationship classobject
  Returns:
    the item count
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMListItems

    public java.util.Vector DMListItems(java.lang.Long folder_id,
                                        java.lang.Long classid,
                                        java.lang.String folderRelClassname,
                                        SortSpecification sort)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the items in the specified S_Folder.

  Specified by:
    `DMListItems` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id
    `classid` - the class id
    `folderRelClassname` - the name of the folder relationship classobject
    `sort` - the sort specification
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetFolderItemList

    public java.lang.Long[] DMGetFolderItemList(java.lang.Long folder_id,
                                                java.lang.Long classid,
                                                SortSpecification sort)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the item IDs in the specified Folder.

  Specified by:
    `DMGetFolderItemList` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id
    `classid` - the class id
    `sort` - the sort specification
  Returns:
    an array of object IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetTotalFolderItemCount

    public int DMGetTotalFolderItemCount(java.lang.Long folder_id,
                                         java.lang.Long classid)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the count of items in a folder, including undiscoverable items.

  Specified by:
    `DMGetTotalFolderItemCount` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id
    `classid` - the class id
  Returns:
    the count of items
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFolderHasSubFolders

    public boolean DMFolderHasSubFolders(java.lang.Long folder_id,
                                         java.lang.Long classid)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns true if the folder has subfolders. This takes into account even the subfolders that are not discoverable.

  Specified by:
    `DMFolderHasSubFolders` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id
    `classid` - the class id
  Returns:
    the count of items
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMOpenFolder

    public void DMOpenFolder(java.lang.Long folder_id,
                             java.lang.Long classid,
                             java.lang.String folderRelClassname,
                             SortSpecification sort)
                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Opens the items in the specified S_Folder.

  Specified by:
    `DMOpenFolder` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id
    `classid` - the class id
    `folderRelClassname` - the name of the folder relationship classobject
    `sort` - the sort specification
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNextFolderItem

    public S_LibraryObjectData DMNextFolderItem(java.lang.Long folder_id,
                                                java.lang.Long classid)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the next item in the specified S_Folder.

  Specified by:
    `DMNextFolderItem` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id
    `classid` - the class id
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCloseFolder

    public void DMCloseFolder(java.lang.Long folder_id,
                              java.lang.Long classid)
                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Closes the specified S_Folder.

  Specified by:
    `DMCloseFolder` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id
    `classid` - the class id
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFindPublicObjectByPath

    public S_LibraryObjectData DMFindPublicObjectByPath(java.lang.Long folder_id,
                                                        java.lang.Long classid,
                                                        java.lang.String path)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Finds an S_PublicObject by its path relative to a specified S_Folder.

  Specified by:
    `DMFindPublicObjectByPath` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id of the folder
    `classid` - the class id of the folder
    `path` - the relative path
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCheckExistenceOfPublicObjectByPath

    public boolean DMCheckExistenceOfPublicObjectByPath(java.lang.Long folder_id,
                                                        java.lang.Long classid,
                                                        java.lang.String path)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Checks whether there exists an S_PublicObject at a path relative to a specified S_Folder.

  Specified by:
    `DMCheckExistenceOfPublicObjectByPath` in interface `S_LibrarySessionInterface`
  Parameters:
    `folder_id` - the id of the folder
    `classid` - the class id of the folder
    `path` - the relative path
  Returns:
    whether the object exists
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetAnyFolderPath

    public java.lang.String DMGetAnyFolderPath(java.lang.Long id,
                                               java.lang.Long classid,
                                               java.lang.Long folderRefId,
                                               java.lang.Long folderRefClassid,
                                               FolderPathOptions fpo,
                                               SortSpecification sort)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Return a folder path to an object, or null if there is no reachable path.

  Specified by:
    `DMGetAnyFolderPath` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classid` - the class id of the object
    `folderRefId` - the id of the relative folder (null indicates root)
    `folderRefClassid` - the class id of the relative folder (null indicates root)
    `fpo` - Options describing the path determination operation; optional; if null is specified, default beahvior will be in force.
    `sort` - how referencing folders are to be sorted
  Returns:
    the path to the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetConsumedStorage

    public long DMGetConsumedStorage(java.lang.Long id,
                                     java.lang.Long classid)
                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns the storage (in bytes) consumed by a given public object.

  Specified by:
    `DMGetConsumedStorage` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - id of the object
    `classid` - class id of the object
  Returns:
    storage consumed by the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetAllFolderPaths

    public java.lang.String[] DMGetAllFolderPaths(java.lang.Long id,
                                                  java.lang.Long classid,
                                                  java.lang.Long folderRefId,
                                                  java.lang.Long folderRefClassid,
                                                  FolderPathOptions fpo,
                                                  SortSpecification sort)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Return all reachable folder paths to an object, or null if there is no reachable path.

  Specified by:
    `DMGetAllFolderPaths` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the object
    `classid` - the class id of the object
    `folderRefId` - the id of the relative folder (null indicates root)
    `folderRefClassid` - the class id of the relative folder (null indicates root)
    `fpo` - Options describing the path determination operation; optional; if null is specified, default beahvior will be in force.
    `sort` - how referencing folders are to be sorted
  Returns:
    the paths to the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetFolderReferences

    public java.lang.Long[] DMGetFolderReferences(java.lang.Long PublicObject_id,
                                                  java.lang.Long classid,
                                                  SortSpecification sort)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_Folders that contain the specified S_PublicObject.

  Specified by:
    `DMGetFolderReferences` in interface `S_LibrarySessionInterface`
  Parameters:
    `PublicObject_id` - the id
    `classid` - the class id
    `sort` - the sort specification
  Returns:
    an array of Folder IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNListAllFoldersWithSubfolders

    public java.io.Serializable DYNListAllFoldersWithSubfolders(java.io.Serializable payload)
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets all S_Folders that have one or more subfolders.

  Parameters:
    `payload` - unused
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNGetUnreferencedContentObjectList

    public java.io.Serializable DYNGetUnreferencedContentObjectList(java.io.Serializable payload)
                                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets List of all unreferenced ContentObjects

  Parameters:
    `payload` - INteger batch size
  Returns:
    an ArrayList of ContentObject IDs
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMAddMemberToDirectoryGroup

    public void DMAddMemberToDirectoryGroup(java.lang.Long group_id,
                                            java.lang.Long classid,
                                            java.lang.Long member_id,
                                            java.lang.Long memberClassid)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds the specified S_DirectoryObject to the specified S_DirectoryGroup.

  Specified by:
    `DMAddMemberToDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `group_id` - the id of the group
    `classid` - the class id of the group
    `member_id` - the id of the object
    `memberClassid` - the class id of the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRemoveMemberFromDirectoryGroup

    public void DMRemoveMemberFromDirectoryGroup(java.lang.Long group_id,
                                                 java.lang.Long classid,
                                                 java.lang.Long member_id,
                                                 java.lang.Long memberClassid)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes the specified S_DirectoryObject from the specified S_DirectoryGroup.

  Specified by:
    `DMRemoveMemberFromDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `group_id` - the id of the group
    `classid` - the class id of the group
    `member_id` - the id of the object
    `memberClassid` - the class id of the object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMAddMembersToDirectoryGroup

    public void DMAddMembersToDirectoryGroup(java.lang.Long group_id,
                                             java.lang.Long classid,
                                             java.lang.Long[] rightObjIds,
                                             java.lang.Long[] rightObjClassids)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Adds the specified S_DirectoryObjects to the specified S_DirectoryGroup.

  Specified by:
    `DMAddMembersToDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `group_id` - the id of the group
    `classid` - the class id of the group
    `rightObjIds` - the ids of the objects
    `rightObjClassids` - the class ids of the objects
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRemoveMembersFromDirectoryGroup

    public void DMRemoveMembersFromDirectoryGroup(java.lang.Long group_id,
                                                  java.lang.Long classid,
                                                  java.lang.Long[] rightObjIds,
                                                  java.lang.Long[] rightObjClassids)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Removes the specified S_DirectoryObjects from the specified S_DirectoryGroup.

  Specified by:
    `DMRemoveMembersFromDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `group_id` - the id of the group
    `classid` - the class id of the group
    `rightObjIds` - the ids of the objects
    `rightObjClassids` - the class ids of the objects
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetDirectMembersOfDirectoryGroup

    public java.lang.Long[] DMGetDirectMembersOfDirectoryGroup(java.lang.Long id,
                                                               java.lang.Long classid,
                                                               boolean filterForDiscoverability)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the direct members of the specified S_DirectoryGroup.

  Specified by:
    `DMGetDirectMembersOfDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the group
    `classid` - the class id of the group
    `filterForDiscoverability` - true if returned ID set reflects the members the session could discover
  Returns:
    id array
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetAllMembersOfDirectoryGroup

    public java.lang.Long[] DMGetAllMembersOfDirectoryGroup(java.lang.Long id,
                                                            java.lang.Long classid,
                                                            boolean filterForDiscoverability)
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets all members of the specified S_DirectoryGroup.

  Specified by:
    `DMGetAllMembersOfDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the group
    `classid` - the class id of the group
    `filterForDiscoverability` - true if returned ID set reflects the members the session could discover
  Returns:
    an array of IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsDirectMemberOfDirectoryGroup

    public boolean DMIsDirectMemberOfDirectoryGroup(java.lang.Long groupId,
                                                    java.lang.Long groupClassId,
                                                    java.lang.Long memberId,
                                                    java.lang.Long memberClassId)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Check whether the specified DirectoryObject is a direct member of the specified group.

  Specified by:
    `DMIsDirectMemberOfDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `groupId` - the id of the group
    `groupClassId` - the class id of the group
    `memberId` - the id of the group
    `memberClassId` - the class id of the group
  Returns:
    true if a member; false otherwise
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsMemberOfDirectoryGroup

    public boolean DMIsMemberOfDirectoryGroup(java.lang.Long groupId,
                                              java.lang.Long groupClassId,
                                              java.lang.Long memberId,
                                              java.lang.Long memberClassId)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Check whether the specified DirectoryObject is a member of the specified group, directly or indirectly.

  Specified by:
    `DMIsMemberOfDirectoryGroup` in interface `S_LibrarySessionInterface`
  Parameters:
    `groupId` - the id of the group
    `groupClassId` - the class id of the group
    `memberId` - the id of the group
    `memberClassId` - the class id of the group
  Returns:
    true if a member; false otherwise
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMInvalidateTokenCredentials

    public void DMInvalidateTokenCredentials(java.lang.Long userId)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Invalidates all the token credentials for a given user.

  Specified by:
    `DMInvalidateTokenCredentials` in interface `S_LibrarySessionInterface`
  Parameters:
    `userId` - ID of user whose token credentials need to be invalidated.
  Throws:
    `IfsException` - (IFS-10191) if the operation fails
  (Unpublished)

### invalidateTokenCredentials

    public void invalidateTokenCredentials(java.lang.Long userId)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Invalidates any previously-created TokenCredential for the specified user.

  Parameters:
    `userId` - id of the user whose token credentials need to be invalidated
  Throws:
    `IfsException` - (IFS-10189) if the operation fails
  (Published)

### DYNGetSystemUserToken

    public java.io.Serializable DYNGetSystemUserToken(java.io.Serializable payload)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the system token that can be used to efficiently clone system sessions.

  Parameters:
    `payload` - ignored
  Returns:
    the system user token
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getInvalidateTokenCredentialsStatement

    protected static java.sql.PreparedStatement getInvalidateTokenCredentialsStatement(LibraryConnection lconn,
                                                                                       java.sql.Connection conn)
                                                                                throws java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Gets the PreparedStatement to invalidate user's token credentials

  Parameters:
    `lconn` - the CM SDK connection
    `conn` - the JDBC connection
  Returns:
    the statement
  Throws:
    `java.sql.SQLException` - if the operation fails
  (Unpublished)

### DMGetDirectAncestorsOfDirectoryObject

    public java.lang.Long[] DMGetDirectAncestorsOfDirectoryObject(java.lang.Long id,
                                                                  java.lang.Long classid)
                                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the direct ancestors of the specified S_DirectoryGroup.

  Specified by:
    `DMGetDirectAncestorsOfDirectoryObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the group
    `classid` - the class id of the group
  Returns:
    an array of IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetAllAncestorsOfDirectoryObject

    public java.lang.Long[] DMGetAllAncestorsOfDirectoryObject(java.lang.Long id,
                                                               java.lang.Long classid)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets all ancestors of the specified S_DirectoryGroup.

  Specified by:
    `DMGetAllAncestorsOfDirectoryObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the group
    `classid` - the class id of the group
  Returns:
    an array of IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetCategoryIds

    public java.lang.Long[] DMGetCategoryIds(java.lang.Long id,
                                             java.lang.Long classid)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets all category IDs for the specified S_PublicObject or S_SystemObject or S_SchemaObject For publicobjects, it returns only the set of ID's that represents Categories that the current session can discover (which in general should always be all of the categories, since the ACL of the Category should always be the same as the PO).

  Specified by:
    `DMGetCategoryIds` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the Object
    `classid` - the class id of the Object
  Returns:
    an array of category IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetCompositeAclIds

    public java.lang.Long[] DMGetCompositeAclIds(java.lang.Long id,
                                                 java.lang.Long classid,
                                                 SortSpecification sort)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the set of composite ACLs which reference the target ACL as a "component".

  Specified by:
    `DMGetCompositeAclIds` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the ACL
    `classid` - the class id of the ACL
    `sort` - how the composites are to be sorted
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFetchProperties

    public java.util.Vector DMFetchProperties(java.lang.Long propBundleId,
                                              java.lang.Long propClassId)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_Properties for the specified S_PropertyBundle.

  Specified by:
    `DMFetchProperties` in interface `S_LibrarySessionInterface`
  Parameters:
    `propBundleId` - the id of the property bundle
    `propClassId` - the class id of the property bundle
  Returns:
    a Vector of S_LibraryObjectDatas
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetProperty

    public AttributeValue DMGetProperty(java.lang.Long propBundleId,
                                        java.lang.Long propClassId,
                                        java.lang.String propertyName)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the property value from the property bundle.

  Specified by:
    `DMGetProperty` in interface `S_LibrarySessionInterface`
  Parameters:
    `propBundleId` - the id of the property bundle
    `propClassId` - the class id of the property bundle
    `propertyName` - name of the property to be fetched
  Returns:
    value of the property
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFetchPolicyListElements

    public java.util.Vector DMFetchPolicyListElements(java.lang.Long policyListId,
                                                      java.lang.Long policyListClassId)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the PolicyListElements for the specified PolicyList.

  Specified by:
    `DMFetchPolicyListElements` in interface `S_LibrarySessionInterface`
  Parameters:
    `policyListId` - the id of the PolicyList
    `policyListClassId` - the class id of the PolicyList
  Returns:
    a Vector of S_LibraryObjectData objects representing the PolicyListElements
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetEffectiveClassPolicyListElements

    public java.util.Vector DMGetEffectiveClassPolicyListElements(java.lang.Long id,
                                                                  java.lang.Long classId,
                                                                  java.lang.String operation)
                                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the set of policies, as PolicyListElement ids, implicitly applied to all instances of the specified ClassObject for the specified operation.

  The PolicyListElements are returned in SORTSEQUENCE order. If more than one PolicyListElement has a particular SORTSEQUENCE value, a PolicyListElement introduced by a classobject precedes the PolicyListElements introduced by the superclasses of that classobject.

  Specified by:
    `DMGetEffectiveClassPolicyListElements` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the classobject id
    `classId` - the classobject class id
    `operation` - the operation of interest, or null for all operations
  Returns:
    a Vector of PolicyListElement ids
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetEffectivePolicyListElements

    public java.util.Vector DMGetEffectivePolicyListElements(java.lang.Long id,
                                                             java.lang.Long classId,
                                                             java.lang.String operation)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the set of policies, as PolicyListElement ids, applied to the specified LibraryObject, either explicitly (through its PolicyLists) or implicitly (through the ClassPolicyLists of its classobject hierarchy) for the specified operation.

  The PolicyListElements are returned in SORTSEQUENCE order. If more than one PolicyListElement has a particular SORTSEQUENCE value, a PolicyListElement introduced by the object's PolicyLists precedes a PolicyListElement introduced by a ClassPolicyList. If more than one PolicyListElement is introduced by a ClassPolicyList for a particular SORTSEQUENCE value, a PolicyListElement introduced by a classobject precedes the PolicyListElements introduced by the superclasses of that classobject. If more than one PolicyListElement is introduced by a object-level PolicyList for a particular SORTSEQUENCE value, the array ordering of the PolicyList objects in the PolicyLists attribute is used to determine precedence.

  Specified by:
    `DMGetEffectivePolicyListElements` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id
    `classId` - the class id
    `operation` - the operation of interest, or null for all operations
  Returns:
    a Vector of PolicyListElement ids
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getPolicyAction

    protected PolicyAction getPolicyAction(java.lang.String className)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Finds a PolicyAction specified by fully-qualified classname, as kept by the service.

  Parameters:
    `className` - the fully-qualified class name of the PolicyAction
  Returns:
    the PolicyAction, or null if no PolicyAction is cached
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### putPolicyAction

    protected void putPolicyAction(java.lang.String className,
                                   PolicyAction pa)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Caches a PolicyAction specified by fully-qualified classname, managed by the service.

  Parameters:
    `className` - the fully-qualified class name of the PolicyAction
    `pa` - the PolicyAction
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetLinks

    public java.lang.Long[] DMGetLinks(java.lang.Long id,
                                       java.lang.Long classid)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the Links for the specified PublicObject.

  Specified by:
    `DMGetLinks` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the PublicObject
    `classid` - the class id of the PublicObject
  Returns:
    array of Link IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMReassociateLinks

    public void DMReassociateLinks(java.lang.Long oldId,
                                   java.lang.Long oldClassId,
                                   java.lang.Long newId,
                                   java.lang.Long newClassId)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Reassociate the Links for the specified PublicObject to new specified PublicObject.

  Specified by:
    `DMReassociateLinks` in interface `S_LibrarySessionInterface`
  Parameters:
    `oldId` - the id of the current PublicObject
    `oldClassId` - the class id of the current PublicObject
    `newId` - the id of the current PublicObject
    `newClassId` - the class id of the current PublicObject
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMfetchVersionSerieses

    public java.lang.Long[] DMfetchVersionSerieses(java.lang.Long id,
                                                   java.lang.Long classid)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_VersionSeries for the specified S_Family.

  Specified by:
    `DMfetchVersionSerieses` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the family
    `classid` - the class id of the family
  Returns:
    set of VersionSeries IDs
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMfetchRevisions

    public java.lang.Long[] DMfetchRevisions(java.lang.Long id,
                                             java.lang.Long classid)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_VersionDescription IDs for the specified S_VersionSeries.

  Specified by:
    `DMfetchRevisions` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the version series
    `classid` - the class id of the version series
  Returns:
    a Vector of S_LibraryObjectData
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMReserveNext

    public void DMReserveNext(java.lang.Long id,
                              java.lang.Long classId,
                              java.lang.String contentPath,
                              java.lang.String comment)
                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Reserves the specified S_VersionSeries.

  Specified by:
    `DMReserveNext` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the version series
    `classId` - the class id of the version series
    `contentPath` - the value for the content path attribute
    `comment` - the value for the comment attribute
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMUnReserve

    public void DMUnReserve(java.lang.Long id,
                            java.lang.Long classId)
                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Unreserves the specified S_VersionSeries.

  Specified by:
    `DMUnReserve` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the version series
    `classId` - the class id of the version series
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNewRevision

    public S_LibraryObjectData DMNewRevision(java.lang.Long id,
                                             java.lang.Long classId,
                                             S_LibraryObjectDefinition def)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a new S_VersionDescription in the specified S_VersionSeries.

  Specified by:
    `DMNewRevision` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the version series
    `classId` - the class id of the version series
    `def` - the definition for the new version description
  Returns:
    the data for the new version description
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNewVersionSeries

    public S_LibraryObjectData DMNewVersionSeries(java.lang.Long id,
                                                  java.lang.Long classId,
                                                  S_LibraryObjectDefinition def)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a secondary S_VersionSeries for the specified S_Family.

  Specified by:
    `DMNewVersionSeries` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the family
    `classId` - the class id of the family
    `def` - the definition of the first version description in the new version series
  Returns:
    the data for the new version series
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMNewBranchedVersionSeries

    public S_LibraryObjectData DMNewBranchedVersionSeries(java.lang.Long id,
                                                          java.lang.Long classId,
                                                          S_LibraryObjectDefinition def)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Branches an S_VersionSeries at the specified S_VersionDescription, resulting in a new S_VersionSeries, S_VersionDescription, and S_BranchRelationship.

  Specified by:
    `DMNewBranchedVersionSeries` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the version description
    `classId` - the class id of the version description
    `def` - the definition of the new version description
  Returns:
    the data for the new version description
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIntegrateIntoVersionSeries

    public void DMIntegrateIntoVersionSeries(java.lang.Long sid,
                                             java.lang.Long sclassId,
                                             java.lang.Long tid,
                                             java.lang.Long tclassId)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Integrates an S_VersionSeries at a specified S_VersionDescription into a second S_VersionSeries at that series's latest S_VersionDescription, creating a new S_BranchRelationship.

  Specified by:
    `DMIntegrateIntoVersionSeries` in interface `S_LibrarySessionInterface`
  Parameters:
    `sid` - the id of the source version description
    `sclassId` - the class id of the source version description
    `tid` - the target target version series
    `tclassId` - the class id of the target version series
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetPartitionValue

    public java.lang.Long DMGetPartitionValue(java.lang.Long id,
                                              java.lang.Long classId)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the partition value of a ContentObject.

  Specified by:
    `DMGetPartitionValue` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the ContentObject id
    `classId` - the ContentObject class id
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetLastAccessDate

    public java.util.Date DMGetLastAccessDate(java.lang.Long id,
                                              java.lang.Long classId)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets when the content of a ContentObject was most recently written or read.

  Specified by:
    `DMGetLastAccessDate` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the ContentObject id
    `classId` - the ContentObject class id
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetContentStream

    public ContentStreamSerializer DMGetContentStream(java.lang.Long id,
                                                      java.lang.Long classId,
                                                      java.lang.Long refObjId,
                                                      java.lang.Long refObjClassId)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Fetches a ContentStream encapulated in a ContentStreamSerializer for the given ContentObject.

  Specified by:
    `DMGetContentStream` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` -
    `classId` -
    `refObjId` -
    `refObjClassId` -
  Returns:
    the content stream
  Throws:
    `IfsException`

### DMNewContentStreamSerializer

    public ContentStreamSerializer DMNewContentStreamSerializer()
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs and returns a ContentStreamSerializer appropriate to the runtime process model.

  Specified by:
    `DMNewContentStreamSerializer` in interface `S_LibrarySessionInterface`
  Returns:
    the content stream serializer
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### newContentStreamSerializer

    public ContentStreamSerializer newContentStreamSerializer()
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs and returns a ContentStreamSerializer appropriate to the runtime process model.

  Returns:
    the content stream serializer
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetContentReader

    public ContentStreamSerializer DMGetContentReader(java.lang.Long id,
                                                      java.lang.Long classId,
                                                      java.lang.Long refObjId,
                                                      java.lang.Long refObjClassId)
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the content of the specified S_ContentObject as a reader.

  Specified by:
    `DMGetContentReader` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Returns:
    a wrapper on the reader
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetContentByRandomAccess

    public RandomAccessor DMGetContentByRandomAccess(java.lang.Long coId,
                                                     java.lang.Long coClassId,
                                                     java.lang.Long refObjId,
                                                     java.lang.Long refObjClassId)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a RandomAccessor for randomly reading the content of the specified ContentObject.

  Specified by:
    `DMGetContentByRandomAccess` in interface `S_LibrarySessionInterface`
  Parameters:
    `coId` - the id of the ContentObject
    `coClassId` - the class id of the ContentObject
    `refObjId` - the id of a Document referencing the ContentObject
    `refObjClassId` - the class id of a Document referencing the ContentObject
  Returns:
    a RandomAccessor, or null if this document does not have content
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMUpdateContentByRandomAccess

    public RandomAccessor DMUpdateContentByRandomAccess(java.lang.Long docId,
                                                        java.lang.Long docClassId,
                                                        S_LibraryObjectDefinition sdocdef,
                                                        java.lang.Long expirationPeriod)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets a RandomAccessor for randomly writing and reading the content of the specified document.

  Specified by:
    `DMUpdateContentByRandomAccess` in interface `S_LibrarySessionInterface`
  Parameters:
    `docId` - the id of the document
    `docClassId` - the class id of the document
    `sdocdef` - a DocumentDefinition, as a S_LibraryObjectDefinition
    `expirationPeriod` - the expiration period for the RandomAccessor, in seconds, or null for the default expiration period
  Returns:
    a RandomAccessor, or null if the document has no content
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorGetDocumentId

    public java.lang.Long DMRandomAccessorGetDocumentId(S_RandomAccessorImpl ra)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of the Document being accessed by the specified RandomAccessor.

  Specified by:
    `DMRandomAccessorGetDocumentId` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
  Returns:
    the document id
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorGetContentObjectId

    public java.lang.Long DMRandomAccessorGetContentObjectId(S_RandomAccessorImpl ra)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the id of the ContentObject being accessed by the specified RandomAccessor.

  Specified by:
    `DMRandomAccessorGetContentObjectId` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
  Returns:
    the ContentObject id
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorSetSession

    public void DMRandomAccessorSetSession(S_RandomAccessorImpl ra)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Binds the specified RandomAccessor to this session.

  Specified by:
    `DMRandomAccessorSetSession` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorRead

    public int DMRandomAccessorRead(S_RandomAccessorImpl ra,
                                    long pos,
                                    byte[] b,
                                    int off,
                                    int len)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Reads bytes from the specified RandomAccessor.

  Specified by:
    `DMRandomAccessorRead` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
    `pos` - the position in content from which to read
    `b` - the buffer into which to read
    `off` - the offset in the buffer
    `len` - the maximum number of bytes to read
  Returns:
    the actual number of bytes read
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorIsWriteable

    public boolean DMRandomAccessorIsWriteable(S_RandomAccessorImpl ra)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether the specified RandomAccessor is writeable.

  Specified by:
    `DMRandomAccessorIsWriteable` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
  Returns:
    whether writeable
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorWrite

    public void DMRandomAccessorWrite(S_RandomAccessorImpl ra,
                                      long pos,
                                      byte[] b,
                                      int off,
                                      int len)
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Writes bytes to the specified RandomAccessor.

  Specified by:
    `DMRandomAccessorWrite` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
    `pos` - the position in content from which to write
    `b` - the buffer from which to write
    `off` - the offset in the buffer
    `len` - the number of bytes to write
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorTruncate

    public void DMRandomAccessorTruncate(S_RandomAccessorImpl ra,
                                         long len)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Truncates the content of the specified RandomAccessor.

  Specified by:
    `DMRandomAccessorTruncate` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
    `len` - the desired content length
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorLength

    public long DMRandomAccessorLength(S_RandomAccessorImpl ra)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the content length from the specified RandomAccessor.

  Specified by:
    `DMRandomAccessorLength` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
  Returns:
    the length, in bytes
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorDispose

    public void DMRandomAccessorDispose(S_RandomAccessorImpl ra)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Disposes the specified RandomAccessor, discarding any changes to the document.

  Specified by:
    `DMRandomAccessorDispose` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRandomAccessorClose

    public void DMRandomAccessorClose(S_RandomAccessorImpl ra)
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Closes the specified RandomAccessor, saving any changes to the document.

  Specified by:
    `DMRandomAccessorClose` in interface `S_LibrarySessionInterface`
  Parameters:
    `ra` - the RandomAccessor
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMCalculateConsumedStorage

    public void DMCalculateConsumedStorage(java.lang.Long quotaid,
                                           java.lang.Long classid)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Recalculates consumed storage for the specified S_ContentQuota.

  Specified by:
    `DMCalculateConsumedStorage` in interface `S_LibrarySessionInterface`
  Parameters:
    `quotaid` - the id of the content quota
    `classid` - the class id of the content quota
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSetContentReadByUser

    public void DMSetContentReadByUser(java.lang.Long id,
                                       java.lang.Long classId,
                                       boolean readState,
                                       java.lang.Long refObjId,
                                       java.lang.Long refObjClassId)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the read state of the specified S_ContentObject.

  Specified by:
    `DMSetContentReadByUser` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `readState` - whether the user has read the content object
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsContentReadByUser

    public boolean DMIsContentReadByUser(java.lang.Long id,
                                         java.lang.Long classId)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the read state of the specified S_ContentObject.

  Specified by:
    `DMIsContentReadByUser` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
  Returns:
    whether the user has read the content object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMIsContextIndexEnabled

    public boolean DMIsContextIndexEnabled()
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  whether Context has ben enabled on this schema

  Specified by:
    `DMIsContextIndexEnabled` in interface `S_LibrarySessionInterface`
  Returns:
    whether Context has ben enabled on this schema
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFilterContent

    public void DMFilterContent(java.lang.Long id,
                                java.lang.Long classId,
                                boolean plaintext,
                                java.lang.Long refObjId,
                                java.lang.Long refObjClassId)
                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Filters the specified S_ContentObject.

  Specified by:
    `DMFilterContent` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `plaintext` - plaintext
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetFilteredContent

    public ContentStreamSerializer DMGetFilteredContent(java.lang.Long id,
                                                        java.lang.Long classId,
                                                        java.lang.Long refObjId,
                                                        java.lang.Long refObjClassId)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the filtered content for the specified S_ContentObject as as reader.

  Specified by:
    `DMGetFilteredContent` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Returns:
    a wrapper on the reader
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGenerateSummary

    public void DMGenerateSummary(java.lang.Long id,
                                  java.lang.Long classId,
                                  java.lang.String pointOfView,
                                  long sizeAsPercent,
                                  long sizeAsNumParagraphs,
                                  java.lang.String summaryLevel,
                                  java.lang.Long refObjId,
                                  java.lang.Long refObjClassId)
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Generates a summary of the specified S_ContentObject.

  Specified by:
    `DMGenerateSummary` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `pointOfView` - the point of view
    `sizeAsPercent` - the size, as a percent
    `sizeAsNumParagraphs` - the size, as number of paragraphs
    `summaryLevel` - the summary level
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSummary

    public ContentStreamSerializer DMGetSummary(java.lang.Long id,
                                                java.lang.Long classId,
                                                java.lang.String pointOfView,
                                                java.lang.Long refObjId,
                                                java.lang.Long refObjClassId)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the summary of the specified S_ContentObject as as reader.

  Specified by:
    `DMGetSummary` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `pointOfView` - the point of view
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Returns:
    a wrapper on the reader
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGenerateThemes

    public void DMGenerateThemes(java.lang.Long id,
                                 java.lang.Long classId,
                                 boolean fullThemes,
                                 java.lang.Long refObjId,
                                 java.lang.Long refObjClassId)
                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Generates the themes of the specified S_ContentObject.

  Specified by:
    `DMGenerateThemes` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `fullThemes` - full themes
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMEnqueueMessage

    public void DMEnqueueMessage(java.lang.Long id,
                                 java.lang.Long classId,
                                 oracle.sql.ORAData message)
                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Enqueues the message on the specified queue.

  Specified by:
    `DMEnqueueMessage` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - id of the Queue
    `classId` - classId of the Queue
    `message` - message to be enqueued
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMEnqueueMessage

    public void DMEnqueueMessage(java.lang.Long id,
                                 java.lang.Long classId,
                                 oracle.sql.ORAData message,
                                 java.lang.String correlation)
                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Enqueues the message on the specified queue. It attaches the user supplied correlation to the message.

  Specified by:
    `DMEnqueueMessage` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - id of the Queue
    `classId` - classId of the Queue
    `message` - message to be enqueued
    `correlation` - correlation for the message
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDequeueMessage

    public oracle.sql.ORAData DMDequeueMessage(java.lang.Long id,
                                               java.lang.Long classId,
                                               java.lang.String subscriberName)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Dequeues a message from the specified queue as the specified subscriber.

  Specified by:
    `DMDequeueMessage` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - id of the Queue
    `classId` - classId of the Queue
    `subscriberName` - name of the subscriber dequeueing the message
  Returns:
    message message if available; NULL otherwise.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDequeueMessageFromExceptionQueue

    public oracle.sql.ORAData DMDequeueMessageFromExceptionQueue(java.lang.Long id,
                                                                 java.lang.Long classId)
                                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Dequeues a message from the specified exception queue.

  Specified by:
    `DMDequeueMessageFromExceptionQueue` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - id of the Queue
    `classId` - classId of the Queue
  Returns:
    message message if available; NULL otherwise.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetThemes

    public ContextTheme[] DMGetThemes(java.lang.Long id,
                                      java.lang.Long classId,
                                      java.lang.Long refObjId,
                                      java.lang.Long refObjClassId)
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the themes of the specified S_ContentObject.

  Specified by:
    `DMGetThemes` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the content object
    `classId` - the class id of the content object
    `refObjId` - the id of the object referencing the content object
    `refObjClassId` - the class id of the object referencing the content object
  Returns:
    the themes
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### isFullTextIndexingEnabled

    protected boolean isFullTextIndexingEnabled()
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether full-text indexing is enabled.

  Returns:
    whether full-text indexing is enabled
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNSyncContentIndex

    public java.io.Serializable DYNSyncContentIndex(java.io.Serializable payload)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Syncs the Oracle Text index.

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNExtractContentForIndexing

    public java.io.Serializable DYNExtractContentForIndexing(java.io.Serializable payload)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  DYN wrapper for the `extractContentForIndexing` method of S_LibrarySessionContentStorageManager.

  The `payload` must be Vector with two elements:

  - `previousContentObjectId`: Long
  - `batchSize`: Integer; non-null

  Parameters:
    `payload` - see method description
  Returns:
    the Long value returned by `extractContentForIndexing`
  Throws:
    `IfsException` - 32385: if the operation fails
  (Published)

### DYNGetAbsolutePath

    public java.io.Serializable DYNGetAbsolutePath(java.io.Serializable payload)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets an absolute path, on the database-tier file system, for the specified path.

  Parameters:
    `payload` - the String path, or null
  Returns:
    a String absolute path to `payload`; if `payload` is already an absolute path it is returned unchanged; returns null if `payload` is null
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMIsAttributeValueInValueDomain

    public boolean DMIsAttributeValueInValueDomain(java.lang.Long id,
                                                   java.lang.Long classId,
                                                   AttributeValue av)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Determines whether the specified attribute value lies within this ValueDomain.

  Specified by:
    `DMIsAttributeValueInValueDomain` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the ValueDomain object
    `classId` - the class id of the ValueDomain object
    `av` - the attribute value
  Returns:
    whether the attribute value lies within this ValueDomain
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetPrimaryUserProfile

    public S_LibraryObjectData DMGetPrimaryUserProfile(java.lang.Long id)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the S_PrimaryUserProfile of the specified S_DirectoryUser.

  Specified by:
    `DMGetPrimaryUserProfile` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the id of the user
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGrantAdmin

    public void DMGrantAdmin(java.lang.Long userid)
                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Grants administration privilege to the specified S_DirectoruUser.

  Specified by:
    `DMGrantAdmin` in interface `S_LibrarySessionInterface`
  Parameters:
    `userid` - the id of the user
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNCreateAdminDirectoryObjects

    public java.io.Serializable DYNCreateAdminDirectoryObjects(java.io.Serializable payload)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates the admin DirectoryUser and the world DirectoryGroup.

  The `payload` must be a Vector containing four String elements, as follows:

  - adminUserName: the name of the admin user
  - adminUserDistinguishedName: the distinguished name of the admin user
  - adminCredentialManagerName: the name of the CredentialManager in which to create the admin user
  - worldGroupName: the name of the world group

  Parameters:
    `payload` - see method description
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getIdForNewObject

    public java.lang.Long getIdForNewObject(S_LibraryObjectDefinition def)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the next available id value.

  Parameters:
    `def` - if not null, the `setId` is invoked in this definition
  Returns:
    the id
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getNextSequenceQueryStatement

    protected static java.sql.PreparedStatement getNextSequenceQueryStatement(LibraryConnection lconn,
                                                                              java.sql.Connection conn)
                                                                       throws java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Gets the PreparedStatement to get the next available id value.

  Parameters:
    `lconn` - the CM SDK connection
    `conn` - the JDBC connection
  Returns:
    the statement
  Throws:
    `java.sql.SQLException` - if the operation fails
  (Unpublished)

### setValueInStatement

    public void setValueInStatement(java.sql.PreparedStatement stmt,
                                    AttributeValue av,
                                    int position,
                                    int datatype)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets a bind variable in the specified PreparedStatement, coercing the datatype as necessary.

  Parameters:
    `stmt` - the statement
    `av` - the value
    `position` - the bind variable position
    `datatype` - the bind variable datatype
  Throws:
    `IfsException` - if the operation fails
  (Published)

### setValueInStatement

    public void setValueInStatement(java.sql.PreparedStatement stmt,
                                    AttributeValue av,
                                    int position,
                                    int datatype,
                                    int datalength)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets a bind variable in the specified PreparedStatement, coercing the datatype as necessary.

  Parameters:
    `stmt` - the statement
    `av` - the value
    `position` - the bind variable position
    `datatype` - the bind variable datatype
    `datalength` - the bind variable data length; applicable only for the String data type
  Throws:
    `IfsException` - if the operation fails
  (Published)

### clearValueInStatement

    protected void clearValueInStatement(java.sql.PreparedStatement stmt,
                                         int position,
                                         int datatype)
                                  throws java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Clears the value of a bind variable in the specified PreparedStatement.

  Parameters:
    `stmt` - the statement
    `position` - the bind variable position
    `datatype` - the bind variable datatype
  Throws:
    `java.sql.SQLException` - if the operation fails
  (Published)

### generateInsertStatement

    protected java.lang.String generateInsertStatement(java.lang.String tableName,
                                                       S_ClassObjectData clssdef)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Generates a INSERT statement string for the specified classobject.

  Parameters:
    `tableName` - the database table for the classobject
    `clssdef` - the classobject data
  Returns:
    the SQL string
  Throws:
    `IfsException` - if the operation fails
  (Published)

### clearPreparedInsertStatement

    protected void clearPreparedInsertStatement(java.sql.PreparedStatement stmt,
                                                S_ClassObjectData clssdef)
                                         throws IfsException,
                                                java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Clears all bind variables of the specified INSERT statement for the specified classobject.

  Parameters:
    `stmt` - the statement
    `clssdef` - the classobject data
  Throws:
    `IfsException` - if the operation fails
    `java.sql.SQLException` - if the operation fails
  (Published)

### setSpecifiedInsertColumns

    protected void setSpecifiedInsertColumns(AttributeValue[] avs,
                                             S_ClassObjectData classData,
                                             int position_offset,
                                             java.sql.PreparedStatement stmt)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the specified bind variables of the specified INSERT statement for the specified classobject.

  Parameters:
    `avs` - the values
    `classData` - the classobject data
    `position_offset` - the bind variable position of the first value
    `stmt` - the statement
  Throws:
    `IfsException` - if the operation fails
  (Published)

### generateUpdateStatement

    protected java.sql.PreparedStatement generateUpdateStatement(java.lang.String tableName,
                                                                 S_ClassObjectData classData,
                                                                 AttributeValue[] avs,
                                                                 LibraryConnection lconn,
                                                                 java.sql.Connection conn,
                                                                 long id)
                                                          throws java.sql.SQLException,
                                                                 IfsException

  Description copied from class: `S_LibrarySession`
  Generates an UPDATE statement for the specified object, classobject, and values.

  Parameters:
    `tableName` - the database table for the classobject
    `classData` - the classobject data
    `avs` - the values
    `lconn` - the connection
    `id` - the id of the object being updated
  Throws:
    `IfsException` - if the operation fails
    `java.sql.SQLException` - if the operation fails
  (Published)

### getValueFromResultSet

    public static AttributeValue getValueFromResultSet(java.sql.ResultSet rset,
                                                       int position,
                                                       int datatype,
                                                       java.lang.Long attributeId,
                                                       long auditId,
                                                       long objectId)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified bind variable in a ResultSet.

  Parameters:
    `rset` - the result set
    `position` - the position
    `datatype` - the datatype of the value
    `attributeId` - if this AttributeValue represents the value of a LibraryObject's Attribute, this is the id of that Attribute; if this AttributeValue represents the value of a system audit entry property, this is the system audit entry property id
    `auditId` - is AttributeValue represents the value of a system audit entry property or an audited LibraryObject's Attribute, this is the audit id; 0 if this AttributeValue represents the current value of a LibraryObject's Attribute
    `objectId` - the objectId associated with this resultSet
  Returns:
    the value
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getStatementInProgress

    protected final java.sql.Statement getStatementInProgress()

  Description copied from class: `S_LibrarySession`
  Return the current JDBC statement in progress on this session.

  Returns:
    the JDBC statement being executed by this session
  (Published)

### isStatementInProgressCancelled

    protected final boolean isStatementInProgressCancelled()

  Description copied from class: `S_LibrarySession`
  Return true if there's a JDBC statement in progress and it has been cancelled, either explicitly or as a result of a timeout.

  Returns:
    true if the current statement in progress has been cancelled, and false otherwise
  (Published)

### isInterrupted

    protected final boolean isInterrupted()

  Description copied from class: `S_LibrarySession`
  Return true if this session has been interrupted, either explicitly or as a result of a timeout.

  Returns:
    true if the session has been interrupted, and false otherwise
  (Published)

### verifyNotInterrupted

    protected final void verifyNotInterrupted()
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Return true if this session has been interrupted, either explicitly or as a result of a timeout.

  Throws:
    `IfsException`
  (Published)

### interrupt

    protected final void interrupt()

  Description copied from class: `S_LibrarySession`
  Interrupt the session. Cancel any statement in progress (unless it is already cancelled) and mark the session as "interrupted".

  (Published)

### execute

    public final boolean execute(java.sql.Statement stmt,
                                 java.lang.String sql)
                          throws IfsException,
                                 java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Covers a JDBC execute statement, so that this statement can be cancelled if it blocks.

  Parameters:
    `stmt` - a JDBC statement
    `sql` - any SQL string
  Returns:
    true if the next result is a ResultSet; false if it is an update count or there are no more results
  Throws:
    `IfsException` - (IFS-21030) if the database operation times out
    `java.sql.SQLException` - if the operation otherwise fails
  (Published)

### executeQuery

    public final java.sql.ResultSet executeQuery(java.sql.Statement stmt,
                                                 java.lang.String sql)
                                          throws IfsException,
                                                 java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Covers a JDBC executeQuery statement, so that this statement can be cancelled if it blocks.

  Parameters:
    `stmt` - a JDBC statement
    `sql` - typically this is a static SQL SELECT statement
  Returns:
    a ResultSet that contains the data produced by the query; never null
  Throws:
    `IfsException` - (IFS-21030) if the database operation times out
    `java.sql.SQLException` - if the operation otherwise fails
  (Published)

### executeUpdate

    public final int executeUpdate(java.sql.Statement stmt,
                                   java.lang.String sql)
                            throws IfsException,
                                   java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Covers a JDBC executeUpdate statement, so that this statement can be cancelled if it blocks.

  Parameters:
    `stmt` - a JDBC statement
    `sql` - a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing
  Returns:
    either the row count for INSERT, UPDATE or DELETE or 0 for SQL statements that return nothing
  Throws:
    `IfsException` - (IFS-21030) if the database operation times out
    `java.sql.SQLException` - if the operation otherwise fails
  (Published)

### execute

    public final boolean execute(java.sql.PreparedStatement stmt)
                          throws IfsException,
                                 java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Covers a JDBC execute statement, so that this statement can be cancelled if it blocks.

  Parameters:
    `stmt` - a JDBC PreparedStatement
  Returns:
    true if the next result is a ResultSet; false if it is an update count or there are no more results
  Throws:
    `IfsException` - (IFS-21030) if the database operation times out
    `java.sql.SQLException` - if the operation otherwise fails
  (Published)

### executeBatch

    public final int[] executeBatch(java.sql.Statement stmt)
                             throws IfsException,
                                    java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Covers a JDBC executeBatch statement, so that this statement can be cancelled if it blocks.

  Parameters:
    `stmt` - a JDBC Statement
  Returns:
    the updatre count for each statement in the batch
  Throws:
    `IfsException` - (IFS-21030) if the database operation times out
    `java.sql.SQLException` - if the operation otherwise fails
  (Published)

### executeQuery

    public final java.sql.ResultSet executeQuery(java.sql.PreparedStatement stmt)
                                          throws IfsException,
                                                 java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Covers a JDBC executeQuery statement, so that this statement can be cancelled if it blocks.

  Parameters:
    `stmt` - a JDBC PreparedStatement
  Returns:
    a ResultSet that contains the data produced by the query; never null
  Throws:
    `IfsException` - (IFS-21030) if the database operation times out
    `java.sql.SQLException` - if the operation otherwise fails
  (Published)

### executeUpdate

    public final int executeUpdate(java.sql.PreparedStatement stmt)
                            throws IfsException,
                                   java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Covers a JDBC executeUpdate statement, so that this statement can be cancelled if it blocks.

  Parameters:
    `stmt` - a JDBC PreparedStatement
  Returns:
    either the row count for INSERT, UPDATE or DELETE or 0 for SQL statements that return nothing
  Throws:
    `IfsException` - (IFS-21030) if the database operation times out
    `java.sql.SQLException` - if the operation otherwise fails
  (Published)

### DMCancelOperation

    public void DMCancelOperation()
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Cancel any server-side operation in progress for this session. This attempts to interrupt the session by cancelling any JDBC statement in progress, and marking the session's interrupt status to true. This method may return before the operation is completely cancelled, as the completion of the cancellation occurs in another thread. NOTE: this method intentionally deviates from the standard DMFoo pattern.

  Specified by:
    `DMCancelOperation` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getDataInstance

    protected S_LibraryObjectData getDataInstance(long selectClassId,
                                                  S_ClassObjectData classData,
                                                  S_LibraryObjectData[] selectAttributeDatas,
                                                  java.sql.ResultSet rset)
                                           throws IfsException,
                                                  java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Gets an S_LibraryObjectData based on the specified ResultSet.

  Parameters:
    `selectClassId` - the id of the classobject against which the SELECT was performed
    `classData` - the data of the classobject against which the SELECT was performed
    `selectAttributeDatas` - the datas of the effective attributes of the classobject against which the SELECT was performed
    `rset` - the results set
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
    `java.sql.SQLException` - if the operation fails
  (Published)

### getDataInstance

    protected S_LibraryObjectData getDataInstance(long selectClassId,
                                                  S_ClassObjectData classData,
                                                  S_LibraryObjectData[] selectAttributeDatas,
                                                  java.sql.ResultSet rset,
                                                  int rsetStartIndex)
                                           throws IfsException,
                                                  java.sql.SQLException

  Description copied from class: `S_LibrarySession`
  Gets an S_LibraryObjectData based on the specified ResultSet.

  Parameters:
    `selectClassId` - the id of the classobject against which the SELECT was performed
    `classData` - the data of the classobject against which the SELECT was performed
    `selectAttributeDatas` - the datas of the effective attributes of the classobject against which the SELECT was performed
    `rset` - the results set
    `rsetStartIndex` - the position of the first effective attribute
  Returns:
    the data
  Throws:
    `IfsException` - if the operation fails
    `java.sql.SQLException` - if the operation fails
  (Published)

### createLibraryObjectCursor

    protected S_LibraryObjectCursor createLibraryObjectCursor(LibraryQueryStatement lstmt,
                                                              java.sql.ResultSet resultSet,
                                                              S_LibraryObjectSelector selector)

  Description copied from class: `S_LibrarySession`
  Creates a S_LibraryObjectCursor.

  Parameters:
    `lstmt` - the statement
    `resultSet` - the result set
    `selector` - the selector
  Returns:
    the cursor
  (Unpublished)

### findLibraryObjectCursor

    protected S_LibraryObjectCursor findLibraryObjectCursor(long cursorId)

  Description copied from class: `S_LibrarySession`
  Finds a S_LibraryObjectCursor.

  Parameters:
    `cursorId` - the cursor sequence
  Returns:
    the cursor
  (Unpublished)

### removeLibraryObjectCursor

    protected void removeLibraryObjectCursor(long cursorId)

  Description copied from class: `S_LibrarySession`
  Removes a S_LibraryObjectCursor.

  Parameters:
    `cursorId` - the cursor sequence
  (Unpublished)

### removeLibraryObjectCursor

    protected void removeLibraryObjectCursor(S_LibraryObjectCursor cursor)

  Description copied from class: `S_LibrarySession`
  Removes a S_LibraryObjectCursor.

  Parameters:
    `cursor` - the cursor
  (Unpublished)

### usesSecureSqlSyntax

    protected boolean usesSecureSqlSyntax(java.lang.String whereclause)

  Description copied from class: `S_LibrarySession`
  Gets whether the specified WHERE clause references secured database objects in the CM SDK schema.

  Parameters:
    `whereclause` - the WHERE clause
  Returns:
    whether secured database objects are referenced
  (Published)

### verifyHasLegalSyntax

    protected void verifyHasLegalSyntax(java.lang.String searchDefinition)
                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Ensures the specified WHERE clause does not reference secured database objects, unless in at least administration discover mode.

  Parameters:
    `searchDefinition` - the WHERE clause
  Throws:
    `IfsException` - (IFS-30061) if the WHERE clause references secured database objects and not in administration discover mode
  (Published)

### DMBeginTransaction

    public Transaction DMBeginTransaction(boolean writeable)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Starts a transaction.

  This method should be invoked only by its LibrarySession counterpart.

  Specified by:
    `DMBeginTransaction` in interface `S_LibrarySessionInterface`
  Parameters:
    `writeable` - whether the transaction is writeable
  Returns:
    a token that can be passed to either `completeTransaction` or `abortTransaction`
  Throws:
    `IfsException` - (IFS-10651) if the operation fails
  (Unpublished)

### beginTransaction

    public final Transaction beginTransaction(boolean writeable)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Starts a transaction.

  Parameters:
    `writeable` - whether the transaction is writeable
  Returns:
    a token that can be passed to either `completeTransaction` or `abortTransaction`
  Throws:
    `IfsException` - (IFS-10651) if the operation fails
  (Published)

### beginTransaction

    public final Transaction beginTransaction()
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Starts a writeable transaction.

  Returns:
    a token that can be passed to either `completeTransaction` or `abortTransaction`
  Throws:
    `IfsException` - (IFS-10651) if the operation fails
  (Published)

### beginImplicitTransaction

    public final Transaction beginImplicitTransaction()
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Starts a writeable transaction implicitly at the beginning of an operation. Returns null and takes no action if an implicit transaction is already started.

  Returns:
    a token that can be passed to either `completeImplicitTransaction` or `abortImplicitTransaction`. The token is null if an implicit transaction is already started.
  Throws:
    `IfsException` - (IFS-10651) if the operation fails
  (Published)

### beginReadonlyTransaction

    public final Transaction beginReadonlyTransaction()
                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Starts a readonly transaction.

  Returns:
    a token that can be passed to either `completeTransaction` or `abortTransaction`
  Throws:
    `IfsException` - (IFS-10651) if the operation fails
  (Published)

### beginImplicitReadonlyTransaction

    public final Transaction beginImplicitReadonlyTransaction()
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Starts a readonly transaction implicitly at the beginning of an operation. Returns null and takes no action if an implicit transaction is already started.

  Returns:
    a token that can be passed to either `completeImplicitTransaction` or `abortImplicitTransaction`. The token is null if an implicit transaction is already started.
  Throws:
    `IfsException` - (IFS-10651) if the operation fails
  (Published)

### DMCompleteTransaction

    public void DMCompleteTransaction(Transaction transaction)
                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Completes a transaction.

  This method should be invoked only by its LibrarySession counterpart.

  Specified by:
    `DMCompleteTransaction` in interface `S_LibrarySessionInterface`
  Parameters:
    `transaction` - the transaction to complete
  Throws:
    `IfsException` - (IFS-10652) if the operation fails
  (Unpublished)

### completeTransaction

    public final void completeTransaction(Transaction transaction)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Completes a transaction.

  Parameters:
    `transaction` - the transaction to complete
  Throws:
    `IfsException` - (IFS-10652) if the operation fails
  (Published)

### completeImplicitTransaction

    public final void completeImplicitTransaction(Transaction transaction)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Completes an implicit transaction. If the specified transaction is null, then an implicit transaction was not created, and no action is necessary.

  Parameters:
    `transaction` - the transaction to complete
  Throws:
    `IfsException` - (IFS-10652) if the operation fails
  (Published)

### DMAbortTransaction

    public void DMAbortTransaction(Transaction transaction)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Aborts a transaction.

  This method should be invoked only by its LibrarySession counterpart.

  Specified by:
    `DMAbortTransaction` in interface `S_LibrarySessionInterface`
  Parameters:
    `transaction` - the transaction to abort
  Throws:
    `IfsException` - (IFS-10653) if the operation fails
  (Unpublished)

### abortTransaction

    public final void abortTransaction(Transaction transaction)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Aborts a transaction.

  Parameters:
    `transaction` - the transaction to abort
  Throws:
    `IfsException` - (IFS-10653) if the operation fails
  (Published)

### abortImplicitTransaction

    public final void abortImplicitTransaction(Transaction transaction)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Aborts an implicit transaction. If the specified transaction is null, then an implicit transaction was not created, and no action is necessary.

  Parameters:
    `transaction` - the transaction to abort
  Throws:
    `IfsException` - (IFS-10653) if the operation fails
  (Published)

### abortTransaction

    public final void abortTransaction(Transaction transaction,
                                       IfsException originalException)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Aborts a transaction in response to the specified IfsException.

  If an exception in thrown in aborting the transaction, `originalException` will be nested within IFS-10653.

  Parameters:
    `transaction` - the transaction to abort
    `originalException` - the IfsException that caused this transaction to be aborted
  Throws:
    `IfsException` - (IFS-10653) if the operation fails
  (Published)

### DMCommit

    public void DMCommit()
                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Makes all pending changes for all in-progress Transactions for this S_LibrarySession visible to all other S_LibrarySessions.

  This method should be invoked only by its LibrarySession counterpart.

  After this method is invoked, attempting to abort any of the in-progress Transactions for this S_LibrarySession will throw an exception.

  Specified by:
    `DMCommit` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - (IFS-10654) if the operation fails
  (Unpublished)

### commit

    public final void commit()
                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Makes all pending changes for all in-progress Transactions for this S_LibrarySession visible to all other S_LibrarySessions.

  After this method is invoked, attempting to abort any of the in-progress Transactions for this S_LibrarySession will throw an exception.

  Throws:
    `IfsException` - (IFS-10654) if the operation fails
  (Published)

### DMRollback

    public void DMRollback()
                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Discards all pending changes for all in-progress Transactions for this S_LibrarySession.

  This method should be invoked only by its LibrarySession counterpart.

  After this method is invoked, attempting to complete any of the in-progress Transactions for this S_LibrarySession will throw an exception.

  Specified by:
    `DMRollback` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - (IFS-10655) if the operation fails
  (Unpublished)

### rollback

    public final void rollback()
                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Discards all pending changes for all in-progress Transactions for this S_LibrarySession.

  After this method is invoked, attempting to complete any of the in-progress Transactions for this S_LibrarySession will throw an exception.

  Throws:
    `IfsException` - (IFS-10655) if the operation fails
  (Published)

### DMIsTransactionInProgress

    public boolean DMIsTransactionInProgress()
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether this S_LibrarySession is in a transaction, explicit or implicit.

  NOTE: this method intentionally deviates from the standard DMFoo pattern.

  Specified by:
    `DMIsTransactionInProgress` in interface `S_LibrarySessionInterface`
  Returns:
    true if the session has a transaction context; false otherwise
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### isWriteableTransactionInProgress

    protected final boolean isWriteableTransactionInProgress()
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether there is a writeable transaction in-progress.

  Returns:
    whether a writeable transaction is in-progress
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isTransactionInProgress

    protected final boolean isTransactionInProgress()
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether there is a transaction in-progress.

  Returns:
    whether a transaction is in-progress
  Throws:
    `IfsException` - if the operation fails
  (Published)

### notifyUncommittedDataCacheEnabled

    protected final void notifyUncommittedDataCacheEnabled()
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Notifies this S_LibrarySession that its uncommitted data cache has been enabled.

  This occurs when a writeable transaction is started with no enclosing writeable transactions.

  Throws:
    `IfsException` - if the operation fails
  (Published)

### getOperationDriver

    protected OperationDriver getOperationDriver()

  Description copied from class: `S_LibrarySession`
  Gets the OperationDriver instance in use by the in-progress operation (if any).

  This will return null if no operation is in progress.

  Returns:
    the current operation driver instance
  (Published)

### constructOperationDriver

    protected OperationDriver constructOperationDriver()
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Constructs an OperationDriver instance to be used to drive a policy-driven operation.

  This will construct and initialize an OperationDriver, and return that instnace to the caller. It also holds this instance and returns it when getOperationDriver() is invoked.

  Returns:
    the constructed operation driver instance
  Throws:
    `IfsException` - if the operation fails
  (Published)

### destroyOperationDriver

    protected void destroyOperationDriver()

  Description copied from class: `S_LibrarySession`
  Destroys the current OperationDriver and nulls the reference to it.

  This is called by the operation which initiated the OperationDriver via a call to constructOperationDriver.

  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNGetCommittedLibraryObjectDataCachePerformanceString

    public java.io.Serializable DYNGetCommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload)
                                                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the cache performance of the committed S_LibraryObjectData cache, as a string.

  Parameters:
    `payload` - ignored
  Returns:
    a string
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNGetCommittedResolvedAclCachePerformanceString

    public java.io.Serializable DYNGetCommittedResolvedAclCachePerformanceString(java.io.Serializable payload)
                                                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the cache performance of the committed Resolved ACL cache, as a string.

  Parameters:
    `payload` - ignored
  Returns:
    a string
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getUncommittedLibraryObjectDataCachePerformance

    public final CachePerformance getUncommittedLibraryObjectDataCachePerformance()

  Description copied from class: `S_LibrarySession`
  Gets the cache performance object for the uncommitted S_LibraryObjectData cache.

  Returns:
    the cache performance object
  (Published)

### DYNGetUncommittedLibraryObjectDataCachePerformanceString

    public java.io.Serializable DYNGetUncommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload)
                                                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the cache performance of the uncommitted S_LibraryObjectData cache, as a string.

  Parameters:
    `payload` - ignored
  Returns:
    a string
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getUncommittedResolvedAclCachePerformance

    public final CachePerformance getUncommittedResolvedAclCachePerformance()

  Description copied from class: `S_LibrarySession`
  Gets the cache performance object for the uncommitted Resolved ACL cache.

  Returns:
    the cache performance object
  (Published)

### DYNGetUncommittedResolvedAclCachePerformanceString

    public java.io.Serializable DYNGetUncommittedResolvedAclCachePerformanceString(java.io.Serializable payload)
                                                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the cache performance of the uncommitted Resolved ACL cache, as a string.

  Parameters:
    `payload` - ignored
  Returns:
    a string
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getLibraryObjectCachePerformance

    public final CachePerformance getLibraryObjectCachePerformance()

  Description copied from class: `S_LibrarySession`
  Gets the cache performance object for the S_LibraryObject cache.

  Returns:
    the cache performance object
  (Published)

### DYNGetLibraryObjectCachePerformanceString

    public java.io.Serializable DYNGetLibraryObjectCachePerformanceString(java.io.Serializable payload)
                                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the cache performance of the S_LibraryObject cache, as a string.

  Parameters:
    `payload` - ignored
  Returns:
    a string
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNGetFolderPathCachePerformanceString

    public java.io.Serializable DYNGetFolderPathCachePerformanceString(java.io.Serializable payload)
                                                                throws IfsException

  Deprecated. CM SDK 10g removed explicit Folder path cache

  Description copied from class: `S_LibrarySession`
  Gets the cache performance of the FolderPathCache, as a string. As of 10g, will always return an empty String.

  Parameters:
    `payload` - ignored
  Returns:
    an empty string
  Throws:
    `IfsException` - if the operation fails
  (Published)

### getIfsConnection

    public final IfsConnection getIfsConnection()
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns an IfsConnection for this S_LibrarySession.

  A writeable transaction must be in progress; if not, an IfsException (IFS-10665) is thrown.

  Returns:
    the connection
  Throws:
    `IfsException` - (IFS-10665) if the operation fails
  (Published)

### getLibraryConnection

    public final LibraryConnection getLibraryConnection()
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the LibraryConnection for this S_LibrarySession.

  If a LibraryConnection is not already assigned to this S_LibrarySession, one is allocated.

  Returns:
    the connection
  Throws:
    `IfsException` - (IFS-10656) if the operation fails
  (Published)

### acquireAuxiliaryConnection

    public final java.sql.Connection acquireAuxiliaryConnection()
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Acquires an auxiliary Connection for use by this S_LibrarySession.

  Each acquired auxiliary Connection should be released as soon as it is unneeded by invoking `releaseAuxiliaryConnection`.

  Returns:
    the connection
  Throws:
    `IfsException` - (IFS-10640) if the operation fails
  (Published)

### acquireAuxiliaryLibraryConnection

    public final LibraryConnection acquireAuxiliaryLibraryConnection()
                                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Acquires an auxiliary LibraryConnection for use by this S_LibrarySession.

  Each acquired auxiliary LibraryConnection should be released as soon as it is unneeded by invoking `releaseAuxiliaryLibraryConnection`.

  Returns:
    the connection
  Throws:
    `IfsException` - (IFS-10640) if the operation fails
  (Published)

### releaseAuxiliaryConnection

    public final void releaseAuxiliaryConnection(java.sql.Connection conn)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Releases an auxiliary Connection previously acquired by this LibrarySession.

  Any uncommitted changes are rolled back.

  Parameters:
    `conn` - the Connection to release
  Throws:
    `IfsException` - (IFS-10641) if the operation fails
  (Published)

### releaseAuxiliaryLibraryConnection

    public final void releaseAuxiliaryLibraryConnection(LibraryConnection lconn)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Releases an auxiliary LibraryConnection previously acquired by this LibrarySession.

  Any uncommitted changes are rolled back.

  Parameters:
    `lconn` - the Connection to release
  Throws:
    `IfsException` - (IFS-10641) if the operation fails
  (Published)

### DYNGetReadonlyConnectionPoolPerformanceString

    public java.io.Serializable DYNGetReadonlyConnectionPoolPerformanceString(java.io.Serializable payload)
                                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets performance statistics of the readonly connection pool.

  Parameters:
    `payload` - ignored
  Returns:
    a String
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNGetWriteableConnectionPoolPerformanceString

    public java.io.Serializable DYNGetWriteableConnectionPoolPerformanceString(java.io.Serializable payload)
                                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets performance statistics of the writeable connection pool.

  Parameters:
    `payload` - ignored
  Returns:
    a String
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMRegisterEventHandler

    public void DMRegisterEventHandler(java.lang.Long id)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Receive notification that the bean-side has a registered event handler for the specified object. This instance uses this information in deciding how far events need to be propogated.

  Specified by:
    `DMRegisterEventHandler` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the object ID that has a registered handler
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDeregisterEventHandler

    public void DMDeregisterEventHandler(java.lang.Long id)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Receive notification that the bean-side has de-registered all event handlers for the specified object. This instance uses this information in deciding how far events need to be propogated.

  Specified by:
    `DMDeregisterEventHandler` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the object ID that no longer has any registered handlers
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRegisterClassEventHandler

    public void DMRegisterClassEventHandler(java.lang.Long classId)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Receive notification that the bean-side has a registered event handler for the specified ClassObject. This instance uses this information in deciding how far events need to be propogated.

  Specified by:
    `DMRegisterClassEventHandler` in interface `S_LibrarySessionInterface`
  Parameters:
    `classId` - the Class ID that has a registered handler
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDeregisterClassEventHandler

    public void DMDeregisterClassEventHandler(java.lang.Long classId)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Receive notification that the bean-side has de-registered all event handlers for the specified ClassObject. This instance uses this information in deciding how far events need to be propogated.

  Specified by:
    `DMDeregisterClassEventHandler` in interface `S_LibrarySessionInterface`
  Parameters:
    `classId` - the Class ID that no longer has any registered handlers
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMRegisterServiceEventHandler

    public void DMRegisterServiceEventHandler(IfsEventHandler handler)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Register a Service event handler.

  Specified by:
    `DMRegisterServiceEventHandler` in interface `S_LibrarySessionInterface`
  Parameters:
    `handler` - the handler to register
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMDeregisterServiceEventHandler

    public void DMDeregisterServiceEventHandler(IfsEventHandler handler)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  De-register a Service event handler.

  Specified by:
    `DMDeregisterServiceEventHandler` in interface `S_LibrarySessionInterface`
  Parameters:
    `handler` - the handler to de-register; if null, de-register all service handlers
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### registerEventHandler

    public final void registerEventHandler(S_LibraryObject lo,
                                           IfsEventHandler handler)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Registers the specified IfsEventHandler to receive events for the specified S_LibraryObject.

  This method allows any object implementing the IfsEventHandler interface to receive notification of events for any LibraryObject.

  Parameters:
    `lo` - the S_LibraryObject of interest
    `handler` - the IfsEventHandler
  Throws:
    `IfsException` - (IFS-11000) if the operation fails
  (Published)

### deregisterEventHandler

    public final void deregisterEventHandler(S_LibraryObject lo,
                                             IfsEventHandler handler)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Deregisters the specified IfsEventHandler for the specified S_LibraryObject.

  Parameters:
    `lo` - the S_LibraryObject. If null, all S_LibraryObjects previously registered for the IfsEventHandler using `registerEventHandler` are deregistered.
    `handler` - the IfsEventHandler. If null, all IfsEventHandlers previously registered for the S_LibraryObject using `registerEventHandler` are deregistered.
  Throws:
    `IfsException` - (IFS-11001) if the operation fails
  (Published)

### registerClassEventHandler

    public final void registerClassEventHandler(S_ClassObject co,
                                                boolean includeSubclasses,
                                                IfsEventHandler handler)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Registers the specified IfsEventHandler to receive events for all objects in the specified class.

  This method allows any object implementing the IfsEventHandler interface to receive notification of events for any S_LibraryObject.

  Parameters:
    `co` - the S_ClassObject of interest
    `includeSubclasses` - whether to include current subclasses of `co`; if a new subclass is subsequently created, it must be explicitly registered for IfsEventHandler to receive events on S_LibraryObjects of that new class
    `handler` - the IfsEventHandler
  Throws:
    `IfsException` - (IFS-11000) if the operation fails
  (Published)

### deregisterClassEventHandler

    public final void deregisterClassEventHandler(S_ClassObject co,
                                                  boolean includeSubclasses,
                                                  IfsEventHandler handler)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Deregisters the specified IfsEventHandler for the specified class.

  Parameters:
    `co` - the S_ClassObject. If null, all S_ClassObjects previously registered for the IfsEventHandler using `registerClassEventHandler` are deregistered.
    `includeSubclasses` - whether to include current subclasses of `co`
    `handler` - the IfsEventHandler. If null, all IfsEventHandlers previously registered for the S_ClassObject using `registerClassEventHandler` are deregistered.
  Throws:
    `IfsException` - (IFS-11001) if the operation fails
  (Published)

### DMPostEvent

    public final void DMPostEvent(IfsEvent event)
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Posts the specified event.

  Specified by:
    `DMPostEvent` in interface `S_LibrarySessionInterface`
  Parameters:
    `event` - the event
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### postEvent

    protected final void postEvent(IfsEvent event)
                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Post the specified event.

  Parameters:
    `event` - the event
  Throws:
    `IfsException` - if the operation fails
  (Published)

### queueEventForProcessing

    protected final void queueEventForProcessing(IfsEvent event)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Queues the specified event for processing by this S_LibrarySession.

  This method is invoked by `S_LibrarySession.postEvent()` for events originating in this session. It is also invoked by `S_LibraryService.processEvent()` for events originating in other sessions.

  Parameters:
    `event` - the event to process
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMProcessEvents

    public void DMProcessEvents()
                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Processes any events after ticking the event exchanger.

  Specified by:
    `DMProcessEvents` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMFlushEvents

    public void DMFlushEvents()
                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Flushes any outgoing events in event exchanger.

  Specified by:
    `DMFlushEvents` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMForceReadEvents

    public void DMForceReadEvents()
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Forces incoming events from the event exchanger to be processed.

  Specified by:
    `DMForceReadEvents` in interface `S_LibrarySessionInterface`
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMProcessEventsInBackground

    public java.util.Vector DMProcessEventsInBackground()
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Processes any events server-side after ticking the event exchanger, and then returns these events to the bean-side caller for bean-side processing.

  Specified by:
    `DMProcessEventsInBackground` in interface `S_LibrarySessionInterface`
  Returns:
    the events that should be processed bean-side
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### flushEvents

    public void flushEvents()
                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Flush any pending outgoing events.

  Throws:
    `IfsException` - if the operation fails
  (Published)

### handleEvent

    public void handleEvent(IfsEvent event)
                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Handles the specified event.

  Specified by:
    `handleEvent` in interface `IfsEventHandler`
  Parameters:
    `event` - the event
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMPostAuditEvent

    public void DMPostAuditEvent(AuditEvent event,
                                 int mode)
                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Create an audit event.

  Specified by:
    `DMPostAuditEvent` in interface `S_LibrarySessionInterface`
  Parameters:
    `event` - the event to add
    `mode` - the success/fail mode for the post
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSelectRawAuditEvents

    public RawAuditEvent[] DMSelectRawAuditEvents(java.lang.String filterClause,
                                                  int maxItems)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Select raw audit events.

  The filter clause is almost always set to null.

  Specified by:
    `DMSelectRawAuditEvents` in interface `S_LibrarySessionInterface`
  Parameters:
    `filterClause` - the filter criteria (where clause)
    `maxItems` - max number of items to return
  Returns:
    the raw Audit Events that match the criteria
  Throws:
    `IfsException` - if the operation fails

### DMRemoveRawAuditEvents

    public void DMRemoveRawAuditEvents(RawAuditEvent[] rawEvents)
                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Remove raw audit events.

  Should only be done after the raw event has been dispatched.

  Specified by:
    `DMRemoveRawAuditEvents` in interface `S_LibrarySessionInterface`
  Parameters:
    `rawEvents` - array of events to free
  Throws:
    `IfsException` - if the operation fails

### DMHandleAuditEventDispatchRequests

    public void DMHandleAuditEventDispatchRequests(java.util.ArrayList reqList,
                                                   java.lang.String tableName)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Handle a list of AuditEvent dispatch requests.

  Specified by:
    `DMHandleAuditEventDispatchRequests` in interface `S_LibrarySessionInterface`
  Parameters:
    `reqList` - a list of AuditEventDispatchRequest
    `tableName` - the table name where the events are to be stored
  Throws:
    `IfsException` - if the operation fails

### DMSelectAuditEvents

    public AuditEvent[] DMSelectAuditEvents(java.lang.Long auditSpec,
                                            java.lang.String filterClause,
                                            java.lang.String sortClause,
                                            int maxItems)
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Select audit events.

  Specified by:
    `DMSelectAuditEvents` in interface `S_LibrarySessionInterface`
  Parameters:
    `auditSpec` - the audit history ID to search
    `filterClause` - the filter criteria (where clause)
    `sortClause` - the sort criteria (order by clause)
    `maxItems` - max number of items to return
  Returns:
    the Audit Events that match the criteria
  Throws:
    `IfsException` - if the operation fails

### DMSelectAggregateAuditEventColumns

    public AttributeValue[] DMSelectAggregateAuditEventColumns(java.lang.Long auditSpec,
                                                               java.lang.String aggFunction,
                                                               java.lang.String[] columnNames,
                                                               java.lang.String[] innerColNames,
                                                               java.lang.String filterClause,
                                                               java.lang.String sortClause)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns the list of distinct values of the specified AuditEvent columns, along with an optional aggregate function.

  Specified by:
    `DMSelectAggregateAuditEventColumns` in interface `S_LibrarySessionInterface`
  Parameters:
    `auditSpec` - the audit history ID to search
    `aggFunction` - the SQL aggregate function (can be null)
    `columnNames` - the audit table column names to select
    `innerColNames` - the audit table column names to use in the inner select; if null, no inner select is used
    `filterClause` - the filter criteria (where clause)
    `sortClause` - the sort criteria (order by clause)
  Returns:
    the AttributeValues corresponding to the list of values of the specified aggregate function and the distinct values of the Event columns. The name of each AttributeValue corresponds to the aggregate function or specified AuditEvent column name; the value of the AttributeValue is an array of the appropriate datatype.
  Throws:
    `IfsException` - if the operation fails

### DMRemoveAuditEvents

    public void DMRemoveAuditEvents(long[] eventIds,
                                    java.lang.String tableName)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Remove audit events.

  Should only be done for normal disposition of audit histories.

  Specified by:
    `DMRemoveAuditEvents` in interface `S_LibrarySessionInterface`
  Parameters:
    `eventIds` - array of event IDs
    `tableName` - event table name
  Throws:
    `IfsException` - if the operation fails

### DMRemoveAuditEventsForTarget

    public void DMRemoveAuditEventsForTarget(java.lang.Long specId,
                                             java.lang.Long targetId)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Free audit events from a specific Audit history, by target ID.

  Specified by:
    `DMRemoveAuditEventsForTarget` in interface `S_LibrarySessionInterface`
  Parameters:
    `specId` - the audit history identifier
    `targetId` - the target ID
  Throws:
    `IfsException` - if the operation fails

### DYNDeleteUnusedAuditProperties

    public java.io.Serializable DYNDeleteUnusedAuditProperties(java.io.Serializable payload)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any unreferenced Audit event properties.

  Performed as a periodic cleanup task.

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails

### DYNSelectUnusedAuditTypeLists

    public java.io.Serializable DYNSelectUnusedAuditTypeLists(java.io.Serializable payload)
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Get a list of unused audit type list IDs.

  Performed during a periodic cleanup task.

  Parameters:
    `payload` - expirationPeriod in ms (Long object)
  Returns:
    ArrayList of unused AuditTypeList Ids
  Throws:
    `IfsException` - if the operation fails

### DMSelectSpecificAuditFolderPath

    public AuditFolderPath DMSelectSpecificAuditFolderPath(long folderPathId)
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Select the specific AuditFolderPath for a given primary key.

  Specified by:
    `DMSelectSpecificAuditFolderPath` in interface `S_LibrarySessionInterface`
  Parameters:
    `folderPathId` - the folder path ID of interest
  Returns:
    the AuditFolderPath for that ID
  Throws:
    `IfsException` - if the operation fails

### DYNDeleteExpiredAuditFolderPaths

    public java.io.Serializable DYNDeleteExpiredAuditFolderPaths(java.io.Serializable payload)
                                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any expired Audit folder paths, that have expired longer than the specified period.

  Performed as a periodic cleanup task.

  Parameters:
    `payload` - expiration period in milliseconds (as a Long)
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails

### DYNDeleteExpiredGlobalAuditEvents

    public java.io.Serializable DYNDeleteExpiredGlobalAuditEvents(java.io.Serializable payload)
                                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any expired audit events from global audit history.

  Performed as a periodic cleanup task.

  Parameters:
    `payload` - a Vector containing three elements in order as shown below.
    - domainId (Long)
    - globalAuditSpecId (Long)
    - expirationPeriod (Long)
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails

### DYNDeleteUnusedAuditFolderPathOverflowEntries

    public java.io.Serializable DYNDeleteUnusedAuditFolderPathOverflowEntries(java.io.Serializable payload)
                                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any unused overflow entries for Audit folder paths.

  Performed as a periodic cleanup task.

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails

### DMRegisterAuditEventOperationType

    public int DMRegisterAuditEventOperationType(java.lang.String opTypeKey,
                                                 int targetCode,
                                                 java.lang.String targetClass,
                                                 int opCode,
                                                 java.lang.Boolean createOrFree)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Register a new event type.

  Occurs during schema creation, upgrade, and when registering new custom event types. Is coded so that services can be running, as they correctly invalidate their type map caches.

  Specified by:
    `DMRegisterAuditEventOperationType` in interface `S_LibrarySessionInterface`
  Parameters:
    `opTypeKey` - operation type key
    `targetCode` - code for the target object type
    `targetClass` - class name for the target object type
    `opCode` - code for the type of operation
    `createOrFree` - indication as to whther the operation is a Create (true) or Free (false) operation; should be null if neither
  Returns:
    the numeric operation type registered
  Throws:
    `IfsException` - if the operation fails

### DMUnregisterAuditEventOperationType

    public void DMUnregisterAuditEventOperationType(java.lang.String opTypeKey)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Unregister an event type.

  Only occurs during upgrade, but is coded so that services can be running, as they correctly invalidate their type map caches.

  Specified by:
    `DMUnregisterAuditEventOperationType` in interface `S_LibrarySessionInterface`
  Parameters:
    `opTypeKey` - operation type key
  Throws:
    `IfsException` - if the operation fails

### DMLookupAuditEventOperationTypes

    public int[] DMLookupAuditEventOperationTypes(java.lang.String[] opTypeKeys)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Looks up audit event operation types by their string key, returning the corresponding numeric equivalents.

  Specified by:
    `DMLookupAuditEventOperationTypes` in interface `S_LibrarySessionInterface`
  Parameters:
    `opTypeKeys` - operation type keys
  Returns:
    the numeric equivalents; note the returned array could be shorter if any keys specified are not registered.
  Throws:
    `IfsException` - if the operation fails

### DMLookupAuditEventOperationTypeKeys

    public java.lang.String[] DMLookupAuditEventOperationTypeKeys(int[] opTypes)
                                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Looks up audit event operation type keys by their numeric values, returning the string keys.

  Specified by:
    `DMLookupAuditEventOperationTypeKeys` in interface `S_LibrarySessionInterface`
  Parameters:
    `opTypes` - numeric operation types
  Returns:
    the String key equivalents; note the returned array could be shorter if any specified types are not registered.
  Throws:
    `IfsException` - if the operation fails

### DMLookupAuditTargetCode

    public AuditTargetCode DMLookupAuditTargetCode(java.lang.String className)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Looks up an audit target code structure from the specified Class name or other registered alias for the desired type.

  Specified by:
    `DMLookupAuditTargetCode` in interface `S_LibrarySessionInterface`
  Parameters:
    `className` - class name associated with a registered audit target type
  Returns:
    the AuditTargetCode structure, or null if none found matching the specified class name
  Throws:
    `IfsException` - if the operation fails

### DMGetAuditTypesForClass

    public AttributeValue[] DMGetAuditTypesForClass(java.lang.String className,
                                                    boolean includeNested)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the audit operation type values for a specified class name, optionally including any types that are applicable to a class that is considered a descendent of the specified class.

  The AttributeValues returned use the operation type key as the name, and the numeric operation type as the value.

  Specified by:
    `DMGetAuditTypesForClass` in interface `S_LibrarySessionInterface`
  Parameters:
    `className` - the class name of interest, force to upper case (e.g. FOLDER)
    `includeNested` - whether or not to include operations for classes that are descendents of the specified class
  Returns:
    the operation types that match
  Throws:
    `IfsException` - if the operation fails

### DMGetAuditTypesForCreateOperations

    public AttributeValue[] DMGetAuditTypesForCreateOperations()
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the audit operation type values that correspond to "CREATED" operations.

  Used to indicate when an object has been created simply by inspecting event types.

  Specified by:
    `DMGetAuditTypesForCreateOperations` in interface `S_LibrarySessionInterface`
  Returns:
    the operation types for create operations
  Throws:
    `IfsException` - if the operation fails

### DMGetAuditTypesForFreeOperations

    public AttributeValue[] DMGetAuditTypesForFreeOperations()
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the audit operation type values that correspond to "FREED" operations.

  Used to indicate when an object has been freed simply by inspecting event types.

  Specified by:
    `DMGetAuditTypesForFreeOperations` in interface `S_LibrarySessionInterface`
  Returns:
    the operation types for free operations
  Throws:
    `IfsException` - if the operation fails

### DMGetCustomAuditTypes

    public AttributeValue[] DMGetCustomAuditTypes()
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the custom audit operation type values.

  Specified by:
    `DMGetCustomAuditTypes` in interface `S_LibrarySessionInterface`
  Returns:
    the custom operation types
  Throws:
    `IfsException` - if the operation fails

### DMRegisterCustomAuditEventOperationCodeKey

    public int DMRegisterCustomAuditEventOperationCodeKey(java.lang.String opCodeKey)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Register a new custom operation code key.

  If the key is already registered, this simply returns the numeric value of the previous registration.

  Specified by:
    `DMRegisterCustomAuditEventOperationCodeKey` in interface `S_LibrarySessionInterface`
  Parameters:
    `opCodeKey` - operation code key; e.g. "FAXED"
  Returns:
    the numeric operation code registered
  Throws:
    `IfsException` - if the operation fails

### DMGetHighestAuditId

    public long DMGetHighestAuditId()
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Get the highest Audit Id in use.

  Currently approximates this by selecting the next ID by selecting from the audit sequence, and subtracting 1.

  Specified by:
    `DMGetHighestAuditId` in interface `S_LibrarySessionInterface`
  Returns:
    the highest audit ID in effect
  Throws:
    `IfsException` - if the operation fails

### DMGetAuditCertificates

    public AuditCertificate[] DMGetAuditCertificates(java.lang.Long[] objectIds)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Select AuditCertificates for the specified object IDs.

  Specified by:
    `DMGetAuditCertificates` in interface `S_LibrarySessionInterface`
  Parameters:
    `objectIds` - object IDs
  Returns:
    the requested certificates
  Throws:
    `IfsException` - if the operation fails

### postAuditEvent

    public void postAuditEvent(AuditEvent event,
                               int mode)
                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Create an audit event.

  Parameters:
    `event` - the event to add
    `mode` - the success/fail mode for the post
  Throws:
    `IfsException` - if the operation fails
  (Published)

### postAuditEventsUponCommit

    protected void postAuditEventsUponCommit(LibraryConnection lconn,
                                             java.sql.Connection conn,
                                             java.util.List rawEventList)
                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Create audit events as a result of a normal completeTransaction occurring.

  This is called as a normal part of an completeTransaction operation, initiated from within `UncommittedLibraryObjectDataCache`.

  Parameters:
    `lconn` - the repos connection
    `conn` - the JDBC connection
    `rawEventList` - list of AuditExecutor.PreparedRawAuditEvent
  Throws:
    `IfsException` - if the operation fails
  (Published)

### postFailedAuditEventsUponRollback

    protected void postFailedAuditEventsUponRollback(LibraryConnection lconn,
                                                     java.sql.Connection conn,
                                                     java.util.List rawEventList)
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Post failed audit events as a result of an abortTransaction.

  This is called as a normal part of an abortTransaction operation, initiated from within `UncommittedLibraryObjectDataCache`.

  Parameters:
    `lconn` - the repos connection
    `conn` - the JDBC connection
    `rawEventList` - list of AuditExecutor.PreparedRawAuditEvent
  Throws:
    `IfsException` - if the operation fails
  (Published)

### scheduleRawAuditEvent

    protected void scheduleRawAuditEvent(AuditExecutor.PreparedRawAuditEvent rawEvent,
                                         int postMode)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Schedule an event with the transaction manager, to be posted with the AuditExecutor upon complete or abort of the current transaction.

  This is called from AuditExecutor to schedule posting audit events in coordination with the current transaction.

  Parameters:
    `rawEvent` - the raw event to schedule
    `postMode` - the post mode for the event
  Throws:
    `IfsException` - if the operation fails
  (Published)

### selectLatestAuditFolderPath

    protected AuditFolderPath selectLatestAuditFolderPath(java.lang.Long folderId)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Select the latest AuditFolderPath for a folder.

  Delegates to AuditExecutor.

  Parameters:
    `folderId` - the folder ID of interest
  Returns:
    the latest AuditFolderPath for that folder
  Throws:
    `IfsException` - if the operation fails

### selectAuditEvents

    public AuditEvent[] selectAuditEvents(java.lang.Long auditSpec,
                                          java.lang.String filterClause,
                                          java.lang.String sortClause,
                                          int maxItems)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Select audit events.

  Parameters:
    `auditSpec` - the audit history ID to search
    `filterClause` - the filter criteria (where clause)
    `sortClause` - the sort criteria (order by clause)
    `maxItems` - max number of items to return
  Returns:
    the Audit Events that match the criteria
  Throws:
    `IfsException` - if the operation fails

### selectAggregateAuditEventColumns

    public AttributeValue[] selectAggregateAuditEventColumns(java.lang.Long auditSpec,
                                                             java.lang.String aggFunction,
                                                             java.lang.String[] columnNames,
                                                             java.lang.String[] innerColNames,
                                                             java.lang.String filterClause,
                                                             java.lang.String sortClause)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns the list of distinct values of the specified AuditEvent columns, along with an optional aggregate function.

  Parameters:
    `auditSpec` - the audit history ID to search
    `aggFunction` - the SQL aggregate function (can be null)
    `columnNames` - the audit table column names to select
    `innerColNames` - the audit table column names to use in the inner select; if null, no inner select is used
    `filterClause` - the filter criteria (where clause)
    `sortClause` - the sort criteria (order by clause)
  Returns:
    the AttributeValues corresponding to the list of values of the specified aggregate function and the distinct values of the Event columns. The name of each AttributeValue corresponds to the aggregate function or specified AuditEvent column name; the value of the AttributeValue is an array of the appropriate datatype.
  Throws:
    `IfsException` - if the operation fails

### removeAuditEvents

    public void removeAuditEvents(long[] eventIds,
                                  java.lang.String tableName)
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Remove audit events.

  Should only be done for normal disposition of audit histories.

  Parameters:
    `eventIds` - array of event IDs
    `tableName` - event table name
  Throws:
    `IfsException` - if the operation fails

### removeAuditEventsForTarget

    public void removeAuditEventsForTarget(java.lang.Long specId,
                                           java.lang.Long targetId)
                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Free audit events from a specific Audit history, by target ID.

  Parameters:
    `specId` - the audit history identifier
    `targetId` - the target ID
  Throws:
    `IfsException` - if the operation fails

### selectSpecificAuditFolderPath

    public AuditFolderPath selectSpecificAuditFolderPath(long folderPathId)
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Select the specific AuditFolderPath for a given primary key.

  Parameters:
    `folderPathId` - the folder path ID of interest
  Returns:
    the AuditFolderPath for that ID
  Throws:
    `IfsException` - if the operation fails

### deleteUnusedAuditProperties

    public void deleteUnusedAuditProperties()
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any unreferenced Audit event properties.

  Performed as a periodic cleanup task.

  Throws:
    `IfsException` - if the operation fails

### selectUnusedAuditTypeLists

    public java.util.ArrayList selectUnusedAuditTypeLists(long expirationPeriod)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Select any unreferenced Audit type lists.

  Performed during a periodic cleanup task.

  Parameters:
    `expirationPeriod` - expiration period
  Returns:
    list of AuditTypeList ids
  Throws:
    `IfsException` - if the operation fails

### deleteExpiredAuditFolderPaths

    public void deleteExpiredAuditFolderPaths(long expPeriod)
                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any expired Audit folder paths, that have expired longer than the specified period.

  Performed as a periodic cleanup task.

  Parameters:
    `expPeriod` - the minimum amount of time, in milliseconds, that the AuditFolderPaths have to be expired in order to be deleted
  Throws:
    `IfsException` - if the operation fails

### deleteExpiredGlobalAuditEvents

    public void deleteExpiredGlobalAuditEvents(java.lang.Long domainId,
                                               java.lang.Long specId,
                                               java.lang.Long expPeriod)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any expired global audit events.

  Performed as a periodic cleanup task.

  Parameters:
    `domainId` - domain on which we are working on
    `specId` - global audit spec id
    `expPeriod` - the minimum amount of time, in milliseconds, that the GlobalAuditEvents have to be expired in order to be deleted; if null, no expiration
  Throws:
    `IfsException` - if the operation fails

### deleteUnusedAuditFolderPathOverflowEntries

    public void deleteUnusedAuditFolderPathOverflowEntries()
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Delete any unused overflow entries for Audit folder paths.

  Performed as a periodic cleanup task.

  Throws:
    `IfsException` - if the operation fails

### registerAuditEventOperationType

    public int registerAuditEventOperationType(java.lang.String opTypeKey,
                                               int targetCode,
                                               java.lang.String targetClass,
                                               int opCode,
                                               java.lang.Boolean createOrFree)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Register a new event type.

  Only occurs during schema creation and upgrade, but is coded so that services can be running, as they correctly invalidate their type map caches.

  Parameters:
    `opTypeKey` - operation type key
    `targetCode` - code for the target object type
    `targetClass` - class name for the target object type
    `opCode` - code for the type of operation
    `createOrFree` - indication as to whther the operation is a Create (true) or Free (false) operation; should be null if neither
  Returns:
    the numeric operation type registered
  Throws:
    `IfsException` - if the operation fails

### registerCustomAuditEventOperationCodeKey

    public int registerCustomAuditEventOperationCodeKey(java.lang.String opCodeKey)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Register a new custom operation code key.

  If the key is already registered, this simply returns the numeric value of the previous registration.

  Parameters:
    `opCodeKey` - operation code key; e.g. "FAXED"
  Returns:
    the numeric operation code registered
  Throws:
    `IfsException` - if the operation fails

### unregisterAuditEventOperationType

    public void unregisterAuditEventOperationType(java.lang.String opTypeKey)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Unregister an event type.

  Only occurs during upgrade, but is coded so that services can be running, as they correctly invalidate their type map caches.

  Parameters:
    `opTypeKey` - operation type key
  Throws:
    `IfsException` - if the operation fails

### getAuditTypesForClass

    public AttributeValue[] getAuditTypesForClass(java.lang.String className,
                                                  boolean includeNested)
                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the audit operation type values for a specified class name, optionally including any types that are applicable to a class that is considered a descendent of the specified class.

  The AttributeValues returned use the operation type key as the name, and the numeric operation type as the value.

  Parameters:
    `className` - the class name of interest, force to upper case (e.g. FOLDER)
    `includeNested` - whether or not to include operations for classes that are descendents of the specified class
  Returns:
    the operation types that match
  Throws:
    `IfsException` - if the operation fails

### getAuditTypesForCreateOperations

    public AttributeValue[] getAuditTypesForCreateOperations()
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the audit operation type values that correspond to "CREATED" operations.

  Used to indicate when an object has been created simply by inspecting event types.

  Returns:
    the operation types for create operations
  Throws:
    `IfsException` - if the operation fails

### getAuditTypesForFreeOperations

    public AttributeValue[] getAuditTypesForFreeOperations()
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the audit operation type values that correspond to "FREE" operations.

  Used to indicate when an object has been freed simply by inspecting event types.

  Returns:
    the operation types for free operations
  Throws:
    `IfsException` - if the operation fails

### getCustomAuditTypes

    public AttributeValue[] getCustomAuditTypes()
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the custom audit operation type values.

  Returns:
    the custom operation types
  Throws:
    `IfsException` - if the operation fails

### lookupAuditEventOperationTypes

    public int[] lookupAuditEventOperationTypes(java.lang.String[] opTypeKeys)
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Looks up audit event operation types by their string key, returning the corresponding numeric equivalents.

  Parameters:
    `opTypeKeys` - operation type keys
  Returns:
    the numeric equivalents; note the returned array could be shorter if any keys specified are not registered.
  Throws:
    `IfsException` - if the operation fails

### lookupAuditEventOperationTypeKeys

    public java.lang.String[] lookupAuditEventOperationTypeKeys(int[] opTypes)
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Looks up audit event operation type keys by their numeric values, returning the string keys.

  Parameters:
    `opTypes` - numeric operation types
  Returns:
    the String key equivalents; note the returned array could be shorter if any specified types are not registered.
  Throws:
    `IfsException` - if the operation fails

### lookupAuditTargetCode

    public AuditTargetCode lookupAuditTargetCode(java.lang.String className)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Looks up an audit target code structure from the specified Class name or other registered alias for the desired type.

  Parameters:
    `className` - class name associated with a registered audit target type
  Returns:
    the AuditTargetCode structure, or null if none found matching the specified class name
  Throws:
    `IfsException` - if the operation fails

### lookupAuditEventOperationTypeKey

    public java.lang.String lookupAuditEventOperationTypeKey(int opType)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Looks up an audit event operation type key by its numeric value, returning the string key.

  Parameters:
    `opType` - numeric operation type
  Returns:
    the String key equivalent; or null if the operation is not registered
  Throws:
    `IfsException` - if the operation fails

### getHighestAuditId

    public long getHighestAuditId()
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Get the highest Audit Id in use.

  Currently approximates this by selecting the next ID in a way that ensures the ID will never be used for an event.

  Returns:
    the highest audit ID in effect
  Throws:
    `IfsException` - if the operation fails

### getAuditCertificates

    public AuditCertificate[] getAuditCertificates(java.lang.Long[] objectIds)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Select AuditCertificates for the specified object IDs.

  Parameters:
    `objectIds` - object IDs
  Returns:
    the requested certificates
  Throws:
    `IfsException` - if the operation fails

### getAuditCertificateCache

    protected BoundedCache getAuditCertificateCache()

  Description copied from class: `S_LibrarySession`
  Gets the AuditCertificate cache.

  Returns:
    the AuditCertificate cache

### getAuditInlineStringCache

    protected BoundedCache getAuditInlineStringCache()

  Description copied from class: `S_LibrarySession`
  Gets the Audit cache for inline strings.

  Returns:
    the inline string cache

### getAuditInlineStringReferenceCache

    protected BoundedCache getAuditInlineStringReferenceCache()

  Description copied from class: `S_LibrarySession`
  Gets the Audit cache for references to inline strings.

  Returns:
    the inline string reference cache

### getDirectoryService

    public DirectoryService getDirectoryService()
                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the DirectoryService of the S_LibraryService of this S_LibrarySession.

  Returns:
    the directory service
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerAuthenticate

    public java.io.Serializable DYNCredentialManagerAuthenticate(java.io.Serializable payload)
                                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Authenticates the specified credential.

  This does not create a new session or change the existing session in any way. It simply determines the whether the supplied credential is valid for the specified distinguished name. It does not check the existence of a DirectoryUser for that user.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  To invoke this method, the session must be in administration mode.

  The `payload` must be a Vector containing four String elements, as follows:

  - credentialManagerName: the name of the CredentialManager
  - distinguishedName: the distinguished name of the user
  - credential: the credential to validate
  - options: the ConnectOptions supplied by the user

  Parameters:
    `payload` - see method description
  Returns:
    a Boolean indicating whether the credential is valid
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerUserExists

    public java.io.Serializable DYNCredentialManagerUserExists(java.io.Serializable payload)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Determines whether the specified CredentialManager can authenticate the specified user.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  The `payload` must be a Vector containing two String elements, as follows:

  - credentialManagerName: the name of the CredentialManager
  - distinguishedName: the distinguished name of the user

  Parameters:
    `payload` - see method description
  Returns:
    a Boolean indicating whether the CredentialManager manages the user
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerSupportsCreateUser

    public java.io.Serializable DYNCredentialManagerSupportsCreateUser(java.io.Serializable payload)
                                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Determines whether the specified CredentialManager supports the `DYNCredentialManagerCreateUser` method.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  Parameters:
    `payload` - the String name of the CredentialManager
  Returns:
    a Boolean indicating whether `DYNCredentialManagerCreateUser` is supported
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerSupportsDeleteUser

    public java.io.Serializable DYNCredentialManagerSupportsDeleteUser(java.io.Serializable payload)
                                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Determines whether the specified CredentialManager supports the `DYNCredentialManagerDeleteUser` method.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  Parameters:
    `payload` - the String name of the CredentialManager
  Returns:
    a Boolean indicating whether `DYNCredentialManagerDeleteUser` is supported
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerSupportsSetPassword

    public java.io.Serializable DYNCredentialManagerSupportsSetPassword(java.io.Serializable payload)
                                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Determines whether the specified CredentialManager supports the `DYNCredentialManagerSetPassword` method.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  Parameters:
    `payload` - the String name of the CredentialManager
  Returns:
    a Boolean indicating whether `DYNCredentialManagerSetPassword` is supported
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerSupportsListUsers

    public java.io.Serializable DYNCredentialManagerSupportsListUsers(java.io.Serializable payload)
                                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Determines whether the specified CredentialManager supports the `DYNCredentialManagerListUsers` method.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  Parameters:
    `payload` - the String name of the CredentialManager
  Returns:
    a Boolean indicating whether `DYNCredentialManagerListUsers` is supported
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerGetProperty

    public java.io.Serializable DYNCredentialManagerGetProperty(java.io.Serializable payload)
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the value of the specified dynamic property for the specified CredentialManager.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`. The `payload` must be a Vector containing two elements, as follows:

  - credentialManagerName: the String name of the CredentialManager
  - name: the String name of the property

  Parameters:
    `payload` - see method description
  Returns:
    an AttributeValue representing the property value, or null if there is no such property
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerCreateInitialContext

    public java.io.Serializable DYNCredentialManagerCreateInitialContext(java.io.Serializable payload)
                                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates a JNDI connection to the OiD instance for the specified OidCredentialManager and returns the DirContext of that connection.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API.

  The `payload` must be a Vector containing at least the following first two elements and optionally the last two elements:

  - serviceConfigurationName: the String name of the ServiceConfiguration containing the OidCredentialManager
  - credentialManagerName: the String name of the OidCredentialManager
  - principal: the OID user to bind as
  - credential: credentials of the OID user; does not need to be passed if the principal is the DN of the application entity for the Files domain and this DN has been registered with OID using iAS RepAPI
  Alternately, the `payload` may be the String name of an OidCredentialManager running in the current LibraryService.

  The returned value is a Vector of one element, which is the `javax.naming.directory.DirContext` of the JNDI connection.

  Parameters:
    `payload` - see method description
  Returns:
    see method description
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNRemoveInvalidTokenCredentials

    public java.io.Serializable DYNRemoveInvalidTokenCredentials(java.io.Serializable payload)
                                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Remove Token Credentials that have expired or have been expended.

  A Token Credential is expired when its timeout value is less than current time. A Token Credential is expended when its remaining authorization count is <= 0.

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - (IFS-10199) if the operation fails
  (Published)

### DMPersistTokenCredential

    public void DMPersistTokenCredential(TokenCredential credential)
                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Makes the specified TokenCredential persistent.

  Specified by:
    `DMPersistTokenCredential` in interface `S_LibrarySessionInterface`
  Parameters:
    `credential` - the TokenCredential
  Throws:
    `IfsException` - (IFS-10191) if the operation fails
  (Unpublished)

### DMReauthenticate

    public boolean DMReauthenticate(Credential credential,
                                    ConnectOptions options)
                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Reauthenticates the DIRECTORYUSER for which this S_LibrarySession was created (this is the DIRECTORYUSER returned by the method `getAuthenticatedUser`).

  This does not create a new session or change the existing session in any way. It simply determines the whether the supplied credential is a valid credential for the previously authenticated DIRECTORYUSER.

  Specified by:
    `DMReauthenticate` in interface `S_LibrarySessionInterface`
  Parameters:
    `credential` - the credential to authenticate; this must be a credential for the authenticated user of this S_LibrarySession
    `options` - the ConnectOptions supplied by the user
  Returns:
    whether `credential` is a valid credential
  Throws:
    `IfsException` - (IFS-10162) if the operation fails (other than the supplied credential simply being invalid)
  (Unpublished)

### reauthenticate

    public boolean reauthenticate(Credential credential,
                                  ConnectOptions options)
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Reauthenticates the DIRECTORYUSER for which this S_LibrarySession was created (this is the DIRECTORYUSER returned by the method `getAuthenticatedUser`).

  This does not create a new session or change the existing session in any way. It simply determines the whether the supplied credential is a valid credential for the previously authenticated DIRECTORYUSER.

  Parameters:
    `credential` - the credential to authenticate; this must be a credential for the authenticated user of this S_LibrarySession
    `options` - the ConnectOptions supplied by the user
  Returns:
    whether `credential` is a valid credential
  Throws:
    `IfsException` - (IFS-10162) if the operation fails (other than the supplied credential simply being invalid)
  (Published)

### DYNGetRichMediaDocsWithoutRichMediaCategories

    public java.io.Serializable DYNGetRichMediaDocsWithoutRichMediaCategories(java.io.Serializable payload)
                                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets all Docs that are in the "InterMedia" media but are not associated with an InterMedia category. Called by the InterMediaAnnotatorAgent. This is an expensive query - don't call it often.

  Parameters:
    `payload` - the Long class id of the media against which to search.
  Returns:
    a Vector of S_LibraryObjectData's of Docs.
  Throws:
    `IfsException` - if the operation fails.
  (Published)

### getTraceLogger

    public final TraceLogger getTraceLogger()
                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the trace logger of this session.

  Specified by:
    `getTraceLogger` in interface `Traceable`
  Returns:
    the trace logger
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isTraced

    public final boolean isTraced(int channel,
                                  int level)
                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets whether tracing is enabled for the specified channel and level.

  Specified by:
    `isTraced` in interface `Traceable`
  Parameters:
    `channel` - the channel number
    `level` - the level
  Returns:
    whether tracing is enabled
  Throws:
    `IfsException` - (IFS-11201) if the channel is invalid
  (Published)

### DMTrace

    public final void DMTrace(int channel,
                              int level,
                              java.lang.Long serviceId,
                              java.lang.Long sessionId,
                              java.lang.Long id,
                              java.lang.String className,
                              java.lang.String payload)
                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Sends a trace request to the S_LibrarySessionTraceLogger.

  Specified by:
    `DMTrace` in interface `S_LibrarySessionInterface`
  Parameters:
    `channel` - the channel number
    `level` - the level
    `serviceId` - the service id of the object performing the trace
    `sessionId` - the session id of the object performing the trace, or 0 if the trace is requested by a service
    `id` - the id of the object performing the trace, or 0 if the trace is requested by a service or session
    `className` - the classname of the object performing the trace
    `payload` - a string containing any additional information to be placed in the trace log
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### trace

    public final void trace(int channel,
                            int level,
                            java.lang.String payload)

  Description copied from class: `S_LibrarySession`
  Issues a trace request to the trace logger.

  Specified by:
    `trace` in interface `Traceable`
  Parameters:
    `channel` - the channel number
    `level` - the level
    `payload` - a string containing any additional information to be placed in the trace log
  (Published)

### DMSetSessionTraceLoggerLevels

    public final void DMSetSessionTraceLoggerLevels(int[] levels)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the trace levels of the S_LibrarySessionTraceLogger.

  Specified by:
    `DMSetSessionTraceLoggerLevels` in interface `S_LibrarySessionInterface`
  Parameters:
    `levels` - an array of levels. The array index corresponds to the channel number.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetSessionTraceLoggerLevels

    public final int[] DMGetSessionTraceLoggerLevels()
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the trace levels of the S_LibrarySessionTraceLogger.

  Specified by:
    `DMGetSessionTraceLoggerLevels` in interface `S_LibrarySessionInterface`
  Returns:
    an array of levels. The array index corresponds to the channel number.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMSetServiceTraceLoggerLevels

    public final void DMSetServiceTraceLoggerLevels(int[] levels)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Sets the trace levels of the S_LibraryServiceTraceLogger.

  Specified by:
    `DMSetServiceTraceLoggerLevels` in interface `S_LibrarySessionInterface`
  Parameters:
    `levels` - an array of levels. The array index corresponds to the channel number.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetServiceTraceLoggerLevels

    public final int[] DMGetServiceTraceLoggerLevels()
                                              throws IfsException

  Description copied from class: `S_LibrarySession`
  Gets the trace levels of the S_LibraryServiceTraceLogger.

  Specified by:
    `DMGetServiceTraceLoggerLevels` in interface `S_LibrarySessionInterface`
  Returns:
    an array of levels. The array index corresponds to the channel number.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNDeleteOldFilteredContent

    public java.io.Serializable DYNDeleteOldFilteredContent(java.io.Serializable payload)
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  Garbage collects old filtered content rows.

  Parameters:
    `payload` - a Long indicating the number of seconds at which a row is old enough to delete
  Returns:
    Integer - number of rows deleted
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNCleanUpDanglingObjectReferences

    public java.io.Serializable DYNCleanUpDanglingObjectReferences(java.io.Serializable payload)
                                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Clears scalar object-type attributes that reference invalid objects. The `payload` must be a Vector containing three string elements, as follows:
  - classObjectDatabaseName: the database object name of the classobject being checked
  - attributeDatabaseName: the database object name of the object-type attribute being checked
  - tablename: the database object name of the top-level classobject corresponding to the datatype of the object being checked (PO/KO/SO)

  Parameters:
    `payload` - see method description
  Returns:
    the Integer number of rows cleared
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNCleanUpDanglingArrayReferences

    public java.io.Serializable DYNCleanUpDanglingArrayReferences(java.io.Serializable payload)
                                                           throws IfsException

  Description copied from class: `S_LibrarySession`
  Clears elements of array-type object-type attributes that reference invalid objects.

  Parameters:
    `payload` - see method description
  Returns:
    the Integer number of rows cleared
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNPurgeEvents

    public java.io.Serializable DYNPurgeEvents(java.io.Serializable payload)
                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Purges events older than a threshold age.

  Parameters:
    `payload` - the Long maximum desired event age, in seconds, or null if unspecified
  Returns:
    the Integer number of events purged, or null if unknown
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCleanupDeadServices

    public java.io.Serializable DYNCleanupDeadServices(java.io.Serializable payload)
                                                throws IfsException

  Description copied from class: `S_LibrarySession`
  Cleans up S_LibraryServices that have abnormally terminated.

  Parameters:
    `payload` - the Long period, in seconds, after which a service for which no keep-alive packets have been received is deemed dead
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DMGetExpiredTimedLocks

    public java.util.Vector DMGetExpiredTimedLocks(int maxItems,
                                                   int offset)
                                            throws IfsException

  Description copied from class: `S_LibrarySession`
  Get a set of timed out locks, bounded in size by the max count specified.

  Specified by:
    `DMGetExpiredTimedLocks` in interface `S_LibrarySessionInterface`
  Parameters:
    `maxItems` - the maximum number of entries to return
    `offset` - the offset to be used in the query for expired locks
  Returns:
    a vector of S_LibraryObjectData, representing the LockObjects that have expired.
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMReleaseExpiredLockObject

    public int DMReleaseExpiredLockObject(java.lang.Long id,
                                          java.lang.Long classId)
                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Release an expired LockObject. This is invoked by the LockAgent for LockObjects whose LockTimeoutValue indicates that the lock has expired. All PublicObjects that refer to this LockObject will have their LockObject attribute cleared, and the LockObject will be freed.

  Specified by:
    `DMReleaseExpiredLockObject` in interface `S_LibrarySessionInterface`
  Parameters:
    `id` - the ID of the LockObject to release
    `classId` - the class ID of the LockObject to release
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMApplyFolderIndexDeferredUpdate

    public void DMApplyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry)
                                          throws IfsException

  Description copied from class: `S_LibrarySession`
  Applies a deferred update to the Folder index

  Specified by:
    `DMApplyFolderIndexDeferredUpdate` in interface `S_LibrarySessionInterface`
  Parameters:
    `entry` - the Folder index deferred entry
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DMGetFolderIndexDeferredUpdates

    public java.util.Vector DMGetFolderIndexDeferredUpdates(int maxItems)
                                                     throws IfsException

  Description copied from class: `S_LibrarySession`
  gets a set of Deferred Folder index updates

  Specified by:
    `DMGetFolderIndexDeferredUpdates` in interface `S_LibrarySessionInterface`
  Parameters:
    `maxItems` - the maximum number of entries to return
  Returns:
    a vector of FolderIndexDeferredUpdate, or null if no entries
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNIsFolderIndexEnabled

    public java.io.Serializable DYNIsFolderIndexEnabled(java.io.Serializable payload)
                                                 throws IfsException

  Description copied from class: `S_LibrarySession`
  Returns indication of whether a folder index service is in use.

  Parameters:
    `payload` - ignored
  Returns:
    Boolean with value true if folder index enabled; false otherwise
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNInitializeFolderIndexTables

    public java.io.Serializable DYNInitializeFolderIndexTables(java.io.Serializable payload)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Creates folder index tables. This can only be done if no folder index is currently enabled.

  Parameters:
    `payload` - an Integer containing the initial max level
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNChangeFolderIndexUpdateMode

    public java.io.Serializable DYNChangeFolderIndexUpdateMode(java.io.Serializable payload)
                                                        throws IfsException

  Description copied from class: `S_LibrarySession`
  Change folder index update mode to either synchronous or asynchronous. If the specified mode is the same as the current mode of the index, no change takes place (and no exception is thrown)

  Parameters:
    `payload` - the desired update mode as a Boolean; true indicates synchronous, false indicates asynchronous
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNTruncateFolderIndexTables

    public java.io.Serializable DYNTruncateFolderIndexTables(java.io.Serializable payload)
                                                      throws IfsException

  Description copied from class: `S_LibrarySession`
  Truncates the folder index tables.

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNCreateInitialSelfRows

    public java.io.Serializable DYNCreateInitialSelfRows(java.io.Serializable payload)
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Create the initial set of self-referencing rows inthe folder index

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNCreateInitialDeferredEntries

    public java.io.Serializable DYNCreateInitialDeferredEntries(java.io.Serializable payload)
                                                         throws IfsException

  Description copied from class: `S_LibrarySession`
  Create the initial deferred set of folder relationships for the Folder index.

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNResetFolderIndex

    public java.io.Serializable DYNResetFolderIndex(java.io.Serializable payload)
                                             throws IfsException

  Description copied from class: `S_LibrarySession`
  Resets Folder index so that the only rows included are "self" rows. This is used at upgrade time to ensure that a re-creation from FolderPathRelationships is possible.

  Parameters:
    `payload` - ignored
  Returns:
    the count of rows removed
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNGetFoldersNeedingPromotion

    public java.io.Serializable DYNGetFoldersNeedingPromotion(java.io.Serializable payload)
                                                       throws IfsException

  Description copied from class: `S_LibrarySession`
  Get the list of folders that are in need of promotion.

  Parameters:
    `payload` - Vector containing Integer objects maxParentsThreshold, maxChildrenThreshold and level in that order.
  Returns:
    array of folder ids that need to be promoted
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNGetFolderIndexMaxLevel

    public java.io.Serializable DYNGetFolderIndexMaxLevel(java.io.Serializable payload)
                                                   throws IfsException

  Description copied from class: `S_LibrarySession`
  Get the max level parameter from FolderIndexService.

  Parameters:
    `payload` - null; ignored
  Returns:
    max level parametyer of FIS
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNIsFolderIndexUpdateModeSynchronous

    public java.io.Serializable DYNIsFolderIndexUpdateModeSynchronous(java.io.Serializable payload)
                                                               throws IfsException

  Description copied from class: `S_LibrarySession`
  Get indication of theFolderIndexService update mode.

  Parameters:
    `payload` - null; ignored
  Returns:
    true if update mode is synchronous, or if index does not exist
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCompleteIndexCreation

    public java.io.Serializable DYNCompleteIndexCreation(java.io.Serializable payload)
                                                  throws IfsException

  Description copied from class: `S_LibrarySession`
  Complete the creation of the folder index. This removes the "partially created" flag for the index.

  Parameters:
    `payload` - ignored
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### DYNChangeAclResolutionMode

    public java.io.Serializable DYNChangeAclResolutionMode(java.io.Serializable payload)
                                                    throws IfsException

  Description copied from class: `S_LibrarySession`
  Change ACL resolution mode to either synchronous or asynchronous. If the specified mode is the same as the current mode, no change takes place (and no exception is thrown)

  Parameters:
    `payload` - the desired update mode as a Boolean; true indicates synchronous, false indicates asynchronous
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

### getSharedStateFactory

    protected S_LibraryObjectDataSharedStateFactory getSharedStateFactory()

  Description copied from class: `S_LibrarySession`
  Returns the Shared State factory in effect for the domain.

  Returns:
    the Shared State factory
  (Published)

### constructSharedState

    protected final S_LibraryObjectDataSharedState constructSharedState()

  Description copied from class: `S_LibrarySession`
  Returns a newly constructed shared state instance of the proper type.

  The type returned is controlled by the Shared State factory in effect for the domain.

  Returns:
    the newly constructed shared state
  (Published)

### DYNCredentialManagerCreateUser

    public java.io.Serializable DYNCredentialManagerCreateUser(java.io.Serializable payload)
                                                        throws IfsException

  Deprecated. iFS 9.0.2 added options element

  Description copied from class: `S_LibrarySession`
  Creates a new user in the specified CredentialManager.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  The `payload` must be a Vector containing three elements, as follows:

  - credentialManagerName: the name of the CredentialManager
  - name: the String user name; some CredentialManagers may convert this name into a distinguished name if required; other CredentialManagers may require this to be a distinguished name to begin with
  - password: the String password of the user
  - options: an AttributeValue[] specifying CredentialManager-specific options; a null value requests default behavior
  Deprecated payload format. The `options` element was introduced in iFS 9.0.2. Although it is currently optional, future releases of CM SDK will require that it be specified.

  Parameters:
    `payload` - see method description
  Returns:
    the String distinguished name of the created user
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerListUsers

    public java.io.Serializable DYNCredentialManagerListUsers(java.io.Serializable payload)
                                                       throws IfsException

  Deprecated. iFS 9.0.2 changed payload to Vector of two elements

  Description copied from class: `S_LibrarySession`
  Gets the distinguished names of all users managed by the specified CredentialManager.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`. The `payload` must be a Vector containing two elements, as follows:

  - credentialManagerName: the String name of the CredentialManager
  - options: an AttributeValue[] specifying CredentialManager-specific options; a null value requests default behavior
  Deprecated payload format. Prior to iFS 9.0.2, the payload was a String specifying the name of the CredentialManager. Although this payload format is currently still supported, future releases of CM SDK will require the payload to be a Vector of two elements.

  Parameters:
    `payload` - see method description
  Returns:
    a Vector of String distinguished names
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerSetPassword

    public java.io.Serializable DYNCredentialManagerSetPassword(java.io.Serializable payload)
                                                         throws IfsException

  Deprecated. iFS 9.0.2 added options element

  Description copied from class: `S_LibrarySession`
  Sets the password of the specified user in the specified CredentialManager.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  The `payload` must be a Vector containing four elements, as follows:

  - credentialManagerName: the String name of the CredentialManager
  - distinguishedName: the String distinguished name of the user
  - password: the new String password
  - options: an AttributeValue[] specifying CredentialManager-specific options; a null value requests default behavior
  Deprecated payload format. The `options` element was introduced in iFS 9.0.2. Although it is currently optional, future releases of CM SDK will require that it be specified.

  Parameters:
    `payload` - see method description
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Published)

### DYNCredentialManagerDeleteUser

    public java.io.Serializable DYNCredentialManagerDeleteUser(java.io.Serializable payload)
                                                        throws IfsException

  Deprecated. iFS 9.0.2 added options element

  Description copied from class: `S_LibrarySession`
  Deletes the specified user from the specified CredentialManager.

  This method should only be invoked from the beans API by calling `invokeServerMethod` on LibrarySession. Do not call this method from the server API; instead, operate directly on the DirectoryService obtained by calling `getDirectoryService`.

  The `payload` must be a Vector containing three elements, as follows:

  - credentialManagerName: the String name of the CredentialManager
  - distinguishedName: the String distinguished name of the user
  - options: an AttributeValue[] specifying CredentialManager-specific options; a null value requests default behavior
  Deprecated payload format. The `options` element was introduced in iFS 9.0.2. Although it is currently optional, future releases of CM SDK will require that it be specified.

  Parameters:
    `payload` - see method description
  Returns:
    null
  Throws:
    `IfsException` - if the operation fails
  (Published)

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD