oracle.ifs.beans

Class LibrarySession

java.lang.Object

oracle.ifs.beans.LibrarySession

All Implemented Interfaces:

LibraryConstants, IfsEventHandler, LibrarySessionInterface, LogInfo, Traceable

Direct Known Subclasses:

TieLibrarySession

public class LibrarySession
extends Object
implements LibrarySessionInterface, IfsEventHandler, Traceable, LibraryConstants, LogInfo

A LibrarySession is used to represent a connection-based Session with the CM SDK server.

A LibrarySession (also known as a "session") object is created by calling the connect method on LibraryService. All other persistent objects (that is, objects that are stored in the CM SDK server) are created from this class.

The public methods on this class can be divided into the following categories:

• Methods to create new persistent objects. The creation methods take the form of a create[ObjectName] method, and take a definition object containing creation parameters.
• Methods to free persistent objects, or to delete and undelete PublicObjects.
• Methods to get and set administration modes for the session.
• Methods to server configuration and version information.
• Methods to manage transaction state.
• Methods to get information about the connected user.
• Methods to get Collections for certain classes of objects.
• Methods to find objects by their Identifers.
• Methods to tracing and localization.
• Methods to manage events.

Version:

1.0

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LibrarySession.ServerSideCoordinator ServerSideCoordinator is used to coordinate bean-side and server-side operations.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ACLD_DISCOVERER_ADMIN Id of the permanent admin user.
protected boolean	m_AlwaysCacheSelectedData Indication as to whether to always cache selected data from Selectors.
protected int	m_ApplicationMode Current application mode.
protected Stack	m_ApplicationModeStack A stack of application modes, stored as Integer objects.
protected String	m_ApplicationName Name of the application provided in the original connect options.
protected long	m_AttributesRsn The resolution sequence number at which an attribute was last added or removed.
protected String	m_AuthenticatedUserName Name of the authenticated user.
protected Long	m_ClockOffset The time offset between the mid tier clock and the DBMS clock.
protected ConfigurationCategoryDescriptorMap	m_ConfigCategoryDescriptorMap Map for ConfigurationCategory select operations.
protected boolean	m_Connected connection state; volatile so changes are immediately visible to all threads
protected HashMap	m_CopyOperationsInProgress An item of custom state which holds the set of copy() opeartions in progress
protected HashMap	m_CreateOperationsInProgress An item of custom state which holds the set of createXXX() opeartions in progress
protected Actor	m_CurrentActor The effective Actor (lazily set)
protected ContentQuota	m_DefaultContentQuota the default ContentQuota object that will be used for any new Documents
protected SortSpecification	m_DefaultFolderSortSpecification default SortSpecification for Folder select operations.
protected String	m_dnSuffix Distinguished name suffix, from the server properties.
protected PropertyBundle	m_DomainPropertyBundle The domain PropertyBundle
protected oracle.ifs.beans.LibrarySessionEventPoller	m_EventPoller The event poller.
protected boolean	m_EventProcessingEnabled Whether event processing is enabled for this LibrarySession.
protected DirectoryUser	m_FeignedUser the current impersonated user.
protected boolean	m_FilterDeletedObjectsEnabled state of the deleted object filtering.
protected String	m_FolderPathDelimiter the folder-path delimiter for the session defaults to FolderPathResolver.FOLDER_DELIMITER
protected HashMap	m_FreeOperationsInProgress An item of custom state which holds the set of free() opeartions in progress
protected DirectoryUser	m_GuestUser The guest user (lazily set)
protected Long	m_Id Id of the Session
protected Object	m_InvokeServerSideLock Something on which to synchronize during our DMFoo calls and pseudo DMFoo calls.
protected LibraryObjectCache	m_LibraryObjectCache LibraryObject cache
protected Localizer	m_Localizer the Localizer for this session.
protected Hashtable	m_ObjectFolderSortSpecification object-level SortSpecifications for Folder select operations.
protected boolean	m_PreventSessionTimeouts Indication as to whether session timeouts are suppressed
protected PrimaryUserProfile	m_PrimaryUserProfile the current user's PrimaryUserProfile.
protected Hashtable	m_RegisteredClassEventHandlers Registered class event handlers (see registerEventHandler()).
protected Hashtable	m_RegisteredEventHandlers Registered event handlers (see registerEventHandler()).
protected Folder	m_RootFolder The root folder
protected long	m_Sequence The next unique sequence value for this session.
protected LibrarySession.ServerSideCoordinator	m_ServerSideCoordinator Holds server-side coordination info.
protected Hashtable	m_ServiceConfigurationProperties table of service configuration properties.
protected Long	m_ServiceId Id of the server-side Service
protected String	m_ServiceName Name of the service.
protected Hashtable	m_SessionState Custom state held on behalf of the session.
protected HashMap	m_UpdateOperationsInProgress An item of custom state which holds the set of update() opeartions in progress
protected DirectoryUser	m_User the authenticated user.
static String	STATEMENT_KEY_COLLECTION_POLICYLIST Statement key to use for PolicyList collection.
static String	STATEMENT_KEY_COLLECTION_SHAREDACL Statement key to use for Shared ACL collection.

Fields inherited from interface oracle.ifs.common.LibrarySessionInterface

ALWAYS_CACHE_SELECTED_DATA_PROPERTY, CLEAR_SHARED_CACHES, DEFAULT_CONTENTQUOTA_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

ARRAYVALUES_TABLENAME_PREFIX, 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, AUDIT_TABLENAME_PREFIX, CAPABILITY_ADDITEM, CAPABILITY_ADDMEMBER, CAPABILITY_ADDRELATIONSHIP, CAPABILITY_ADDVERSION, CAPABILITY_ADDVERSIONSERIES, 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_REMOVEITEM, CAPABILITY_REMOVEMEMBER, CAPABILITY_REMOVERELATIONSHIP, CAPABILITY_REMOVEVERSIONSERIES, CAPABILITY_SET_ATTR, CAPABILITY_SET_CONTENT, CAPABILITY_SETMETADATA, CAPABILITY_SETRELATION, DEFINITIONSETTINGPOLICY_STANDARD, EXCEPTION_INFO_AGGREGATE_ENTRIES, EXCEPTION_INFO_CONFLICTING_OBJECT_ID, EXCEPTION_INFO_DESCRIPTION_MAP, EXCEPTION_INFO_LIMIT, EXCEPTION_INFO_OBJECT_ID, EXCEPTION_INFO_PARAMETER_NAME, FLAG_ACTIVITYRECORD_EXISTS, FLAG_ACTOR_EXISTS, FLAG_ATTACHMENTRELATION_EXISTS, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MESSAGELIST_EXISTS, IFS_ATTRIBUTEPROPERTY_COMMONNAME, IFS_ATTRIBUTEPROPERTY_DEFINITIONSETTINGPOLICY, IFS_ATTRIBUTEPROPERTY_MULTIVALUETABLESUFFIX, IFS_ATTRIBUTEPROPERTY_STANDARDSIMPLEPROPERTYARRAY, IFS_CLASSPROPERTY_CATEGORY_ALLOWMULTIPLEINSTANCES, IFS_CLASSPROPERTY_CATEGORY_FLAGBIT, IFS_CLASSPROPERTY_COMMONNAME, IFS_CLASSPROPERTY_CONTENTSEARCHVIEWNAME, IFS_CLASSPROPERTY_DEFINITIONCLASSNAME, IFS_CLASSPROPERTY_INSTALLEDCLASS, IFS_DOMAIN_ACCESSCONTROLLIST_BYPASSNAMEUNIQUENESSCHECK, IFS_DOMAIN_ACCESSCONTROLLIST_COMPOSITEACLSUPPORTED, IFS_DOMAIN_ACLINDEX_EVENTTARGET, IFS_DOMAIN_ACTIVITY_CURRENTACTIVITYEVENTHISTORY, IFS_DOMAIN_ACTIVITY_CURRENTPERFORMEDACTIVITYSPECIFICATION, IFS_DOMAIN_ACTIVITY_CURRENTTRACKEDACTIVITYSPECIFICATION, IFS_DOMAIN_ACTIVITY_DEFAULTACTIVITYSPECIFICATION, IFS_DOMAIN_ACTIVITY_DELETERECORDSUPONACTIVITYRECORDFREE, IFS_DOMAIN_APPLICATION_INITIALIZERCLASSNAME, IFS_DOMAIN_AUDIT_AUDITINGENABLED, IFS_DOMAIN_AUDITING_GLOBALAUDITEVENTEXPIRATIONPERIOD, IFS_DOMAIN_AUDITING_GLOBALAUDITTYPELIST, IFS_DOMAIN_AUDITRULEEVALUATORCLASS, IFS_DOMAIN_CONFIGURATIONCATEGORYDESCRIPTORMAPCLASSNAME, IFS_DOMAIN_CONTENTVAULTENTRY_ENCRYPTIONCIPHERCOUNT, IFS_DOMAIN_CONTROLLERSTATE_SINGLETON, 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_DEFAULTTEMPDIRECTORY, IFS_DOMAIN_DEFAULTWINDOWSTEMPDIRECTORY, IFS_DOMAIN_DEFINITIONCLONINGREQUIRED, IFS_DOMAIN_DIRECTORYGROUP_BYPASSNAMEUNIQUENESSCHECK, IFS_DOMAIN_DIRECTORYGROUP_GROUPMEMBERSHIPCACHEMEMBERUSESARRAYINPUTS, IFS_DOMAIN_DIRECTORYGROUP_MEMBERTHRESHOLD, IFS_DOMAIN_DIRECTORYOBJECT_ANCESTORTHRESHOLD, IFS_DOMAIN_DIRECTORYOBJECT_GROUPMEMBERSHIPCACHEANCESTORUSESARRAYINPUTS, IFS_DOMAIN_DOCUMENT_DEFINITIONOBJECTEXPIRATIONPERIOD, IFS_DOMAIN_DOCUMENT_OWNERHASREADSUPPORTED, IFS_DOMAIN_EXTRACTION_DEFAULTINFORMATIONEXTRACTIONSPECIFICATION, 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_OPERATIONACTIONSPECIFICATION_TEMPORARILYDEACTIVATED, 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_TIMEFORMAT, 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_CLONEDSESSIONRETRYPERIOD, 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_GROUPMEMBERSHIPCACHEANCESTORTHRESHOLD, IFS_SERVICE_GROUPMEMBERSHIPCACHEANCESTORUSESARRAYINPUTS, IFS_SERVICE_GROUPMEMBERSHIPCACHEENABLED, IFS_SERVICE_GROUPMEMBERSHIPCACHEMEMBERTHRESHOLD, IFS_SERVICE_GROUPMEMBERSHIPCACHEMEMBERUSESARRAYINPUTS, IFS_SERVICE_JDBC_DEFAULTROWPREFETCH, IFS_SERVICE_JDBC_DRIVER, IFS_SERVICE_JDBC_DRIVERTYPE, IFS_SERVICE_JDBC_TRACINGENABLED, IFS_SERVICE_LOCKTIMEOUTPERIOD, IFS_SERVICE_MAXIMUMCLONEDSESSIONS, IFS_SERVICE_MAXIMUMCONCURRENTSESSIONS, IFS_SERVICE_MAXIMUMPOOLEDCONTENTBUFFERSPERSESSION, IFS_SERVICE_ORPHANSESSIONTIMEOUTPERIOD, IFS_SERVICE_POLLFOREVENTSFROMOTHERSERVICESPERIOD, IFS_SERVICE_QUOTACHECKFREQUENCYINBYTES, IFS_SERVICE_SERVICECONFIGURATIONNAME, IFS_SERVICE_SERVICEKEEPALIVEEVENTPERIOD, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_EMERGENCYTRIGGER, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_ISMANGEDBYSERVER, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_PURGETARGET, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_SIZE, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_URGENTTRIGGER, 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_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, INFORMATIONEXTRACTIONENTITYPHRASE_INDEX_PREFIX, INFORMATIONEXTRACTIONENTITYPHRASE_TABLE_PREFIX, LIBRARYOBJECT_INDEXNAME_PREFIX, LIBRARYOBJECT_TABLENAME_PREFIX, LIBRARYOBJECT_VIEWNAME_PREFIX, 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, MAPVALUES_TABLENAME_PREFIX, PERFORMEDACTIVITY_PRIVATEACTIONINDEX_PREFIX, PERFORMEDACTIVITY_PRIVATEACTIONTABLE_PREFIX, PERFORMEDACTIVITY_SEQUENCE_PREFIX, PERFORMEDACTIVITY_SUMMARYTABLE_PREFIX, PERFORMEDACTIVITY_TABLE_PREFIX, PERFORMEDACTIVITY_VIEW_PREFIX, PUBLIC_SESSIONSTATE_APPLICATION_CONTEXT, PUBLIC_SESSIONSTATE_APPLICATION_USERIDENTIFER, PUBLICOBJECT_BASESECUREVIEWNAME_PREFIX, PUBLICOBJECT_BASEVIEWNAME_PREFIX, PUBLICOBJECT_SECUREVIEWNAME_PREFIX, PUBLICOBJECT_UNDELETED_SECUREVIEWNAME_PREFIX, PUBLICOBJECT_UNDELETED_VIEWNAME_PREFIX, 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, TRACKEDACTIVITY_PRIVATEACTIONINDEX_PREFIX, TRACKEDACTIVITY_PRIVATEACTIONTABLE_PREFIX, TRACKEDACTIVITY_SEQUENCE_PREFIX, TRACKEDACTIVITY_SUMMARYTABLE_PREFIX, TRACKEDACTIVITY_TABLE_PREFIX, TRACKEDACTIVITY_VIEW_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LibrarySession(S_LibrarySessionInterface ssess, Credential credential, ConnectOptions options, String serviceName) Construct a LibrarySession object.

Method Summary

Modifier and Type	Method and Description
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.
void	applyAclIndexDeferredUpdate(AccessControlListDeferredUpdate entry, boolean deleteAfterProcessing) Apply an ACL index deferred update
void	applyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry) Apply a Folder index deferred update
Transaction	beginImplicitTransaction() Starts a writeable transaction implicitly at the beginning of an operation.
Transaction	beginTransaction() Starts a writeable transaction.
void	blockBackgroundProcessing() Blocks any background event processing.
protected LibraryObject	cacheInstance(Long id, LibraryObject obj) Put a LibraryObject Instance in the session's object cache.
void	cancel() Cancel any server-side operation in progress for this session.
Hashtable	captureSessionState() Capture the current session state for the session.
void	clearCopyContext(Long id) Remove the context of a copy operation for the specified object.
void	clearCreateContext(Long id) Remove the context of a create operation for the specified object.
void	clearFreeContext(Long id) Remove the context of a free operation for the specified object.
void	clearRaciSessionContext(RandomAccessContentInterface raci) Deprecated. CMSDK 10gR2: use RandomAccessor
void	clearSharedCaches() Inform service to clear its shared caches.
void	clearUpdateContext(Long id) Remove the context of an update operation for the specified object.
protected LibrarySession	cloneSession() Clone a new session based on the user of the current session.
void	commit() Makes all pending changes for all in-progress Transactions for this LibrarySession visible to all other LibrarySessions.
void	completeImplicitTransaction(Transaction transaction) Completes an implicit transaction.
void	completeTransaction(Transaction transaction) Completes a transaction.
LibraryObject	constructInstance(Long id, Long class_id, S_ClassObjectData classData) construct a LibraryObject Instance
protected LibraryObject	constructInstance(S_LibraryObjectData data) construct a LibraryObject Instance
void	createClonedSession() Creates a cloned session without reserving it, which will increase the number of pooled cloned sessions.
Credential	createCredential(DirectoryUser user) Return a credential that can be used to create a new session for the specified user, using the current session's service.
Credential	createCredential(LibraryService service, DirectoryUser user) Return a credential that can be used to create a new session for the specified user.
Credential	createGuestCredential() Create a new credential based on the "guest" user.
LibrarySession	createGuestSession() Create a new session based on the "guest" user.
LibrarySession	createGuestSession(ConnectOptions options) Create a new session based on the "guest" user.
PublicObject	createPublicObject(PublicObjectDefinition def) Create a new public object.
void	createRetainedEventDatabaseObjects(RetainedEvent event) Create tables for a RetainedEvent type.
SchemaObject	createSchemaObject(SchemaObjectDefinition def) Create a new schema object.
LibrarySession	createSession() Create a new session based on the user of the current session.
LibrarySession	createSession(DirectoryUser user) Create a new session for the specified user.
LibrarySession	createSession(DirectoryUser user, ConnectOptions options) Create a new session for the specified user.
SimpleObject	createSimpleObject(SimpleObjectDefinition def) Create a new simple object.
SystemObject	createSystemObject(SystemObjectDefinition def) Create a new system object.
void	createView(ViewSpecification vsp) Creates a database view from a View specification.
void	delete(PublicObject[] items) Deletes all the passed PublicObjects.
void	deleteAclIndexDeferredUpdates(Long[] ids) Deletes a set of Deferred ACL Resolution Entries
void	deleteRepositoryParameter(String name) Deletes the specified repository parameter.
void	deleteRetainedEvent(RetainedEvent event) delete a RetainedEvent.
void	deregisterClassEventHandler(ClassObject co, boolean includeSubclasses, IfsEventHandler handler) Deregisters the specified IfsEventHandler for the specified class.
void	deregisterCollection(Collection collection, String classname) Deregisters a collection, cancelling the event registration.
void	deregisterEventHandler(LibraryObject lo, IfsEventHandler handler) Deregisters the specified IfsEventHandler for the specified LibraryObject.
void	deregisterServiceEventHandler(IfsEventHandler handler) Deregisters the specified IfsEventHandler.
Long	directlyDispatchAuditEvent(AuditEvent event, Long specId) Directly dispatch an AuditEvent to the specified Event History.
boolean	disconnect() Disconnects the session, effectively disposing the instance.
void	disconnectBestEffort() Disconnects the session, effectively disposing the instance.
protected void	DMAbortTransaction(Transaction transaction) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMaddAccessControlEntry(Long id, Long classId, S_LibraryObjectDefinition sdef) Invokes the identically-named remote S_LibrarySession method.
Long	DMAddAttributeToClassObject(Long id, S_LibraryObjectDefinition def) Adds an Attribute to an existing ClassObject.
protected void	DMAddFolderRelationship(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected void	DMAddManualTextIndexing(Long id, Long classId, ContentStreamSerializer css) Invokes the identically-named remote S_LibrarySession method.
protected void	DMAddMembersToDirectoryGroup(Long group_id, Long classid, Long[] rightObjIds, Long[] rightObjClassids) Invokes the identically-named remote S_LibrarySession method.
protected void	DMAddMemberToDirectoryGroup(Long group_id, Long classid, Long rightObj, Long rightObjClassid) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMAddRelationship(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected void	DMAddToFolder(Long folder_id, Long classid, Long rightObj, Long rightObjClassid) Invokes the identically-named remote S_LibrarySession method.
protected void	DMApplyAclIndexDeferredUpdate(AccessControlListDeferredUpdate entry, boolean deleteAfterProcessing) Invokes the identically-named remote S_LibrarySession method.
protected void	DMApplyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry) Invokes the identically-named remote S_LibrarySession method.
protected Transaction	DMBeginTransaction(boolean writeable) Invokes the identically-named remote S_LibrarySession method.
protected void	DMCalculateConsumedStorage(Long id, Long classid) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMCheckExistenceOfPublicObjectByPath(Long folder_id, Long classid, String path) Invokes the identically-named remote S_LibrarySession method.
protected void	DMCloseFolder(Long folder_id, Long classid) Invokes the identically-named remote S_LibrarySession method.
protected void	DMCloseSearch(Long id) Invokes the identically-named remote S_LibrarySession method.
protected void	DMCloseSelector(long cursorId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMCommit() Invokes the identically-named remote S_LibrarySession method.
protected void	DMCompleteTransaction(Transaction transaction) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMConvertToPrivateACL(Long id, Long classId, S_LibraryObjectDefinition sdef) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMCopyLibraryObject(Long id, Long classId, S_LibraryObjectDefinition sdef) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMCreateDefaultPolicyPropertyBundle(Long id, Long classId) Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
protected S_LibraryObjectData	DMCreateDefaultPropertyBundle(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
void	DMCreateRetainedEventDatabaseObjects(RetainedEvent event) Invokes the identically-named remote S_LibrarySession method.
protected void	DMCreateView(ViewSpecification vsp) Invokes the identically-named remote S_LibrarySession method.
protected void	DMDelete(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected void	DMDeleteAclIndexDeferredUpdates(Long[] ids) Invokes the identically-named remote S_LibrarySession method.
protected void	DMDeleteRepositoryParameter(String name) Invokes the identically-named remote S_LibrarySession method.
protected void	DMDeleteRetainedEvent(RetainedEvent event) Invokes the identically-named remote S_LibrarySession method.
protected oracle.sql.ORAData	DMDequeueMessage(Long id, Long classId, String subscriberName) Invokes the identically-named remote S_LibrarySession method.
protected oracle.sql.ORAData	DMDequeueMessageFromExceptionQueue(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
void	DMDeregisterClassEventHandler(Long classId) Notify server-side that previously registered event handlers for the specified ClassObject have been de-registered.
void	DMDeregisterEventHandler(Long id) Notify server-side that previously registered event handlers for the specified object have been de-registered.
protected void	DMDeregisterServiceEventHandler(IfsEventHandler handler) Notify server-side to de-register a Service event handler.
protected Long	DMDirectlyDispatchAuditEvent(AuditEvent event, Long specId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMDisconnect() Invokes the identically-named remote S_LibrarySession method.
protected void	DMDisposeSearch(Long id) Invokes the identically-named remote S_LibrarySession method.
void	DMDropRetainedEventDatabaseObjects(RetainedEvent event) Invokes the identically-named remote S_LibrarySession method.
protected void	DMEmptyWastebasket() Invokes the identically-named remote S_LibrarySession method.
protected void	DMEnqueueMessage(Long id, Long classId, oracle.sql.ORAData message) Invokes the identically-named remote S_LibrarySession method.
protected void	DMEnqueueMessage(Long id, Long classId, oracle.sql.ORAData message, String correlation) Invokes the identically-named remote S_LibrarySession method.
protected void	DMFeignUser(Long id, Long classid) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMfetchACEs(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMFetchPolicyListElements(Long policyListId, Long policyListClassId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMFetchProperties(Long propertyBundleId, Long propertyBundleClassId) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMfetchRevisions(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMfetchVersionSerieses(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMFilterContent(Long contentId, Long contentClassId, boolean plaintext, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMFilterDeletedObjects(boolean mode) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMFindPublicObjectByPath(Long folder_id, Long classid, String path) Invokes the identically-named remote S_LibrarySession method.
protected void	DMFlushEvents() Invokes the identically-named remote S_LibrarySession method.
boolean	DMFolderHasSubFolders(Long folder_id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMForceReadEvents() Invokes the identically-named remote S_LibrarySession method.
protected void	DMFree(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected void	DMGenerateSummary(Long contentId, Long contentClassId, String pointOfView, long sizeAsPercent, long sizeAsNumParagraphs, String summaryLevel, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMGenerateThemes(Long contentId, Long contentClassId, boolean fullThemes, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected AccessLevel	DMGetAccessLevel(Long id, Long classId, Long userId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetAclIndexDeferredUpdates(int maxItems) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetAllAncestorsOfDirectoryObject(Long id, Long userid) Invokes the identically-named remote S_LibrarySession method.
protected String[]	DMGetAllFolderPaths(Long id, Long classid, Long folderRefId, Long folderRefClassid, FolderPathOptions fpo, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetAllMembersOfDirectoryGroup(Long id, Long classid, boolean filterForDiscoverability) Invokes the identically-named remote S_LibrarySession method.
protected int	DMGetAncestorThreshold() Invokes the identically-named remote S_LibrarySession method.
protected String	DMGetAnyFolderPath(Long id, Long classid, Long folderRefId, Long folderRefClassid, FolderPathOptions fpo, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetArrayReferencingObjects(Long attributeId, AttributeValue referencedValue, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue	DMGetArrayTypeAttributeValue(long objectId, long attributeId, Long priClassId, int count) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetAttributesRsn() Invokes the identically-named remote S_LibrarySession method.
protected AuditCertificate[]	DMGetAuditCertificates(Long[] objectIds) Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue[]	DMGetAuditTypesForClass(String className, boolean includeNested) Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue[]	DMGetAuditTypesForCreateOperations() Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue[]	DMGetAuditTypesForFreeOperations() Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetCategoryIds(Long id, Long classid) Invokes the identically-named remote S_LibrarySession method.
protected Long	DMGetClockOffset() Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetCompositeAclIds(Long id, Long classid, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetConsumedStorage(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected RandomAccessor	DMGetContentByRandomAccess(Long coId, Long coClassId, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected ContentStreamSerializer	DMGetContentReader(Long id, Long classId, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected ContentStreamSerializer	DMGetContentStream(Long id, Long classId, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue[]	DMGetCustomAuditTypes() Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetDirectAncestorsOfDirectoryObject(Long id, Long userid) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetDirectMembersOfDirectoryGroup(Long id, Long userid, boolean filterForDiscoverability) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMGetDirectoryUserData() Invokes the identically-name remote S_LibrarySession method.
protected Long[]	DMGetDiscoverabilityOfPublicObjectsIds(Long[] ids) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetEffectiveClassPolicyListElements(Long id, Long classId, String operation) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetEffectivePolicyListElements(Long id, Long classId, String operation) Invokes the identically-named remote S_LibrarySession method.
protected String	DMGetEncryptedRepositoryParameter(String name) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetExpiredTimedLocks(int maxItems, int offset) Invokes the identically-named remote S_LibrarySession method.
protected ContentStreamSerializer	DMGetFilteredContent(Long contentId, Long contentClassId, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetFolderIndexDeferredUpdates(int maxItems) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetFolderItemCount(Long folder_id, Long classId, String folderRelClassname) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetFolderItemList(Long folder_id, Long classid, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetFolderReferences(Long publicObject_id, Long classid, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetHighestAuditId() Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetIdsForNewObjects(int length) Invokes the identically-named remote S_LibrarySession method.
Date	DMGetLastAccessDate(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetLeftwardRelationshipObjects(Long id, Long classId, Long relClassId, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetLeftwardRelationships(Long id, Long classId, Long relClassId, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetLeftwardRelationshipsCount(Long id, Long classId, Long relClassId) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMgetLibraryObjectData(Long id, Long classId, String attributeName, boolean selectFully) Invokes the identically-named remote S_LibrarySession method.
protected Long[]	DMGetLinks(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetLockedForSessionObjects() Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue	DMGetMapTypeAttributeValue(int dataType, long objectId, long attributeId, int count) Invokes the identically-named remote S_LibrarySession method.
protected int	DMGetMemberThreshold() Invokes the identically-named remote S_LibrarySession method.
protected String	DMGetNLSDatabaseParameterValue(String parameter) Invokes the identically-named remote S_LibrarySession method.
protected ObjectReferenceAttributeValue	DMGetObjectReferenceAttribute(Long id, Long classId, String attrName) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMGetOurPrimaryUserProfile() Invokes the identically-named remote S_LibrarySession method.
Long	DMGetPartitionValue(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected int	DMGetPreparedSelectorItemCount(String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, String[] bypassSecAliases, String joinCondition, String searchDefinition, boolean recursive, String hint, AttributeValue[] bindValues) Invokes the identically-named remote S_LibrarySession method.
protected AttributeValueTable[]	DMGetPreparedSelectorResults(String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, ColumnDescriptor[] colDescs, String[] bypassSecAliases, String joinCondition, String searchDefinition, boolean recursive, String language, int maxItemCount, int rowNumber, String hint, SortSpecification sort, AttributeValue[] bindValues) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMGetPrimaryUserProfile(Long id) Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue	DMGetProperty(Long propertyBundleId, Long propertyBundleClassId, String propertyName) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMGetPublicObjectData(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetPublicObjectsReferringToLockObject(Long id, Long classid, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected String	DMGetRepositoryParameter(String name) Invokes the identically-named remote S_LibrarySession method.
protected String[]	DMGetRepositoryParameterNames(String prefix) Invokes the identically-named remote S_LibrarySession method.
protected S_ClassObjectData	DMGetResolvedClassObjectData(Long id) Invokes the identically-named remote S_LibrarySession method.
protected RetainedEvent[]	DMGetRetainedEvents(RetainedEvent event, int maxItems) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetRightwardRelationshipObjects(Long id, Long classId, Long relClassId, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMGetRightwardRelationships(Long id, Long classId, Long relClassId, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
String	DMGetSchemaName() Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMGetSchemaObjectData(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected int	DMgetSearchItemCount(Long id, Vector bindValues, String language, int timeout) Invokes the identically-named remote S_LibrarySession method.
protected SearchSpecification	DMGetSearchSpecification(Long srchId) Invokes the identically-named remote S_LibrarySession method.
protected String	DMgetSearchSQLString(Long id) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetSelectorItemCount(String searchClass, String searchDefinition, boolean recursive) Invokes the identically-named remote S_LibrarySession method.
protected Hashtable	DMGetServiceConfigurationProperties() Invokes the identically-named remote S_LibrarySession method.
protected Long	DMGetServiceId() Invokes the identically-named remote S_LibrarySession method.
protected int[]	DMGetServiceTraceLoggerLevels() Invokes the identically-named remote S_LibrarySession method.
protected Long	DMGetSessionId() Invokes the identically-named remote S_LibrarySession method.
protected int[]	DMGetSessionTraceLoggerLevels() Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMGetSimpleObjectData(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectDefinition	DMGetSLibraryObjectDefinition(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetSubfolderCount(Long folder_id, Long classId, String folderRelClassname) Invokes the identically-named remote S_LibrarySession method.
protected ContentStreamSerializer	DMGetSummary(Long contentId, Long contentClassId, String pointOfView, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMGetSystemObjectData(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected ContextTheme[]	DMGetThemes(Long contentId, Long contentClassId, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected int	DMGetTotalFolderItemCount(Long folder_id, Long classid) Invokes the identically-named remote S_LibrarySession method.
protected long	DMGetWastebasketSelectorItemCount(String searchClass, String searchDefinition, boolean recursive) Invokes the identically-named remote S_LibrarySession method.
protected void	DMGrantAdmin(Long userid) Invokes the identically-named remote S_LibrarySession method.
protected void	DMHandleAuditEventDispatchRequests(ArrayList reqList, String tableName) Invokes the identically-named remote S_LibrarySession method.
void	DMInsertRetainedEvent(RetainedEvent event) Invokes the identically-named remote S_LibrarySession method.
protected void	DMIntegrateIntoVersionSeries(Long sid, Long sclassId, Long tid, Long tclassId) Invokes the identically-named remote S_LibrarySession method.
void	DMInvalidateTokenCredentials(Long userId) Invokes the identically-named remote S_LibrarySession method.
protected Object	DMInvokeOperation(Long id, Long classId, OperationContext op) Invokes the identically-named remote S_LibrarySession method.
protected Serializable	DMInvokeServerMethod(Long id, Long classId, String methodName, Serializable payload) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsAclIndexUpdateModeSynchronous() Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsArrayInputsUsedForAncestorSelection() Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsArrayInputsUsedForMemberSelection() Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsAttributeValueInValueDomain(Long id, Long classId, AttributeValue av) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsContentReadByUser(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsContextIndexEnabled() Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsDirectMemberOfDirectoryGroup(Long groupId, Long groupClassId, Long userId, Long userClassId) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsExecutionMode(int mode) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsInstanceOfClassVersionable(Long classId) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsLockObjectShared(Long id, Long classid) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsMemberOfDirectoryGroup(Long groupId, Long groupClassId, Long userId, Long userClassId) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsTransactionInProgress() Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMIsVersionable(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMListItems(Long folder_id, Long classid, String folderRelClassname, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMListPreparedSelectorItems(String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, String[] bypassSecAliases, String joinCondition, String searchDefinition, boolean recursive, String language, int maxItemCount, int rowNumber, String hint, SortSpecification sort, AttributeValue[] bindValues) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMListSelectorItems(String searchClass, String searchDefinition, boolean recursive, int maxItemCount, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMListWastebasketSelectorItems(String searchClass, String searchDefinition, boolean recursive, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected void	DMLockRows(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected String[]	DMLookupAuditEventOperationTypeKeys(int[] opTypes) Invokes the identically-named remote S_LibrarySession method.
protected int[]	DMLookupAuditEventOperationTypes(String[] keys) Invokes the identically-named remote S_LibrarySession method.
AuditTargetCode	DMLookupAuditTargetCode(String className) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNewBranchedVersionSeries(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected ContentStreamSerializer	DMNewContentStreamSerializer() Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNewPublicObject(S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNewRevision(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNewSchemaObject(S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected Long	DMNewSearch() Invokes the identically-named remote S_LibrarySession method.
protected Long	DMNewSearchFromObject(Long srchObjId) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNewSimpleObject(S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNewSystemObject(S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNewVersionSeries(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNextFolderItem(Long folder_id, Long classid) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMNextSearchItems(Long id, int batchCount) Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMNextSelectorBatch(long cursorId, int batchSize) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectData	DMNextSelectorItem(long cursorId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMOpenFolder(Long folder_id, Long classid, String folderRelClassname, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected void	DMOpenSearch(Long id, Vector bindValues, String language, int timeout) Invokes the identically-named remote S_LibrarySession method.
protected long	DMOpenSelector(String searchClass, String searchDefinition, boolean recursive, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
protected long	DMOpenWastebasketSelector(String searchClass, String searchDefinition, boolean recursive, SortSpecification sort) Invokes the identically-named remote S_LibrarySession method.
void	DMPersistTokenCredential(TokenCredential credential) Invokes the identically-named remote S_LibrarySession method.
protected void	DMPopTemporaryAccessCheckMode() Invokes the identically-named remote S_LibrarySession method.
protected void	DMPopTemporaryExecutionMode() Invokes the identically-named remote S_LibrarySession method.
protected void	DMPostAuditEvent(AuditEvent event, int mode) Invokes the identically-named remote S_LibrarySession method.
protected void	DMPostEvent(IfsEvent event) Invokes the identically-named remote S_LibrarySession method.
protected void	DMProcessEvents() Invokes the identically-named remote S_LibrarySession method.
protected Vector	DMProcessEventsInBackground() Invokes the identically-named remote S_LibrarySession method.
protected void	DMPushTemporaryAccessCheckMode(boolean mode) Invokes the identically-named remote S_LibrarySession method.
protected void	DMPushTemporaryExecutionMode(int mode) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRandomAccessorClose(S_RandomAccessorImpl ra) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRandomAccessorDispose(S_RandomAccessorImpl ra) Invokes the identically-named remote S_LibrarySession method.
protected Long	DMRandomAccessorGetContentObjectId(S_RandomAccessorImpl ra) Invokes the identically-named remote S_LibrarySession method.
protected Long	DMRandomAccessorGetDocumentId(S_RandomAccessorImpl ra) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMRandomAccessorIsWriteable(S_RandomAccessorImpl ra) Invokes the identically-named remote S_LibrarySession method.
protected long	DMRandomAccessorLength(S_RandomAccessorImpl ra) Invokes the identically-named remote S_LibrarySession method.
protected int	DMRandomAccessorRead(S_RandomAccessorImpl ra, long pos, byte[] b, int off, int len) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRandomAccessorSetSession(S_RandomAccessorImpl ra) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRandomAccessorTruncate(S_RandomAccessorImpl ra, long len) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRandomAccessorWrite(S_RandomAccessorImpl ra, long pos, byte[] b, int off, int len) Invokes the identically-named remote S_LibrarySession method.
protected void	DMReassociateLinks(Long oldId, Long oldClassId, Long newId, Long newClassId) Invokes the identically-named remote S_LibrarySession method.
protected boolean	DMReauthenticate(Credential credential, ConnectOptions options) Invokes the identically-named remote S_LibrarySession method.
protected int	DMRegisterAuditEventOperationType(String opTypeKey, int targetCode, String targetClass, int opCode, Boolean createOrFree) Invokes the identically-named remote S_LibrarySession method.
void	DMRegisterClassEventHandler(Long classId) Notify server-side of a registered event handler for the specified ClassObject.
protected int	DMRegisterCustomAuditEventOperationCodeKey(String opCodeKey) Invokes the identically-named remote S_LibrarySession method.
void	DMRegisterEventHandler(Long id) Notify server-side of a registered event handler for the specified object.
protected void	DMRegisterServiceEventHandler(IfsEventHandler handler) Notify server-side of a new registered Service event handler.
protected int	DMReleaseExpiredLockObject(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRemoveAccessControlEntry(Long id, Long classId, Long aceId, Long aceClassId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMremoveAllAccessControlEntries(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
void	DMRemoveAttributeFromClassObject(Long id, S_LibraryObjectDefinition def) Removes an Attribute from an existing ClassObject.
protected void	DMRemoveAuditEvents(long[] eventIds, String tableName) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRemoveAuditEventsForTarget(Long specId, Long targetId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRemoveFromFolder(Long folder_id, Long classid, Long rightObj, Long rightObjClassid, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRemoveMemberFromDirectoryGroup(Long group_id, Long classid, Long rightObj, Long rightObjClassid) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRemoveMembersFromDirectoryGroup(Long group_id, Long classid, Long[] rightObjIds, Long[] rightObjClassids) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRemoveRawAuditEvents(RawAuditEvent[] rawEvents) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRemoveRelationship(Long id, Long classId, Long relId, Long relClassId) Invokes the identically-named remote S_LibrarySession method.
protected ContentStreamSerializer	DMRender(Long id, Long classId, String rendererType, String rendererName, Hashtable options, boolean reader) Invokes the identically-named remote S_LibrarySession method.
protected void	DMReserveNext(Long id, Long classId, String contentPath, String comment) Invokes the identically-named remote S_LibrarySession method.
protected void	DMResolveObjects(Long[] ids, Long[] classIds, ObjectResolverSpecification spec) Invokes the identically-named remote S_LibrarySession method.
protected void	DMRollback() Invokes the identically-named remote S_LibrarySession method.
protected long	DMSchemaVersionNumber() Invokes the identically-named remote S_LibrarySession method.
protected String	DMSchemaVersionString() Invokes the identically-named remote S_LibrarySession method.
protected AttributeValue[]	DMSelectAggregateAuditEventColumns(Long auditSpec, String aggFuncName, String[] columnNames, String[] aggColumnNames, String filterClause, String sortClause) Invokes the identically-named remote S_LibrarySession method.
protected AuditEvent[]	DMSelectAuditEvents(Long auditSpec, String filterClause, AttributeValue[] bindValues, String sortClause, int maxItems) Invokes the identically-named remote S_LibrarySession method.
protected RawAuditEvent[]	DMSelectRawAuditEvents(String filterClause, int maxItems) Invokes the identically-named remote S_LibrarySession method.
protected AuditFolderPath	DMSelectSpecificAuditFolderPath(long folderPathId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSendClientVersionInformation(long versionNumber, String versionString) Invokes the identically-named remote S_LibrarySession method.
protected S_LibraryObjectDefinition	DMSetAttributes(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetContentReadByUser(Long id, Long classId, boolean readState, Long refObjId, Long refObjClassId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetEncryptedRepositoryParameter(String name, String value) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetExecutionMode(int mode) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetLibrarySession(LibrarySession session) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetRepositoryParameter(String name, String value) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetSearchSpecification(Long srchId, SearchSpecification sp) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetServiceTraceLoggerLevels(int[] levels) Invokes the identically-named remote S_LibrarySession method.
protected void	DMSetSessionTraceLoggerLevels(int[] levels) Invokes the identically-named remote S_LibrarySession method.
protected void	DMTrace(int channel, int level, Long serviceId, Long sessionId, Long id, String classname, String payload) Invokes the identically-named remote S_LibrarySession method.
protected void	DMUndelete(Long id, Long classId, S_LibraryObjectDefinition def) Invokes the identically-named remote S_LibrarySession method.
protected void	DMUnregisterAuditEventOperationType(String opTypeKey) Invokes the identically-named remote S_LibrarySession method.
protected void	DMUnReserve(Long id, Long classId) Invokes the identically-named remote S_LibrarySession method.
protected void	DMupdateAccessControlEntry(Long id, Long classId, Long aceId, Long aceClassId, S_LibraryObjectDefinition sdef) Invokes the identically-named remote S_LibrarySession method.
protected RandomAccessor	DMUpdateContentByRandomAccess(Long docId, Long docClassId, S_LibraryObjectDefinition sdocdef, Long expirationPeriod) Invokes the identically-named remote S_LibrarySession method.
void	DMUpdateLocalizer(Hashtable properties) Updates the S_LibrarySession Localizer to reflect the Localizer properties specified as name/value pairs.
void	DMUpdateSessionDefaults(Hashtable properties) Invokes the identically-named remote S_LibrarySession method.
protected long	DMVersionNumber() Invokes the identically-named remote S_LibrarySession method.
protected String	DMVersionString() Invokes the identically-named remote S_LibrarySession method.
void	dropRetainedEventDatabaseObjects(RetainedEvent event) Drop tables for a RetainedEvent type.
void	emptyWastebasket() Empty the wastebasket.
boolean	equals(LibrarySession otherSession) Compares whether two LibrarySessions are the same by comparing IDs.
Hashtable	establishSessionState(Hashtable stateMap) Establish session state for the session.
void	flushEvents() Flushes any outgoing events to the database.
void	forceReadEvents() Forces a read and processing of incoming events from other services.
void	free(LibraryObject[] items) Free all the passed objects.
Vector	getAclIndexDeferredUpdates(int maxItems) Gets a set of Deferred ACL Resolution Entries
int	getAncestorThreshold() Gets the threshold for using a temp table to select all (recursive) ancestors of a directory object.
int	getApplicationMode() Gets the application mode for the session.
String	getApplicationName() Gets the name of the application that created this session.
AttributeValue	getArrayTypeAttributeValue(AttributeValueArray av, long objectId, long attributeId, Long priClassId, int count) Gets a fully resolved array-type AttributeValue with non-transient elements that is a copy of the specified array-type AttributeValue.
String	getAttributeSortName(String classname, String attributename) return the Database object name that corresponds to an Attribute of a specified ClassObject.
long	getAttributesRsn() Gets the resolution sequence number at which an attribute was last added or removed.
AuditCertificate[]	getAuditCertificates(Long[] objectIds) Select AuditCertificates for the specified object IDs.
AttributeValue[]	getAuditTypesForClass(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.
CachePerformance	getBeanLibraryObjectDataCachePerformance() Gets the cache performance object for the bean LibraryObjectData cache.
Collection	getClassAccessControlListCollection() Gets a reference to the ClassAccessControlList collection.
Collection	getClassDomainCollection() Gets a reference to the ClassDomain collection.
ClassObject	getClassObject(Long classid) Gets the ClassObject for the specified class id.
ClassObject	getClassObjectByName(String className) Returns a class object given a class name, throwing an exception if not found.
ClassObject	getClassObjectByName(String className, boolean enforce) Returns a class object given a class name, optionally returning null if not found.
Collection	getClassObjectCollection() Gets a reference to the ClassObject collection.
AttributeValue	getClassObjectValueByName(String name) Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.
Long	getClockOffset() Gets the clock offset, representing the number of milliseconds the DBMS clock is ahead of this mid tier.
ClonedLibrarySessionInfo	getClonedLibrarySessionInfo() Gets the ClonedLibrarySessionInfo for this session.
ConfigurationCategoryDescriptor	getConfigurationCategoryDescriptor(String className) Gets the ConfigurationCategoryDescriptor for the specified ConfigurationCategory class name.
LibraryObjectDefinition	getCopyContext(Long id) Get the context of a copy operation, if a copy is in progress for the specified object.
LibraryObjectDefinition	getCreateContext(Long id) Get the context of a create operation, if a create is in progress for the specified object.
Actor	getCurrentActor() Gets the current Actor in effect for this session.
Folder	getCurrentAuditDomainContext() Gets the current "Audit Domain" context for the session's user.
Date	getCurrentDate() Gets the current Date, with the clock offset applied.
Folder	getCurrentOrDefaultAuditDomainContext() Gets the current or default "Audit Domain" context for the session's user.
long	getCurrentTimeMillis() Gets the current time in milliseconds, with the clock offset applied.
AttributeValue[]	getCustomAuditTypes() Gets the custom audit operation type values.
String	getDatabaseCharacterSet() Returns the Iana character set of the database.
Media	getDefaultContentMedia() Get the default content Media instance.
ContentQuota	getDefaultContentQuota() Gets the session's default ContentQuota, set via setDefaultContentQuota().
String	getDefaultFolderRelationshipClassname() Deprecated. CM SDK 10g: no replacement functionality; FolderPathRelationship is now used as the class name
SortSpecification	getDefaultFolderSortSpecification() get the default SortSpecification that is used by default for all Folder selection operations.
DirectoryObject	getDirectoryObject(Long id) Lookup a DirectoryObject by its id.
DirectoryObjectInterface	getDirectoryObjectInterface(Long id) Gets the DirectoryObjectInterface for the specified id.
DirectoryObjectInterface[]	getDirectoryObjectInterfaces(Long[] ids) Gets the DirectoryObjectInterfaces for the specified ids.
DirectoryUser	getDirectoryUser() Return the user associated with the current session.
Collection	getDirectoryUserCollection() Gets a reference to the DirectoryUser collection.
Long[]	getDiscoverabilityOfPublicObjectsIds(Long[] ids) Return indication as to which PublicObject objects specified (by ID) the current user can discover.
PropertyBundle	getDomainPropertyBundle() Gets the domain PropertyBundle.
AttributeValue	getDomainPropertyValue(String name) Gets the value of a domain property, by name.
String	getEncryptedRepositoryParameter(String name) Gets the value of the specified repository parameter.
oracle.ifs.beans.LibrarySessionEventPoller	getEventPoller() Gets the event poller for this LibrarySession.
Collection	getExtendedPermissionCollection() Gets a reference to the ExtendedPermission collection.
Collection	getExtendedUserProfileCollection() Gets a reference to the ExtendedUserProfile collection.
Vector	getFolderIndexDeferredUpdates(int maxItems) Gets a set of Deferred Folder Index Updates
String	getFolderPathDelimiter() Gets the current session's folder path delimiter.
protected SortSpecification	getFolderSortSpecification(PublicObject po) get the SortSpecification for a particular object.
Collection	getFormatCollection() Gets a reference to the Format (by name) collection.
Collection	getFormatExtensionCollection() Gets a reference to the FormatExtension collection.
LibraryObjectDefinition	getFreeContext(Long id) Get the context of a free operation, if a free is in progress for the specified object.
OperationActionSpecification[]	getGlobalOperationActionSpecifications() Gets the "global" OperationActionSpecifications.
DirectoryUser	getGuestUser() Gets the DirectoryUser who is the guest user.
long	getHighestAuditId() Get the highest Audit Id in use.
Long	getId() Gets the id of this session.
Long	getIdForNewObject() Return an Id that can be used to create a new LibraryObject.
Long[]	getIdsForNewObjects(int length) Return a set of Ids that can be used to import a set of objects.
IfsConnection	getIfsConnection() Returns an IfsConnection for this LibrarySession.
LibraryObject	getLibraryObject(Long id) Lookup a LibraryObject by its id.
LibraryObject	getLibraryObject(Long id, Long classId) Lookup a LibraryObject by its id and classId.
LibraryObject	getLibraryObject(S_LibraryObjectData data) getLibraryObject - lookup a LibraryObject by its data.
CachePerformance	getLibraryObjectCachePerformance() Gets the cache performance object for the LibraryObject cache.
S_LibraryObjectData	getLibraryObjectData(Long id, Long classId, String attributeName, boolean selectFully) Gets the S_LibraryObjectData for the specified id and class id.
Localizer	getLocalizer() Gets the localizer used by this session.
Long	getLowestCommonClassObjectIdAncestor(SimpleObjectInterface[] mos) Gets the lowest common ClassObject ancestor for the specified array of SimpleObjectInterface, excluding tableless ClassObjects.
AttributeValue	getMapTypeAttributeValue(int dataType, long objectId, long attrIdVal, int count) Gets a fully resolved map-type AttributeValue with non-transient elements that is a copy of the specified map-type AttributeValue.
Collection	getMediaCollection() Gets a reference to the Media collection.
int	getMemberThreshold() Gets the threshold for using a temp table to select all (recursive) members of a group.
String	getName() Gets the name of the session.
long	getNextSequence() Gets the next unique sequence with respect to this session.
Media	getNonContentMedia() Get the non content Media instance.
protected SortSpecification	getObjectFolderSortSpecification(PublicObject po) get the SortSpecification for a particular object.
PublicObject[]	getObjectsLockedForSession() Gets the array of PublicObjects that the current session holds session locks on.
Collection	getPermissionBundleCollection() Gets a reference to the PermissionBundle collection.
Collection	getPolicyCollection() Gets a reference to the Policy collection.
Collection	getPolicyListCollection() Gets a reference to the PolicyList collection.
PrimaryUserProfile	getPrimaryUserProfile() Return the current user's primary UserProfile.
PrimaryUserProfile	getPrimaryUserProfile(DirectoryUser user) Return the a specified user's primary UserProfile.
PublicObject	getPublicObject(Long id) Lookup a PublicObject by its id.
PublicObject	getPublicObject(Long id, Long classId) Lookup a PublicObject by its id and classId.
PublicObjectInterface	getPublicObjectInterface(Long id) Gets the PublicObjectInterface for the specified id.
PublicObjectInterface[]	getPublicObjectInterfaces(Long[] ids) Gets the PublicObjectInterfaces for the specified ids.
String	getRepositoryParameter(String name) Gets the value of the specified repository parameter.
String[]	getRepositoryParameterNames(String prefix) Gets the repository parameter names that start with the specified prefix.
S_ClassObjectData	getResolvedClassObjectData(Long id) Gets the fully-resolved S_ClassObjectData.
String	getResourceString(String key) Gets the resource string for the specified key.
String	getResourceString(String key, Object[] params) Gets the resource string for the specified key, and substitutes the specified parameters into that resource string.
RetainedEvent[]	getRetainedEvents(RetainedEvent event, int maxItems) get a set of RetainedEvents, using a specified RetainedEvent to indicate the type of RetainedEvent desired.
Folder	getRootFolder() Return the top-most Folder in the CM SDK folder hierarchy.
String	getSchemaName() Gets the schema name in effect for the service.
SchemaObject	getSchemaObject(Long id) Lookup a SchemaObject by its id.
SchemaObject	getSchemaObject(Long id, Long classId) Lookup a SchemaObject by its id and classId.
SchemaObjectInterface	getSchemaObjectInterface(Long id) Gets the SchemaObjectInterface for the specified id.
SchemaObjectInterface[]	getSchemaObjectInterfaces(Long[] ids) Gets the SchemaObjectInterfaces for the specified ids.
long	getSchemaVersionNumber() Returns the version number for the CM SDK schema on which this session is connected.
String	getSchemaVersionString() Returns the version String for the CM SDK schema on which this session is connected.
String	getServerProperty(String key, String defaultValue) Gets the String value for the specified key in the server properties file.
Object	getServerSideLockObject() Gets the Object used by LibrarySession to synchronize invocations to the server-side class, mainly the invocations of the methods defined by the S_LibrarySessionInterface.
long	getServerVersionNumber() Returns the CM SDK server-side version number, as a long value.
String	getServerVersionString() Returns the version String for the CM SDK server-side software.
String	getServiceConfigurationName() Gets the name of the ServiceConfiguration that was used to initialize the CM SDK service to which this session is connected.
AttributeValue	getServiceConfigurationProperty(String name) Gets the specified service configuration property.
boolean	getServiceConfigurationProperty(String name, boolean defaultValue) Gets the value of the specified service configuration property, as a boolean.
int	getServiceConfigurationProperty(String name, int defaultValue) Gets the value of the specified service configuration property, as an integer.
String	getServiceConfigurationProperty(String name, String defaultValue) Gets the value of the specified service configuration property, as a string.
Long	getServiceId() Gets the id of this session's service.
String	getServiceName() Gets the name of the CM SDK service to which this session is connected.
int[]	getServiceTraceLoggerLevels() Gets the trace levels of the S_LibraryServiceTraceLogger.
protected S_LibrarySessionInterface	getSessionContext() Gets the server-side session context.
String	getSessionIdentifier() Gets a session identifier.
Object	getSessionState(String key) Get a session state item.
int[]	getSessionTraceLoggerLevels() Gets the trace levels of the S_LibrarySessionTraceLogger.
Collection	getSharedAccessControlListCollection() Gets a reference to the SharedAccessControlList collection.
protected S_LibraryObjectDataSharedStateFactory	getSharedStateFactory() Returns the Shared State factory in effect for the session.
SimpleObject	getSimpleObject(Long id) Lookup a SimpleObject by its id.
SimpleObject	getSimpleObject(Long id, Long classId) Lookup a SimpleObject by its id and classId.
SimpleObjectInterface	getSimpleObjectInterface(Long id, Long classId) Gets the SimpleObjectInterface for the specified id.
SimpleObjectInterface[]	getSimpleObjectInterfaces(Long[] ids) Gets the SimpleObjectInterfaces for the specified ids.
SimpleObjectInterface[]	getSimpleObjectInterfaces(Long[] ids, Long primaryClassId) Gets the SimpleObjectInterfaces for the specified ids.
Collection	getSystemAccessControlListCollection() Gets a reference to the SystemAccessControlList collection.
DirectoryUser	getSystemDirectoryUser() Gets the DirectoryUser who is the permanent admin user.
Collection	getSystemLockObjectCollection() Gets a reference to the SystemLockObject collection.
SystemObject	getSystemObject(Long id) Lookup a SystemObject by its id.
SystemObject	getSystemObject(Long id, Long classId) Lookup a SystemObject by its id and classId.
SystemObjectInterface	getSystemObjectInterface(Long id) Gets the SystemObjectInterface for the specified id.
SystemObjectInterface[]	getSystemObjectInterfaces(Long[] ids) Gets the SystemObjectInterfaces for the specified ids.
Object	getSystemUserToken() Gets the system token that can be used to efficiently clone system sessions.
TraceLogger	getTraceLogger() Gets the trace logger used by this session.
LibraryObjectDefinition	getUpdateContext(Long id) Get the context of an update operation, if an update is in progress for the specified object.
DirectoryUser	getUser() Return the user associated with the current session.
Long	getUserId() Gets the id of the current user.
String	getUserIdentifier() Return the identifer for the user associated with the current session.
Collection	getValueDefaultCollection() Gets a reference to the ValueDefault collection.
Collection	getValueDomainCollection() Gets a reference to the ValueDomain collection.
long	getVersionNumber() Returns the CM SDK bean-side software version number, as a long value.
String	getVersionString() Returns the version String for the CM SDK bean-side software.
DirectoryGroup	getWorldDirectoryGroup() Gets the DirectoryGroup that represents World access.
void	grantAdministration(DirectoryUser user) Grant the Administrator Mode state for the specified Directory User.
void	handleAuditEventDispatchRequests(ArrayList reqList, String tableName) Handle a list of AuditEvent dispatch requests.
void	handleEvent(IfsEvent event) Handles the specified event.
void	impersonateUser(DirectoryUser newuser) Assume the identity of another user.
protected void	initialize() Initializes connection with CM SDK.
void	insertRetainedEvent(RetainedEvent event) insert a RetainedEvent.
void	invalidateTokenCredentials(DirectoryUser user) Invalidates all the token credentials for the given user.
Serializable	invokeServerMethod(String methodName, Serializable payload) Invokes a custom server-side method.
boolean	isAclIndexUpdateModeSynchronous() Check if ACL Index update mode is synchronous
boolean	isAdministrationDiscoverMode() Gets whether this LibrarySession is in discover administration mode.
boolean	isAdministrationMode() Gets whether this LibrarySession is in administration mode.
boolean	isAlwaysCacheSelectedData() Gets whether the current session always caches selected data from Selectors.
boolean	isArrayInputsUsedForAncestorSelection() Gets whether to use array inputs for selecting "all ancestors" if size has exceeded threshhold.
boolean	isArrayInputsUsedForMemberSelection() Gets whether to use array inputs for selecting "all members" if size has exceeded threshhold.
boolean	isBusy() Return busy state of this LibrarySession.
boolean	isClonedLibrarySession() Gets indication as to whether this session is a cloned session.
boolean	isConnected() Return connection state of this LibrarySession
boolean	isDefinitionCloningRequired() Gets whether the current session requires user-specified instances of LibraryObjectDefinition (or one of its subclasses) to be cloned prior to using it server-side.
boolean	isDiscoverablePublicObjectId(Long id) Return indication as to whether the PublicObject ID specified represents an object that the current user can discover.
boolean	isExecutionMode(int mode) Checks whether current session is in at least the execution mode specified.
boolean	isFilterDeletedObjectsEnabled() Return indication as to whether this session has deleted object filtering enabled.
boolean	isFolderItemCachingEnabled() Gets whether the server supports folder item caching.
boolean	isFullTextIndexingEnabled() Gets whether full-text indexing is enabled.
boolean	isGroupMembershipCacheEnabled() Gets whether the GroupMembershipCache is enabled.
boolean	isGuestUser() Returns true if the session's current user is the guest user.
boolean	isImplicitTransactionInProgress() Return indication as to whether there is an implicit transaction in progress.
boolean	isInstallationMode() Gets whether this LibrarySession is in installation mode.
boolean	isOuterOperation() Return indication as to whether the outer most operation (of a potentially nested operation) is currently in progress.
boolean	isPreventSessionTimeouts() Gets whether the current session prevents any session or operation timeouts.
boolean	isPublicObjectIdDiscoverable(Long id) Return indication as to whether the PublicObject matching the specified object ID is discoverable.
boolean	isSystemAdministrationMode() Gets whether this LibrarySession is in system administration mode.
boolean	isSystemDirectoryUser() Returns true if the session's current user is the permanent admin user.
boolean	isTraced(int channel, int level) Gets whether tracing is enabled for the specified channel and level.
boolean	isTransactionInProgress() Gets whether this LibrarySession is in a transaction, explicit or implicit.
boolean	isUpgradeInProgress() See if the session behaves as though an upgrade is in progress.
String	lookupAuditEventOperationTypeKey(int opType) Looks up an audit event operation type key by its numeric value, returning the string key or null if the numeric code is not registered.
String[]	lookupAuditEventOperationTypeKeys(int[] opTypes) Looks up audit event operation type keys by their numeric values, returning the string keys.
int[]	lookupAuditEventOperationTypes(String[] opTypeKeys) Looks up audit event operation types by their string key, returning the corresponding numeric equivalents.
AuditTargetCode	lookupAuditTargetCode(String className) Looks up an audit target code structure from the specified Class name or other registered alias for the desired type.
String	lookupInverseInstanceLabel(String classname, String label) Gets the name of an uniquely-named instance by its label.
ContentStreamSerializer	newContentStreamSerializer() Return the Content stream serializer.
void	popApplicationMode() Resets any temporary application mode back to the previous temporary application mode setting.
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.
protected void	postAdminModeChange() Post intra-session admin mode change.
void	postAuditEvent(AuditEvent event) Create a new audit event.
void	postAuditEvent(AuditEvent event, int mode) Create a new audit event.
void	postAuditEvent(LibraryObject target, AuditEvent event) Create a new audit event.
void	postAuditEvent(LibraryObject target, AuditEvent event, int mode) Create a new audit event.
void	postCustomAuditEvent(AuditEvent event) Create a new custom audit event.
void	postCustomAuditEvent(LibraryObject target, AuditEvent event) Create a new custom audit event.
protected void	postDefaultFolderOptionChange() Post intra-session change to default Folder options, such as default sort order or FolderRelationship class.
protected void	postEvent(IfsEvent event) Post the specified event.
void	processEvent(IfsEvent event) Processes the specified event.
void	processEvents() Polls the server for any events queued for transport to this LibrarySession and immediately processes them.
protected void	processEventsInBackground() Polls the server for any events queued for transport to this LibrarySession and immediately processes them.
void	pushApplicationMode(int mode) Establishes a new temporary Application mode for the session.
void	pushTemporaryAccessCheckMode(boolean mode) Establishes a temporary access check mode for the session.
void	pushTemporaryExecutionMode(int mode) Establishes a temporary execution mode for the session.
Object	putSessionState(String key, Object value) Add a session state item.
boolean	reauthenticate(Credential credential, ConnectOptions options) Reauthenticates the DIRECTORYUSER for which this LibrarySession was originally created (as opposed to the DIRECTORYUSER specified by a subsequent call to impersonateUser).
protected void	recacheObject(LibraryObject obj) Re-cache the specified object.
void	reestablishRaciSessionContext(RandomAccessContentInterface raci) Deprecated. CMSDK 10gR2: use RandomAccessor
int	registerAuditEventOperationType(String opTypeKey, int targetCode, String targetClass, int opCode, Boolean createOrFree) Register a new audit event operation type.
void	registerClassEventHandler(ClassObject co, boolean includeSubclasses, IfsEventHandler handler) Registers the specified IfsEventHandler to receive events for all objects in the specified class.
void	registerCollection(Collection collection, String classname) Registers a collection so that it can be automatically reset by handleEvent as needed when new LibraryObjects are created, updated, or freed.
int	registerCustomAuditEventOperationCodeKey(String opCodeKey) Register a new custom operation code key.
void	registerCustomAuditEventOperationType(String opTypeKey, String opCodeKey, int targetCode, String targetClass) Register a new custom audit event operation type.
void	registerEventHandler(LibraryObject lo, IfsEventHandler handler) Registers the specified IfsEventHandler to receive events for the specified LibraryObject.
void	registerServiceEventHandler(IfsEventHandler handler) Registers the specified IfsEventHandler to receive events for all committed events processed by the current service.
void	removeAuditEvents(long[] eventIds, String tableName) Free audit events.
void	removeAuditEventsForTarget(Long specId, Long targetId) Free audit events from a specific Audit history, by target ID.
void	removeRawAuditEvents(RawAuditEvent[] rawEvents) Free raw audit events.
Object	removeSessionState(String key) Remove a session state item.
LibrarySession	reserveClonedSession() Reserves a cloned session.
void	resolveObjects(LibraryObject[] objs, ObjectResolverSpecification spec) Force resolution of a set of LibraryObjects
void	resumeBackgroundProcessing() Resumes any background event processing.
void	rollback() Discards all pending changes for all in-progress Transactions for this LibrarySession.
AttributeValue[]	selectAggregateAuditEventColumns(Long auditSpec, String aggFuncName, String[] columnNames, String[] innerColNames, String filterClause, String sortClause) Returns the list of distinct values of the specified AuditEvent columns, along with an optional aggregate function.
AuditEvent[]	selectAuditEvents(Long auditSpec, String filterClause, AttributeValue[] bindValues, String sortClause, int maxItems) Select audit events.
AuditEvent[]	selectAuditEvents(Long auditSpec, String filterClause, String sortClause, int maxItems) Select audit events.
RawAuditEvent[]	selectRawAuditEvents(String filterClause, int maxItems) Select raw audit events.
AuditFolderPath	selectSpecificAuditFolderPath(long folderPathId) Select the specific AuditFolderPath for a given primary key.
void	setAdministrationMode(boolean mode) Set the administrator mode state for this session.
void	setAlwaysCacheSelectedData(boolean value) Sets whether the current session always caches selected data from Selectors.
void	setApplicationName(String name) Sets the name of the application that is using this session.
void	setCopyContext(Long id, LibraryObjectDefinition def) Set the context of a copy operation for the specified object.
void	setCreateContext(Long id, LibraryObjectDefinition def) Set the context of a create operation for the specified object.
void	setCurrentActor(Actor actor) Sets the current Actor in effect for this session.
void	setCurrentAuditDomainContext(Folder domain) Sets the current "Audit Domain" context.
void	setDefaultContentQuota(ContentQuota quota) Sets the session's default ContentQuota.
void	setDefaultFolderRelationshipClassName(String classname) Deprecated. CM SDK 10g: no replacement functionality; FolderPathRelationship is now used as the class name
void	setDefaultFolderSortSpecification(SortSpecification sort) Sets the default SortSpecification that is used by default for all Folder selection operations.
void	setDefinitionCloningRequired(boolean option) Sets whether the current session requires user-specified instances of LibraryObjectDefinition (or one of its subclasses) to be cloned prior to using it server-side.
void	setEncryptedRepositoryParameter(String name, String value) Sets the value of the specified repository parameter.
void	setExecutionMode(int mode) Set the execution mode for this LibrarySession.
void	setFilterDeletedObjectsEnabled(boolean mode) Set deleted object filtering state for this session.
void	setFolderPathDelimiter(String delim) Sets the current session's Folder path delimiter.
void	setFreeContext(Long id, LibraryObjectDefinition def) Set the context of a free operation for the specified object.
void	setInstallationMode(boolean mode) Set the Installation Mode state for this LibrarySession.
protected void	setObjectFolderSortSpecification(PublicObject po, SortSpecification sort) Sets an object-level SortSpecification that is to be used for all Folder selection operations for a particular object.
void	setPreventSessionTimeouts(boolean value) Sets whether the current session should prevent any session or operation timeouts.
void	setRepositoryParameter(String name, String value) Sets the value of the specified repository parameter.
void	setServiceTraceLoggerLevels(int[] levels) Sets the trace levels of the S_LibraryServiceTraceLogger.
void	setSessionTraceLoggerLevels(int[] levels) Sets the trace levels of the S_LibrarySessionTraceLogger.
void	setSystemAdministrationMode(boolean mode) Set the System admin Mode state for this LibrarySession.
void	setUpdateContext(Long id, LibraryObjectDefinition def) Set the context of an update operation for the specified object.
void	setUpgradeInProgress(boolean value) Sets indication of whether the session behaves as though an upgrade is in progress.
void	trace(int channel, int level, String payload) Issues a trace request to the trace logger.
void	undelete(PublicObject[] items) Undeletes all the passed PublicObjects.
void	unlockForSession(PublicObject[] items) Release session locks on a set of PublicObjects.
void	unregisterAuditEventOperationType(String opTypeKey) Unregister an audit event operation type.
void	unregisterCustomAuditEventOperationType(String opTypeKey) Unregister a custom audit event operation type.
void	unreserveClonedSession(LibrarySession sess) Unreserves a cloned session.
void	verifyAdministrationMode() Verify that the effective execution mode for the session is at least administration mode.
void	verifyExecutionMode(int mode) Verify that the effective execution mode for the session is at least the mode specified.
protected void	verifyInstallationMode() Verify that the effective execution mode for the session is at least installation mode.

Methods inherited from class java.lang.Object

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

Field Detail

ACLD_DISCOVERER_ADMIN

public static final long ACLD_DISCOVERER_ADMIN

Id of the permanent admin user.

See Also:

Constant Field Values

(Unpublished)

STATEMENT_KEY_COLLECTION_POLICYLIST

public static final String STATEMENT_KEY_COLLECTION_POLICYLIST

Statement key to use for PolicyList collection.

See Also:

Constant Field Values

(Unpublished)

STATEMENT_KEY_COLLECTION_SHAREDACL

public static final String STATEMENT_KEY_COLLECTION_SHAREDACL

Statement key to use for Shared ACL collection.

See Also:

Constant Field Values

(Unpublished)

m_User

protected DirectoryUser m_User

the authenticated user.

(Unpublished)

m_FeignedUser

protected DirectoryUser m_FeignedUser

the current impersonated user.

(Unpublished)

m_PrimaryUserProfile

protected PrimaryUserProfile m_PrimaryUserProfile

the current user's PrimaryUserProfile.

(Unpublished)

m_DomainPropertyBundle

protected PropertyBundle m_DomainPropertyBundle

The domain PropertyBundle

(Unpublished)

m_GuestUser

protected DirectoryUser m_GuestUser

The guest user (lazily set)

(Unpublished)

m_CurrentActor

protected Actor m_CurrentActor

The effective Actor (lazily set)

(Unpublished)

m_RootFolder

protected Folder m_RootFolder

The root folder

(Unpublished)

m_Connected

protected volatile boolean m_Connected

connection state; volatile so changes are immediately visible to all threads

(Unpublished)

m_Id

protected Long m_Id

Id of the Session

(Unpublished)

m_AttributesRsn

protected long m_AttributesRsn

The resolution sequence number at which an attribute was last added or removed.

(Unpublished)

m_Sequence

protected long m_Sequence

The next unique sequence value for this session.

(Unpublished)

m_ServiceId

protected Long m_ServiceId

Id of the server-side Service

(Unpublished)

m_ClockOffset

protected Long m_ClockOffset

The time offset between the mid tier clock and the DBMS clock.

(Unpublished)

m_AuthenticatedUserName

protected String m_AuthenticatedUserName

Name of the authenticated user.

(Unpublished)

m_ServiceName

protected String m_ServiceName

Name of the service.

(Unpublished)

m_ApplicationName

protected String m_ApplicationName

Name of the application provided in the original connect options.

(Unpublished)

m_dnSuffix

protected String m_dnSuffix

Distinguished name suffix, from the server properties.

(Unpublished)

m_ServiceConfigurationProperties

protected Hashtable m_ServiceConfigurationProperties

table of service configuration properties.

(Unpublished)

m_FilterDeletedObjectsEnabled

protected boolean m_FilterDeletedObjectsEnabled

state of the deleted object filtering.

(Unpublished)

m_DefaultFolderSortSpecification

protected SortSpecification m_DefaultFolderSortSpecification

default SortSpecification for Folder select operations.

(Unpublished)

m_ObjectFolderSortSpecification

protected Hashtable m_ObjectFolderSortSpecification

object-level SortSpecifications for Folder select operations.

(Unpublished)

m_ConfigCategoryDescriptorMap

protected ConfigurationCategoryDescriptorMap m_ConfigCategoryDescriptorMap

Map for ConfigurationCategory select operations.

(Unpublished)

m_PreventSessionTimeouts

protected boolean m_PreventSessionTimeouts

Indication as to whether session timeouts are suppressed

(Unpublished)

m_AlwaysCacheSelectedData

protected boolean m_AlwaysCacheSelectedData

Indication as to whether to always cache selected data from Selectors.

(Unpublished)

m_EventProcessingEnabled

protected boolean m_EventProcessingEnabled

Whether event processing is enabled for this LibrarySession.

(Unpublished)

m_InvokeServerSideLock

protected Object m_InvokeServerSideLock

Something on which to synchronize during our DMFoo calls and pseudo DMFoo calls.

(Unpublished)

m_ServerSideCoordinator

protected LibrarySession.ServerSideCoordinator m_ServerSideCoordinator

Holds server-side coordination info.

(Unpublished)

m_EventPoller

protected oracle.ifs.beans.LibrarySessionEventPoller m_EventPoller

The event poller.

(Unpublished)

m_RegisteredEventHandlers

protected Hashtable m_RegisteredEventHandlers

Registered event handlers (see registerEventHandler()).

(Unpublished)

m_RegisteredClassEventHandlers

protected Hashtable m_RegisteredClassEventHandlers

Registered class event handlers (see registerEventHandler()).

(Unpublished)

m_LibraryObjectCache

protected LibraryObjectCache m_LibraryObjectCache

LibraryObject cache

(Unpublished)

m_Localizer

protected Localizer m_Localizer

the Localizer for this session.

(Unpublished)

m_FolderPathDelimiter

protected String m_FolderPathDelimiter

the folder-path delimiter for the session defaults to FolderPathResolver.FOLDER_DELIMITER

(Unpublished)

m_DefaultContentQuota

protected ContentQuota m_DefaultContentQuota

the default ContentQuota object that will be used for any new Documents

(Unpublished)

m_SessionState

protected Hashtable m_SessionState

Custom state held on behalf of the session.

(Unpublished)

m_CreateOperationsInProgress

protected HashMap m_CreateOperationsInProgress

An item of custom state which holds the set of createXXX() opeartions in progress

(Unpublished)

m_FreeOperationsInProgress

protected HashMap m_FreeOperationsInProgress

An item of custom state which holds the set of free() opeartions in progress

(Unpublished)

m_UpdateOperationsInProgress

protected HashMap m_UpdateOperationsInProgress

An item of custom state which holds the set of update() opeartions in progress

(Unpublished)

m_CopyOperationsInProgress

protected HashMap m_CopyOperationsInProgress

An item of custom state which holds the set of copy() opeartions in progress

(Unpublished)

m_ApplicationModeStack

protected Stack m_ApplicationModeStack

A stack of application modes, stored as Integer objects.

(Unpublished)

m_ApplicationMode

protected int m_ApplicationMode

Current application mode.

(Unpublished)

Constructor Detail

LibrarySession

protected LibrarySession(S_LibrarySessionInterface ssess,
                         Credential credential,
                         ConnectOptions options,
                         String serviceName)
                  throws IfsException

Construct a LibrarySession object.

Parameters:

ssess - the S_LibrarySession

credential - the user's credentials

options - connect options

serviceName - the LibraryServiceName

Throws:

IfsException - if operation fails.

(Unpublished)

Method Detail

initialize

protected void initialize()
                   throws IfsException

Initializes connection with CM SDK.

Throws:

IfsException - if operation fails.

(Unpublished)

getServiceName

public String getServiceName()
                      throws IfsException

Gets the name of the CM SDK service to which this session is connected.

Returns:

the service name

Throws:

IfsException - if the operation fails

(Published)

getServiceConfigurationName

public String getServiceConfigurationName()
                                   throws IfsException

Gets the name of the ServiceConfiguration that was used to initialize the CM SDK service to which this session is connected.

Returns:

the ServiceConfiguration name

Throws:

IfsException - if the operation fails

(Published)

getAttributesRsn

public long getAttributesRsn()

Gets the resolution sequence number at which an attribute was last added or removed.

Returns:

the attributes RSN

Throws:

IfsException - if the operation fails

(Unpublished)

getNextSequence

public long getNextSequence()

Gets the next unique sequence with respect to this session.

Used to generate unique values within the context of a single session.

Returns:

the next sequence

Throws:

IfsException - if the operation fails

(Unpublished)

getLocalizer

public final Localizer getLocalizer()
                             throws IfsException

Gets the localizer used by this session.

Specified by:

getLocalizer in interface LibrarySessionInterface

Returns:

the localizer

Throws:

IfsException - if the operation fails

(Published)

getId

public Long getId()
           throws IfsException

Gets the id of this session.

Returns:

the id

Throws:

IfsException - if the operation fails

(Published)

equals

public boolean equals(LibrarySession otherSession)

Compares whether two LibrarySessions are the same by comparing IDs.

Returns:

true if the LibrarySessions have the same Id.

(Published)

getSessionIdentifier

public String getSessionIdentifier()

Gets a session identifier.

Specified by:

getSessionIdentifier in interface LogInfo

Returns:

a String containing the id of the session

(Unpublished)

getApplicationName

public String getApplicationName()
                          throws IfsException

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

(Unpublished)

setApplicationName

public void setApplicationName(String name)
                        throws IfsException

Sets the name of the application that is using this session.

Parameters:

name - the application name.

Throws:

IfsException - if the operation fails

(Unpublished)

getServiceId

public Long getServiceId()
                  throws IfsException

Gets the id of this session's service.

Returns:

the id

Throws:

IfsException - if the operation fails

(Published)

getSessionContext

protected S_LibrarySessionInterface getSessionContext()

Gets the server-side session context.

Returns:

the server-side session context.

Throws:

IfsException - if the operation fails

(Unpublished)

isFullTextIndexingEnabled

public boolean isFullTextIndexingEnabled()
                                  throws IfsException

Gets whether full-text indexing is enabled.

Returns:

whether full-text indexing is enabled

Throws:

IfsException - if the operation fails

(Unpublished)

isGroupMembershipCacheEnabled

public boolean isGroupMembershipCacheEnabled()
                                      throws IfsException

Gets whether the GroupMembershipCache is enabled.

Returns:

true if the GroupMembershipCache is enabled

Throws:

IfsException - if the operation fails

(Unpublished)

getMemberThreshold

public int getMemberThreshold()
                       throws IfsException

Gets the threshold for using a temp table to select all (recursive) members of a group.

Returns:

the threshold for using a temp table to get all members

Throws:

IfsException - if the operation fails

(Published)

getAncestorThreshold

public int getAncestorThreshold()
                         throws IfsException

Gets the threshold for using a temp table to select all (recursive) ancestors of a directory object.

Returns:

the threshold for using a temp table to get all members

Throws:

IfsException - if the operation fails

(Published)

isArrayInputsUsedForMemberSelection

public boolean isArrayInputsUsedForMemberSelection()
                                            throws IfsException

Gets whether to use array inputs for selecting "all members" if size has exceeded threshhold.

Returns:

true if array inputs are to be used; false otherwise

Throws:

IfsException - if the operation fails

(Published)

isArrayInputsUsedForAncestorSelection

public boolean isArrayInputsUsedForAncestorSelection()
                                              throws IfsException

Gets whether to use array inputs for selecting "all ancestors" if size has exceeded threshhold.

Returns:

true if array inputs are to be used; false otherwise

Throws:

IfsException - if the operation fails

(Published)

getTraceLogger

public final TraceLogger getTraceLogger()
                                 throws IfsException

Gets the trace logger used by this session.

Specified by:

getTraceLogger in interface Traceable

Returns:

the trace logger

Throws:

IfsException - if the operation fails

(Published)

setSessionTraceLoggerLevels

public final void setSessionTraceLoggerLevels(int[] levels)
                                       throws IfsException

Sets the trace levels of the S_LibrarySessionTraceLogger.

Parameters:

levels - an array of levels. The array index corresponds to the channel number.

Throws:

IfsException -
11204: if the size of the array does not equal the number of channels
11200: if a level is invalid

(Unpublished)

getSessionTraceLoggerLevels

public final int[] getSessionTraceLoggerLevels()
                                        throws IfsException

Gets the trace levels of the S_LibrarySessionTraceLogger.

Returns:

an array of levels. The array index corresponds to the channel number.

Throws:

IfsException - if the operation fails

(Unpublished)

setServiceTraceLoggerLevels

public final void setServiceTraceLoggerLevels(int[] levels)
                                       throws IfsException

Sets the trace levels of the S_LibraryServiceTraceLogger.

Parameters:

levels - an array of levels. The array index corresponds to the channel number.

Throws:

IfsException - (IFS-11204) if the size of the array does not equal the number of channels

IfsException - (IFS-11200) if a level is invalid

IfsException - (IFS-FIXME) if not in administration mode

(Unpublished)

getServiceTraceLoggerLevels

public final int[] getServiceTraceLoggerLevels()
                                        throws IfsException

Gets the trace levels of the S_LibraryServiceTraceLogger.

Returns:

an array of levels. The array index corresponds to the channel number.

Throws:

IfsException - if the operation fails

(Unpublished)

getLibraryObjectCachePerformance

public final CachePerformance getLibraryObjectCachePerformance()

Gets the cache performance object for the LibraryObject cache.

Returns:

the cache performance object

(Unpublished)

getBeanLibraryObjectDataCachePerformance

public final CachePerformance getBeanLibraryObjectDataCachePerformance()

Gets the cache performance object for the bean LibraryObjectData cache.

Returns:

the cache performance object

(Unpublished)

disconnectBestEffort

public void disconnectBestEffort()

Disconnects the session, effectively disposing the instance.

Throws:

IfsException - if operation fails.

(Published)

disconnect

public boolean disconnect()
                   throws IfsException

Disconnects the session, effectively disposing the instance.

Returns:

status of the disconnect operation (always true)

Throws:

IfsException - if operation fails.

(Published)

createSession

public LibrarySession createSession(DirectoryUser user)
                             throws IfsException

Create a new session for the specified user.

Current session must be in admin mode if the user specified is not the current user or the "guest" user.

Parameters:

user - the user for which to make a new session

Returns:

the new session context for the specified user

Throws:

IfsException - if the operation fails

(Unpublished)

createSession

public LibrarySession createSession(DirectoryUser user,
                                    ConnectOptions options)
                             throws IfsException

Create a new session for the specified user.

Current session must be in admin mode if the user specified is not the current user or the "guest" user.

Parameters:

user - the user for which to make a new session

options - the connection options

Returns:

the new session context for the specified user

Throws:

IfsException - if the operation fails

(Unpublished)

createCredential

public Credential createCredential(LibraryService service,
                                   DirectoryUser user)
                            throws IfsException

Return a credential that can be used to create a new session for the specified user.

Current session must be in admin mode if the user specified is not the current user or the "guest" user.

Parameters:

service - the current session's service

user - the user for which to make a new session

Returns:

a credential that can be used to create a new session context for the specified user

Throws:

IfsException - if the operation fails

(Unpublished)

createCredential

public Credential createCredential(DirectoryUser user)
                            throws IfsException

Return a credential that can be used to create a new session for the specified user, using the current session's service.

Current session must be in admin mode if the user specified is not the current user or the "guest" user.

Parameters:

user - the user for which to make a new session

Returns:

a credential that can be used to create a new session context for the specified user

Throws:

IfsException - if the operation fails

(Unpublished)

createSession

public LibrarySession createSession()
                             throws IfsException

Create a new session based on the user of the current session.

Returns:

the new session context for the current user

Throws:

IfsException - if the operation fails

(Unpublished)

createGuestSession

public LibrarySession createGuestSession()
                                  throws IfsException

Create a new session based on the "guest" user.

Returns:

the new session context for the "guest" user

Throws:

IfsException - if the operation fails

(Unpublished)

createGuestSession

public LibrarySession createGuestSession(ConnectOptions options)
                                  throws IfsException

Create a new session based on the "guest" user.

Parameters:

options - the connection options

Returns:

the new session context for the "guest" user

Throws:

IfsException - if the operation fails

(Unpublished)

createGuestCredential

public Credential createGuestCredential()
                                 throws IfsException

Create a new credential based on the "guest" user.

Returns:

Credential for the "guest" user

Throws:

IfsException - if the operation fails

(Unpublished)

getSystemUserToken

public Object getSystemUserToken()
                          throws IfsException

Gets the system token that can be used to efficiently clone system sessions.

Returns:

the system user token

Throws:

IfsException - if the operation fails

(Unpublished)

cloneSession

protected LibrarySession cloneSession()
                               throws IfsException

Clone a new session based on the user of the current session.

Returns:

the newly cloned session

Throws:

IfsException - if the operation fails

(Unpublished)

reserveClonedSession

public LibrarySession reserveClonedSession()
                                    throws IfsException

Reserves a cloned session.

Returns:

the reserved cloned session

Throws:

IfsException - if the operation fails

(Published)

unreserveClonedSession

public void unreserveClonedSession(LibrarySession sess)

Unreserves a cloned session.

Parameters:

sess - the previously reserved cloned session to unreserve

(Published)

createClonedSession

public void createClonedSession()
                         throws IfsException

Creates a cloned session without reserving it, which will increase the number of pooled cloned sessions.

Throws:

IfsException - if the operation fails

(Published)

isClonedLibrarySession

public boolean isClonedLibrarySession()

Gets indication as to whether this session is a cloned session.

Returns:

true if the session is cloned; false otherwise

(Published)

getClonedLibrarySessionInfo

public ClonedLibrarySessionInfo getClonedLibrarySessionInfo()

Gets the ClonedLibrarySessionInfo for this session.

Returns null if this is not a cloned session.

Returns:

the ClonedLibrarySessionInfo for this session

(Published)

getUser

public DirectoryUser getUser()
                      throws IfsException

Return the user associated with the current session. If this session is impersonating a user that is not the same user who authenticated, this method returns the impersonating user.

Returns:

the current user

Throws:

IfsException - if operation fails.

(Published)

getUserId

public Long getUserId()
               throws IfsException

Gets the id of the current user.

Returns:

the id

Throws:

IfsException - if the operation fails

(Unpublished)

getUserIdentifier

public String getUserIdentifier()

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

(Unpublished)

getDirectoryUser

public DirectoryUser getDirectoryUser()
                               throws IfsException

Return the user associated with the current session. If this session is impersonating a user that is not the same user who authenticated, this method returns the impersonating user.

Returns:

the current user

Throws:

IfsException - if operation fails.

(Unpublished)

getPrimaryUserProfile

public PrimaryUserProfile getPrimaryUserProfile()
                                         throws IfsException

Return the current user's primary UserProfile. If this session is impersonating a user that is not the same user who authenticated, this method returns the impersonating user's primary UserProfile.

Returns:

the current user's primary UserProfile.

Throws:

IfsException - if operation fails.

(Unpublished)

getCurrentActor

public Actor getCurrentActor()
                      throws IfsException

Gets the current Actor in effect for this session.

Normally, this is the Actor designation of the currently connected user, or feigned user if a user impersonation is in effect. Additionally, a system or application element can establish a different Actor for a session, via setCurrentActor.

Returns:

the current Actor in effect for this session

Throws:

IfsException - if operation fails.

(Published)

setCurrentActor

public void setCurrentActor(Actor actor)
                     throws IfsException

Sets the current Actor in effect for this session.

This will override any previous setting for the current Actor, either implicit or explicit. If a null value is specified, the current Actor will revert back to the Actor designation of the DirectoryUser in effect for this session.

Parameters:

actor - the current Actor to be in effect for this session

Throws:

IfsException - if operation fails.

(Published)

getPrimaryUserProfile

public PrimaryUserProfile getPrimaryUserProfile(DirectoryUser user)
                                         throws IfsException

Return the a specified user's primary UserProfile.

Parameters:

user - the specified user.

Returns:

the specified user's primary UserProfile.

Throws:

IfsException - if operation fails.

(Unpublished)

getVersionString

public final String getVersionString()
                              throws IfsException

Returns the version String for the CM SDK bean-side software. For example, version 1.0.8.3.2 would be returned as the string "1.0.8.3.2".

This value is potentially different from the other two version Strings for the server-side software and the CM SDK schema.

Returns:

the bean-side software version String.

Throws:

IfsException

(Published)

getVersionNumber

public final long getVersionNumber()
                            throws IfsException

Returns the CM SDK bean-side software version number, as a long value. Each digit in the version string is represented by two digits in the long value. For example, version 1.0.8.4.18 would be returned as the long value 0100080418L.

This value is potentially different from the other two version Strings for the server-side software and the CM SDK schema.

Returns:

the bean-side software version number.

Throws:

IfsException

(Published)

getServerVersionNumber

public long getServerVersionNumber()
                            throws IfsException

Returns the CM SDK server-side version number, as a long value. Each digit in the version string is represented by two digits in the long value. For example, version 1.0.8.4.18 would be returned as the long value 0100080418L.

This value is potentially different from the other two version Strings for the bean-side software and the CM SDK schema.

Returns:

the server-side software version number.

Throws:

IfsException - if operation fails.

(Published)

getServerVersionString

public String getServerVersionString()
                              throws IfsException

Returns the version String for the CM SDK server-side software. For example, version 1.0.8.3.2 would be returned as the string "1.0.8.3.2".

This value is potentially different from the other two version Strings for the bean-side software and the CM SDK schema.

Returns:

the server-side software version String.

Throws:

IfsException - if operation fails.

(Published)

getSchemaVersionString

public String getSchemaVersionString()
                              throws IfsException

Returns the version String for the CM SDK schema on which this session is connected. For example, version 1.0.8.3.2 would be returned as the string "1.0.8.3.2".

This value is potentially different from the other two version Strings for the bean-side software and the server-side software.

Returns:

the schema version string

Throws:

IfsException - (IFS-20001) if the operation fails

(Published)

getSchemaVersionNumber

public long getSchemaVersionNumber()
                            throws IfsException

Returns the version number for the CM SDK schema on which this session is connected. Each digit in the version string is represented by two digits in the long value. For example, version 1.0.8.4.18 would be returned as the long value 0100080418L.

This value is potentially different from the other two version Strings for the bean-side software and the server-side software.

Returns:

the schema version number.

Throws:

IfsException - (IFS-20001) if the operation fails

(Published)

getDatabaseCharacterSet

public String getDatabaseCharacterSet()
                               throws IfsException

Returns the Iana character set of the database.

Returns:

the character set

Throws:

IfsException - if the operation fails

(Unpublished)

emptyWastebasket

public void emptyWastebasket()
                      throws IfsException

Empty the wastebasket. This frees all object's deleted by the current user.

Throws:

IfsException - if operation fails.

(Unpublished)

isFilterDeletedObjectsEnabled

public boolean isFilterDeletedObjectsEnabled()

Return indication as to whether this session has deleted object filtering enabled. By default, a session filters deleted objects from searches, selectors, folder operations, etc. This can be overridden by setFilterDeletedObjectsEnabled(false) .

Returns:

whether this LibrarySession has deleted object filtering enabled.

(Unpublished)

setFilterDeletedObjectsEnabled

public void setFilterDeletedObjectsEnabled(boolean mode)
                                    throws IfsException

Set deleted object filtering state for this session.

Parameters:

mode - new state of FilterDeletedObjectsEnabled.

Throws:

IfsException - if operation fails.

(Unpublished)

getDefaultFolderRelationshipClassname

public String getDefaultFolderRelationshipClassname()
                                             throws IfsException

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

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)

setDefaultFolderRelationshipClassName

public void setDefaultFolderRelationshipClassName(String classname)
                                           throws IfsException

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

Sets the default class name that is used for folder relationships. There is no longer a need for this option, and it is now deprecated.

Parameters:

classname - name of the default Relationship class to be used in Folder selection operations.

Throws:

IfsException - if operation fails.

(Published)

getDefaultFolderSortSpecification

public SortSpecification getDefaultFolderSortSpecification()
                                                    throws IfsException

get the default SortSpecification that is used by default for all Folder selection operations. Returns null if no default has been set.

Returns:

default SortSpecification used for Folder select operations.

Throws:

IfsException - if operation fails.

(Published)

getObjectFolderSortSpecification

protected SortSpecification getObjectFolderSortSpecification(PublicObject po)
                                                      throws IfsException

get the SortSpecification for a particular object. This will return the SortSpecification that was specified explicitly for an object, or return the session's default SortSpecification otherwise.

Returns:

SortSpecification to be used for Folder select operations.

Throws:

IfsException - if operation fails.

(Unpublished)

getFolderSortSpecification

protected SortSpecification getFolderSortSpecification(PublicObject po)
                                                throws IfsException

get the SortSpecification for a particular object. This will return the SortSpecification that was specified explicitly for an object, or return the session's default SortSpecification otherwise.

Returns:

SortSpecification to be used for Folder select operations.

Throws:

IfsException - if operation fails.

(Unpublished)

setDefaultFolderSortSpecification

public void setDefaultFolderSortSpecification(SortSpecification sort)
                                       throws IfsException

Sets the default SortSpecification that is used by default for all Folder selection operations.

Parameters:

sort - default SortSpecification used for Folder select operations.

Throws:

IfsException - if operation fails.

(Published)

setObjectFolderSortSpecification

protected void setObjectFolderSortSpecification(PublicObject po,
                                                SortSpecification sort)
                                         throws IfsException

Sets an object-level SortSpecification that is to be used for all Folder selection operations for a particular object.

Parameters:

po - object for which the SortSpecification applies

sort - SortSpecification to be used for Folder select operations.

Throws:

IfsException - if operation fails.

(Unpublished)

setFolderPathDelimiter

public void setFolderPathDelimiter(String delim)
                            throws IfsException

Sets the current session's Folder path delimiter. By default, this is set to "/".

Parameters:

delim - the delimiter

Throws:

IfsException - if delim is illeagal

(Published)

getFolderPathDelimiter

public String getFolderPathDelimiter()
                              throws IfsException

Gets the current session's folder path delimiter. The value will be "/" unless changed by a call to setFolderPathDelimiter.

Returns:

the delimiter

Throws:

IfsException - if the operation fails

(Published)

getConfigurationCategoryDescriptor

public ConfigurationCategoryDescriptor getConfigurationCategoryDescriptor(String className)
                                                                   throws IfsException

Gets the ConfigurationCategoryDescriptor for the specified ConfigurationCategory class name.

Parameters:

className - the ConfigurationCategory class name.

Returns:

the ConfigurationCategoryDescriptor

Throws:

IfsException - if the operation fails

(Published)

setPreventSessionTimeouts

public void setPreventSessionTimeouts(boolean value)
                               throws IfsException

Sets whether the current session should prevent any session or operation timeouts. If a value of true is specified, no operations will time out except ones that have an explicit timeout mechanism (for example, Searches).

Parameters:

value - true indicates that session timeouts are disabled; false indicates that session timeouts are enabled

Throws:

IfsException - if delim is illeagal

(Published)

isPreventSessionTimeouts

public boolean isPreventSessionTimeouts()
                                 throws IfsException

Gets whether the current session prevents any session or operation timeouts.

Returns:

true indicates that session timeout's are disabled; false indicates that session timeouts are enabled

Throws:

IfsException - if the operation fails

(Unpublished)

getGlobalOperationActionSpecifications

public OperationActionSpecification[] getGlobalOperationActionSpecifications()
                                                                      throws IfsException

Gets the "global" OperationActionSpecifications.

Returns:

the global OperationActionSpecifications

Throws:

IfsException - if operation fails

(Published)

isFolderItemCachingEnabled

public boolean isFolderItemCachingEnabled()
                                   throws IfsException

Gets whether the server supports folder item caching.

Returns:

true if folder item caching is enabled

Throws:

IfsException - if the operation fails

(Unpublished)

isDefinitionCloningRequired

public boolean isDefinitionCloningRequired()
                                    throws IfsException

Gets whether the current session requires user-specified instances of LibraryObjectDefinition (or one of its subclasses) to be cloned prior to using it server-side. This is a compatibility mode option; to be compatible with 9.0.4 and earlier versions of the CM SDK, this option should be set to true. The value of this option is stored as a domain property, "IFS.DOMAIN.DefinitionCloningRequired". It can be overridden for a particular session using the setDefinitionCloningRequired() method.

Returns:

true indicates that definition cloning is required; false indicates that definition cloning is required

Throws:

IfsException - if the operation fails

(Unpublished)

setDefinitionCloningRequired

public void setDefinitionCloningRequired(boolean option)
                                  throws IfsException

Sets whether the current session requires user-specified instances of LibraryObjectDefinition (or one of its subclasses) to be cloned prior to using it server-side. This is a compatibility mode option; to be compatible with 9.0.4 and earlier versions of the CM SDK, this option should be set to true. This will override the default value for the session, stored as a domain property, "IFS.DOMAIN.DefinitionCloningRequired".

Parameters:

option - true indicates that definition cloning is required; false indicates that definition cloning is required

Throws:

IfsException - if the operation fails

(Unpublished)

setDefaultContentQuota

public void setDefaultContentQuota(ContentQuota quota)
                            throws IfsException

Sets the session's default ContentQuota. This ContentQuota object will be used for every Document that this session creates. If the specified value is null, then the user's ContentQuota object will be used by default.

Parameters:

quota - the quota object to use by default

Throws:

IfsException - if the current user cannot use the specified quota

(Published)

getDefaultContentQuota

public ContentQuota getDefaultContentQuota()
                                    throws IfsException

Gets the session's default ContentQuota, set via setDefaultContentQuota().

Returns:

the quota object being used by the session, or null if the user's quota is being used.

Throws:

IfsException - if the operation fails

(Published)

setUpgradeInProgress

public void setUpgradeInProgress(boolean value)
                          throws IfsException

Sets indication of whether the session behaves as though an upgrade is in progress.

Overrides the default behavior as indicated by a domain property. See isUpgradeInProgress for a description of the semantics of the session with this indication set to true.

Parameters:

value - true if session behaves as though an upgrade is in progress

Throws:

IfsException

isUpgradeInProgress

public boolean isUpgradeInProgress()
                            throws IfsException

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

clearSharedCaches

public void clearSharedCaches()
                       throws IfsException

Inform service to clear its shared caches.

Throws:

IfsException - if operation fails

setAlwaysCacheSelectedData

public void setAlwaysCacheSelectedData(boolean value)
                                throws IfsException

Sets whether the current session always caches selected data from Selectors.

Parameters:

value - true if session should always cache selected data; false otherwise

Throws:

IfsException - if the operation fails

(Published)

isAlwaysCacheSelectedData

public boolean isAlwaysCacheSelectedData()
                                  throws IfsException

Gets whether the current session always caches selected data from Selectors.

Returns:

true if session will always cache selected data; false otherwise

Throws:

IfsException - if the operation fails

(Published)

isExecutionMode

public boolean isExecutionMode(int mode)
                        throws IfsException

Checks whether current session is in at least the execution mode specified.

Parameters:

mode - the execution mode being checked

Returns:

true if the session is in at least the execution mode specified

Throws:

IfsException - if the operation fails

(Published)

setExecutionMode

public void setExecutionMode(int mode)
                      throws IfsException

Set the execution mode for this LibrarySession.

Parameters:

mode - new execution mode

Throws:

IfsException - if operation fails.

(Unpublished)

pushTemporaryExecutionMode

public void pushTemporaryExecutionMode(int mode)

Establishes a temporary execution mode for the session.

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

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

Parameters:

mode - new temporary execution mode

(Unpublished)

popTemporaryExecutionMode

public void popTemporaryExecutionMode()

Resets any temporary execution state back to the previous temporary execution mode.

(Unpublished)

isAdministrationDiscoverMode

public boolean isAdministrationDiscoverMode()
                                     throws IfsException

Gets whether this LibrarySession is in discover administration mode.

Returns:

whether in discover administration mode

Throws:

IfsException - if the operation fails

(Published)

isAdministrationMode

public boolean isAdministrationMode()

Gets whether this LibrarySession is in administration mode.

Returns:

whether in administration mode

Throws:

IfsException - if the operation fails

(Published)

isSystemAdministrationMode

public boolean isSystemAdministrationMode()
                                   throws IfsException

Gets whether this LibrarySession is in system administration mode.

Returns:

whether in system administration mode

Throws:

IfsException - if the operation fails

(Published)

isInstallationMode

public boolean isInstallationMode()
                           throws IfsException

Gets whether this LibrarySession is in installation mode.

Returns:

whether in installation mode

Throws:

IfsException - if the operation fails

(Published)

setAdministrationMode

public void setAdministrationMode(boolean mode)
                           throws IfsException

Set the administrator mode state for this session. The semantics of a LibrarySession in admin mode are very different from a session that is not in admin mode.

This list describes what a user in administration mode can do.

1. Create, update, free any SchemaObject. Updates include any mutation such as adding an Attribute to a ClassObject.

2. Directly create, update, or free any SystemObject; ordinary sessions can perform some of these operations on some subclasses of SystemObject provided that they are executed in the context of some other PublicObject (e.g. adding a Relationship to a PublicObject)

3. Create, free, update any DirectoryUser object

4. Create, free, or modify any SystemAccessControlList

5. Create, free, or modify any ClassAccessControlList

6. Create, free, or modify any ContentQuota

7. Free a PublicObject that has an ExtendedPreFreePolicy of ExtendedPreFreePolicyRequireAdmin or ExtendedPreFreePolicyIgnoreOwnership (e.g. to free your own home folder)

8. Impersonate another user

9. Change the password of another user

10. Delete users from the "credential manager" store

11. Bypass "required attribute" check in creating or updating any CMSDK object.

12. Embed SQL syntax referencing CMSDK tables/views in any Selector or Search

13. Unreserve any PublicObject checked out by another user

14. Use any defined ContentQuota

15. Declare to use no ContentQuota even if one is assigned to that user

16. Set the ContentQuota attribute on DirectoryGroup

17. Set the ContentQuota attribute on PrimaryUserProfile

18. Bypass the name.owner uniqueness policy for DirectoryGroup and AccessControlList

19. Directly get or set the content from a ContentObject without providing a Document context

20. Force re-creation of CMSDK views

21. Promote a Folder in the Folder index

22. Move content from LOB to BFILE

Parameters:

mode - new state of administrator mode; true to enable administration mode

Throws:

IfsException - if operation fails.

(Published)

setSystemAdministrationMode

public void setSystemAdministrationMode(boolean mode)
                                 throws IfsException

Set the System admin Mode state for this LibrarySession.

Parameters:

mode - new state of Installation mode

Throws:

IfsException - if operation fails.

(Unpublished)

setInstallationMode

public void setInstallationMode(boolean mode)
                         throws IfsException

Set the Installation Mode state for this LibrarySession.

Parameters:

mode - new state of Installation mode

Throws:

IfsException - if operation fails.

(Unpublished)

pushTemporaryAccessCheckMode

public void pushTemporaryAccessCheckMode(boolean mode)

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)

(Unpublished)

popTemporaryAccessCheckMode

public void popTemporaryAccessCheckMode()

Resets any temporary access check mode back to the previous temporary access check mode.

(Unpublished)

pushApplicationMode

public void pushApplicationMode(int mode)

Establishes a new temporary Application mode for the session.

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

The mode specified will be logically ORed with the previous mode to establish the new mode. It is up to the application to manage the semantics of the varous mode settings.

Parameters:

mode - new application mode settings; current mode will be the previous mode logically ORed with this setting.

(Unpublished)

popApplicationMode

public void popApplicationMode()

Resets any temporary application mode back to the previous temporary application mode setting.

(Unpublished)

getApplicationMode

public final int getApplicationMode()

Gets the application mode for the session.

Normally this returns 0, but can be overridden temporarily via pushApplicationMode

Returns:

the application mode

Throws:

IfsException - if the operation fails

(Unpublished)

reauthenticate

public boolean reauthenticate(Credential credential,
                              ConnectOptions options)
                       throws IfsException

Reauthenticates the DIRECTORYUSER for which this LibrarySession was originally created (as opposed to the DIRECTORYUSER specified by a subsequent call to impersonateUser).

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

invalidateTokenCredentials

public void invalidateTokenCredentials(DirectoryUser user)
                                throws IfsException

Invalidates all the token credentials for the given user. If the current session user does not match the passed in user, then the current session has to be in admin mode to perform this operation succesfully.

Parameters:

user - user whose all token credentials need to be invalidated

Throws:

IfsException - if the operation fails

(Published)

impersonateUser

public void impersonateUser(DirectoryUser newuser)
                     throws IfsException

Assume the identity of another user. New objects created will be owned by this impersonated user. This operation requires that the authenticated user has the ability to enable administration mode, but will also work if the user is currently in not in administration mode. In this case, the impersonation will also not be in administration mode. Also note that since admin mode is required for this operation, admin mode can be enabled while impersonating the new user (who may not normally have admin privileges).

Parameters:

newuser - new User to impersonate, or null to cancel a previous impersonation.

Throws:

IfsException - if operation fails.

(Published)

getName

public String getName()
               throws IfsException

Gets the name of the session. If connected, this string is returned as username@servicename.

Returns:

the session name.

Throws:

IfsException - if the operation fails.

(Unpublished)

getRootFolder

public Folder getRootFolder()
                     throws IfsException

Return the top-most Folder in the CM SDK folder hierarchy.

Returns:

the top-most root folder

Throws:

IfsException - if operation fails.

(Published)

getDefaultContentMedia

public Media getDefaultContentMedia()
                             throws IfsException

Get the default content Media instance.

Returns:

the default Media instance.

Throws:

IfsException - if operation fails.

(Unpublished)

getNonContentMedia

public Media getNonContentMedia()
                         throws IfsException

Get the non content Media instance.

Returns:

the default Media instance.

Throws:

IfsException - if operation fails.

(Unpublished)

lookupInverseInstanceLabel

public String lookupInverseInstanceLabel(String classname,
                                         String label)
                                  throws IfsException

Gets the name of an uniquely-named instance by its label. Return null if no inverse Label is specified in the ResourceBundle or extended ResourceBundles.

Parameters:

classname - The class name of the requested instance

label - The label

Returns:

the name registered as an inverse to the specified label

Throws:

IfsException - if operation fails.

(Published)

newContentStreamSerializer

public ContentStreamSerializer newContentStreamSerializer()
                                                   throws IfsException

Return the Content stream serializer.

Returns:

the Content stream serializer.

Throws:

IfsException - if operation fails.

(Unpublished)

getClassObjectCollection

public final Collection getClassObjectCollection()
                                          throws IfsException

Gets a reference to the ClassObject collection.

Specified by:

getClassObjectCollection in interface LibrarySessionInterface

Returns:

the CachedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getClassDomainCollection

public final Collection getClassDomainCollection()
                                          throws IfsException

Gets a reference to the 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

Gets a reference to the ValueDefault collection.

Specified by:

getValueDefaultCollection in interface LibrarySessionInterface

Returns:

the UncachedPreparedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getValueDomainCollection

public final Collection getValueDomainCollection()
                                          throws IfsException

Gets a reference to the ValueDomain collection.

Specified by:

getValueDomainCollection in interface LibrarySessionInterface

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getExtendedUserProfileCollection

public final Collection getExtendedUserProfileCollection()
                                                  throws IfsException

Gets a reference to the ExtendedUserProfile collection.

Specified by:

getExtendedUserProfileCollection in interface LibrarySessionInterface

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getFormatCollection

public final Collection getFormatCollection()
                                     throws IfsException

Gets a reference to the Format (by name) collection.

Specified by:

getFormatCollection in interface LibrarySessionInterface

Returns:

the Format Collection

Throws:

IfsException - if the operation fails

(Published)

getFormatExtensionCollection

public final Collection getFormatExtensionCollection()
                                              throws IfsException

Gets a reference to the FormatExtension collection.

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

Specified by:

getFormatExtensionCollection in interface LibrarySessionInterface

Returns:

the Collection, keyed by EXTENSION

Throws:

IfsException - if the operation fails

(Published)

getMediaCollection

public final Collection getMediaCollection()
                                    throws IfsException

Gets a reference to the Media collection.

Specified by:

getMediaCollection in interface LibrarySessionInterface

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Unpublished)

getSharedAccessControlListCollection

public final Collection getSharedAccessControlListCollection()
                                                      throws IfsException

Gets a reference to the SharedAccessControlList collection.

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getSystemAccessControlListCollection

public final Collection getSystemAccessControlListCollection()
                                                      throws IfsException

Gets a reference to the SystemAccessControlList collection.

Specified by:

getSystemAccessControlListCollection in interface LibrarySessionInterface

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getClassAccessControlListCollection

public final Collection getClassAccessControlListCollection()
                                                     throws IfsException

Gets a reference to the ClassAccessControlList collection.

Specified by:

getClassAccessControlListCollection in interface LibrarySessionInterface

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getSystemLockObjectCollection

public final Collection getSystemLockObjectCollection()
                                               throws IfsException

Gets a reference to the SystemLockObject collection.

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getDirectoryUserCollection

public final Collection getDirectoryUserCollection()
                                            throws IfsException

Gets a reference to the DirectoryUser collection.

Specified by:

getDirectoryUserCollection in interface LibrarySessionInterface

Returns:

the UncachedPreparedSelectorCollection

Throws:

IfsException - if the operation fails

(Published)

getExtendedPermissionCollection

public final Collection getExtendedPermissionCollection()
                                                 throws IfsException

Gets a reference to the ExtendedPermission collection.

Specified by:

getExtendedPermissionCollection in interface LibrarySessionInterface

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getPermissionBundleCollection

public final Collection getPermissionBundleCollection()
                                               throws IfsException

Gets a reference to the PermissionBundle collection.

Specified by:

getPermissionBundleCollection in interface LibrarySessionInterface

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getPolicyCollection

public final Collection getPolicyCollection()
                                     throws IfsException

Gets a reference to the 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

Gets a reference to the PolicyList collection.

Returns:

the Collection

Throws:

IfsException - if the operation fails

(Published)

getDomainPropertyValue

public final AttributeValue getDomainPropertyValue(String name)
                                            throws IfsException

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 PropertyBundle getDomainPropertyBundle()
                                             throws IfsException

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

(Unpublished)

putSessionState

public Object putSessionState(String key,
                              Object value)
                       throws IfsException

Add a session state item.

This behaves like a Hashtable, replacing any state that exists for the specified key and returning the state that was previously defined for that key.

Parameters:

key - the identifer that uniquely identifies an item of session state

value - the value for the state

Returns:

the previous value for the specified state, or null if no previous value was defined

Throws:

IfsException - if operation fails.

(Published)

getSessionState

public Object getSessionState(String key)
                       throws IfsException

Get a session state item.

Parameters:

key - the identifer that uniquely identifies an item of session state

Returns:

the value for the state, or null if the state is not defnied

Throws:

IfsException - if operation fails.

(Published)

removeSessionState

public Object removeSessionState(String key)
                          throws IfsException

Remove a session state item.

This behaves like a Hashtable, returning any state that was previously defined for that key.

Parameters:

key - the identifer that uniquely identifies an item of session state

Returns:

the previous value for the specified state, or null if no previous value was defined

Throws:

IfsException - if operation fails.

(Published)

establishSessionState

public Hashtable establishSessionState(Hashtable stateMap)

Establish session state for the session.

The map specified should be the equivalent to the map obtained by captureSessionState. It is used in cases where an application is pooling sessions for various purposes on behalf of a single user, and the sessions have varying session state.

Parameters:

stateMap - the session state map

Returns:

the previous session state map

(Unpublished)

captureSessionState

public Hashtable captureSessionState()

Capture the current session state for the session.

This is used in cases where an application needs to hold the session state so that it can be established on a different session in the future, useful when the the application is pooling sessions for various purposes on behalf of a single user, and the sessions have varying session state.

Returns:

the current session state map

(Unpublished)

getSharedStateFactory

protected S_LibraryObjectDataSharedStateFactory getSharedStateFactory()

Returns the Shared State factory in effect for the session.

Returns:

the Shared State factory

(Published)

createPublicObject

public PublicObject createPublicObject(PublicObjectDefinition def)
                                throws IfsException

Create a new public object.

Parameters:

def - the definition for the new PublicObject

Returns:

the newly created PublicObject.

Throws:

IfsException - if operation fails.

(Published)

createSchemaObject

public SchemaObject createSchemaObject(SchemaObjectDefinition def)
                                throws IfsException

Create a new schema object.

Parameters:

def - the definition for the new SchemaObject

Returns:

the newly created SchemaObject.

Throws:

IfsException - if operation fails.

(Published)

createSystemObject

public SystemObject createSystemObject(SystemObjectDefinition def)
                                throws IfsException

Create a new system object.

Parameters:

def - the definition for the new SystemObject

Returns:

the newly created SystemObject.

Throws:

IfsException - if operation fails.

(Published)

createSimpleObject

public SimpleObject createSimpleObject(SimpleObjectDefinition def)
                                throws IfsException

Create a new simple object.

Parameters:

def - the definition for the new SimpleObject

Returns:

the newly created SimpleObject.

Throws:

IfsException - if operation fails.

(Published)

getIdsForNewObjects

public Long[] getIdsForNewObjects(int length)
                           throws IfsException

Return a set of Ids that can be used to import a set of objects.

Parameters:

length - The number of Ids desired.

Returns:

the set of IDs

Throws:

IfsException - if operation fails.

(Unpublished)

getIdForNewObject

public Long getIdForNewObject()
                       throws IfsException

Return an Id that can be used to create a new LibraryObject.

Returns:

the ID

Throws:

IfsException - if operation fails.

(Unpublished)

getSchemaName

public String getSchemaName()
                     throws IfsException

Gets the schema name in effect for the service.

Returns:

the schema name

Throws:

IfsException - if the operation fails

(Unpublished)

getClockOffset

public Long getClockOffset()
                    throws IfsException

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

(Unpublished)

getCurrentTimeMillis

public long getCurrentTimeMillis()
                          throws IfsException

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

(Unpublished)

getCurrentDate

public Date getCurrentDate()
                    throws IfsException

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

(Unpublished)

getCurrentAuditDomainContext

public Folder getCurrentAuditDomainContext()
                                    throws IfsException

Gets the current "Audit Domain" context for the session's user.

Delegates to the current user, so that applications can override within the Tie class for DirectoryUser.

Returns:

the current audit domain context

Throws:

IfsException - if the operation fails

getCurrentOrDefaultAuditDomainContext

public Folder getCurrentOrDefaultAuditDomainContext()
                                             throws IfsException

Gets the current or default "Audit Domain" context for the session's user.

Delegates to the current user, so that applications can override within the Tie class for DirectoryUser.

Returns:

the current or default audit domain context

Throws:

IfsException - if the operation fails

setCurrentAuditDomainContext

public void setCurrentAuditDomainContext(Folder domain)
                                  throws IfsException

Sets the current "Audit Domain" context.

Parameters:

domain - the new current Domain; if null, the default domain will be used by this session as the current domain

Throws:

IfsException - if the operation fails

postAuditEvent

public void postAuditEvent(AuditEvent event)
                    throws IfsException

Create a new audit event.

Post the event using AuditEvent.POST_NORMALLY mode.

Parameters:

event - the event to post

Throws:

IfsException - if the operation fails

postAuditEvent

public void postAuditEvent(LibraryObject target,
                           AuditEvent event)
                    throws IfsException

Create a new audit event.

Post the event using AuditEvent.POST_NORMALLY mode.

Parameters:

target - the target of the event

event - the event to post

Throws:

IfsException - if the operation fails

postAuditEvent

public void postAuditEvent(AuditEvent event,
                           int mode)
                    throws IfsException

Create a new audit event.

Parameters:

event - the event to post

mode - the success/fail mode for the post

Throws:

IfsException - if the operation fails

postAuditEvent

public void postAuditEvent(LibraryObject target,
                           AuditEvent event,
                           int mode)
                    throws IfsException

Create a new audit event.

Parameters:

event - the event to post

target - the target of the event

mode - the success/fail mode for the post

Throws:

IfsException - if the operation fails

postCustomAuditEvent

public void postCustomAuditEvent(AuditEvent event)
                          throws IfsException

Create a new custom audit event.

Delegates to postAuditEvent after verifying that the type being posted is a custom type

Parameters:

event - the event to post

Throws:

IfsException - if the operation fails

postCustomAuditEvent

public void postCustomAuditEvent(LibraryObject target,
                                 AuditEvent event)
                          throws IfsException

Create a new custom audit event.

Delegates to postAuditEvent after verifying that the type being posted is a custom type

Parameters:

target - the target of the event

event - the event to post

Throws:

IfsException - if the operation fails

selectRawAuditEvents

public RawAuditEvent[] selectRawAuditEvents(String filterClause,
                                            int maxItems)
                                     throws IfsException

Select raw audit events.

Should only be performed as part of event dispatching.

Parameters:

filterClause - the filter criteria (where clause); use null for standard (efficient) event processing

maxItems - max number of items to select

Returns:

the selected raw audit events

Throws:

IfsException - if the operation fails

removeRawAuditEvents

public void removeRawAuditEvents(RawAuditEvent[] rawEvents)
                          throws IfsException

Free raw audit events.

Parameters:

rawEvents - the raw events to be freed.

Throws:

IfsException - if the operation fails

handleAuditEventDispatchRequests

public void handleAuditEventDispatchRequests(ArrayList reqList,
                                             String tableName)
                                      throws IfsException

Handle a list of AuditEvent dispatch requests.

Parameters:

reqList - a list of AuditEventDispatchRequest

tableName - the table name where the events are to be stored

Throws:

IfsException - if the operation fails

directlyDispatchAuditEvent

public Long directlyDispatchAuditEvent(AuditEvent event,
                                       Long specId)
                                throws IfsException

Directly dispatch an AuditEvent to the specified Event History.

Parameters:

event - the event to post

specId - the AuditSpecification (event history) ID

Returns:

the event ID used for the newly dispatched event

Throws:

IfsException - if the operation fails

selectAuditEvents

public AuditEvent[] selectAuditEvents(Long auditSpec,
                                      String filterClause,
                                      String sortClause,
                                      int maxItems)
                               throws IfsException

Select audit events.

The filter clause is the where clause (exclusing the "where" prefix) that is used in selecting against the audit table. The sort clause is the order by clause (excluding the "order by" prefix) used in the query against the audit table.

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 select

Returns:

the selected audit events

Throws:

IfsException - if the operation fails

(Published)

selectAuditEvents

public AuditEvent[] selectAuditEvents(Long auditSpec,
                                      String filterClause,
                                      AttributeValue[] bindValues,
                                      String sortClause,
                                      int maxItems)
                               throws IfsException

Select audit events.

The filter clause is the where clause (exclusing the "where" prefix) that is used in selecting against the audit table. The sort clause is the order by clause (excluding the "order by" prefix) used in the query against the audit table.

Parameters:

auditSpec - the audit history ID to search

filterClause - the filter criteria (where clause)

bindValues - the bind values to include with the filter clause

sortClause - the sort criteria (order by clause)

maxItems - max number of items to select

Returns:

the selected audit events

Throws:

IfsException - if the operation fails

(Published)

selectAggregateAuditEventColumns

public AttributeValue[] selectAggregateAuditEventColumns(Long auditSpec,
                                                         String aggFuncName,
                                                         String[] columnNames,
                                                         String[] innerColNames,
                                                         String filterClause,
                                                         String sortClause)
                                                  throws IfsException

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

aggFuncName - 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,
                              String tableName)
                       throws IfsException

Free audit events.

Parameters:

eventIds - event IDs to be freed.

tableName - event table name

Throws:

IfsException - if the operation fails

removeAuditEventsForTarget

public void removeAuditEventsForTarget(Long specId,
                                       Long targetId)
                                throws IfsException

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

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

registerAuditEventOperationType

public int registerAuditEventOperationType(String opTypeKey,
                                           int targetCode,
                                           String targetClass,
                                           int opCode,
                                           Boolean createOrFree)
                                    throws IfsException

Register a new audit event operation 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.

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

unregisterAuditEventOperationType

public void unregisterAuditEventOperationType(String opTypeKey)
                                       throws IfsException

Unregister an audit event operation 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

lookupAuditEventOperationTypes

public int[] lookupAuditEventOperationTypes(String[] opTypeKeys)
                                     throws IfsException

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 String[] lookupAuditEventOperationTypeKeys(int[] opTypes)
                                           throws IfsException

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

lookupAuditEventOperationTypeKey

public String lookupAuditEventOperationTypeKey(int opType)
                                        throws IfsException

Looks up an audit event operation type key by its numeric value, returning the string key or null if the numeric code is not registered.

Parameters:

opType - numeric operation type

Returns:

the String key equivalent, or null if not registered

Throws:

IfsException - if the operation fails

lookupAuditTargetCode

public AuditTargetCode lookupAuditTargetCode(String className)
                                      throws IfsException

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

getAuditTypesForClass

public AttributeValue[] getAuditTypesForClass(String className,
                                              boolean includeNested)
                                       throws IfsException

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

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

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

Gets the custom audit operation type values.

Returns:

the custom operation types

Throws:

IfsException - if the operation fails

registerCustomAuditEventOperationCodeKey

public int registerCustomAuditEventOperationCodeKey(String opCodeKey)
                                             throws IfsException

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

registerCustomAuditEventOperationType

public void registerCustomAuditEventOperationType(String opTypeKey,
                                                  String opCodeKey,
                                                  int targetCode,
                                                  String targetClass)
                                           throws IfsException

Register a new custom audit event operation type.

Slightly different signature than the one that registers non-custom types, as the operation code suffix must be registered in a separate step. This method is inherently idempotent - it will return successfully if the operation type is already registered.

The caller must ensure that the targetCode and targetClass are consistent (the mapping is done by AuditEventTypeRegistrations).

Parameters:

opTypeKey - the operation key (e.g. "DOCUMENT__FAXED")

opCodeKey - operation code key (e.g. "FAXED")

targetCode - code for the target object type

targetClass - class name for target object type (e.g. "DOCUMENT")

Throws:

IfsException - if the operation fails

unregisterCustomAuditEventOperationType

public void unregisterCustomAuditEventOperationType(String opTypeKey)
                                             throws IfsException

Unregister a custom audit event operation type.

Slightly different semantics than the one that unregisters non-custom types. This method is inherently idempotent - it will return successfully even if the operation type is not registered.

Parameters:

opTypeKey - the operation key (e.g. "DOCUMENT__FAXED")

Throws:

IfsException - if the operation fails

getHighestAuditId

public long getHighestAuditId()
                       throws IfsException

Get the highest Audit Id in use.

Currently approximates this by selecting the next ID by selecting from the audit sequence, and subtracting 1.

Returns:

the highest audit ID in effect

Throws:

IfsException - if the operation fails

getAuditCertificates

public AuditCertificate[] getAuditCertificates(Long[] objectIds)
                                        throws IfsException

Select AuditCertificates for the specified object IDs.

Parameters:

objectIds - object IDs

Returns:

the requested certificates

Throws:

IfsException - if the operation fails

isTraced

public final boolean isTraced(int channel,
                              int level)
                       throws IfsException

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)

trace

public final void trace(int channel,
                        int level,
                        String payload)

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)

getServiceConfigurationProperty

public AttributeValue getServiceConfigurationProperty(String name)
                                               throws IfsException

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 String getServiceConfigurationProperty(String name,
                                              String defaultValue)
                                       throws IfsException

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(String name,
                                               boolean defaultValue)
                                        throws IfsException

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(String name,
                                           int defaultValue)
                                    throws IfsException

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)

getRepositoryParameterNames

public String[] getRepositoryParameterNames(String prefix)
                                     throws IfsException

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

(Unpublished)

getRepositoryParameter

public String getRepositoryParameter(String name)
                              throws IfsException

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

(Unpublished)

setRepositoryParameter

public void setRepositoryParameter(String name,
                                   String value)
                            throws IfsException

Sets the value of the specified repository parameter.

Parameters:

name - the parameter name

value - the parameter value

Throws:

IfsException - if the operation fails

(Unpublished)

deleteRepositoryParameter

public void deleteRepositoryParameter(String name)
                               throws IfsException

Deletes the specified repository parameter.

Parameters:

name - the parameter name

Throws:

IfsException - if the operation fails

(Unpublished)

getEncryptedRepositoryParameter

public String getEncryptedRepositoryParameter(String name)
                                       throws IfsException

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

(Unpublished)

setEncryptedRepositoryParameter

public void setEncryptedRepositoryParameter(String name,
                                            String value)
                                     throws IfsException

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

(Unpublished)

postAdminModeChange

protected final void postAdminModeChange()
                                  throws IfsException

Post intra-session admin mode change. This is not a normal event, as it only affects the target session. It is called internally whenever an operation results in a change of administration mode, including group admininstration mode changes.

Throws:

IfsException - if the operation fails

(Unpublished)

postDefaultFolderOptionChange

protected final void postDefaultFolderOptionChange()
                                            throws IfsException

Post intra-session change to default Folder options, such as default sort order or FolderRelationship class. This is not a normal event, as it only affects the target session.

Throws:

IfsException - if the operation fails

(Unpublished)

postEvent

protected final void postEvent(IfsEvent event)
                        throws IfsException

Post the specified event.

Parameters:

event - the event

Throws:

IfsException - if the operation fails

(Unpublished)

getEventPoller

public final oracle.ifs.beans.LibrarySessionEventPoller getEventPoller()
                                                                throws IfsException

Gets the event poller for this LibrarySession.

Returns:

the event poller

Throws:

IfsException - if the operation fails

(Unpublished)

processEvents

public final void processEvents()
                         throws IfsException

Polls the server for any events queued for transport to this LibrarySession and immediately processes them.

Throws:

IfsException - if the operation fails

(Published)

flushEvents

public final void flushEvents()
                       throws IfsException

Flushes any outgoing events to the database.

Throws:

IfsException - if the operation fails

(Published)

forceReadEvents

public final void forceReadEvents()
                           throws IfsException

Forces a read and processing of incoming events from other services.

Throws:

IfsException - if the operation fails

(Published)

processEventsInBackground

protected final void processEventsInBackground()
                                        throws IfsException

Polls the server for any events queued for transport to this LibrarySession and immediately processes them.

Unlike processEvents, which is part of the published API and only invoked from user applications, this method is invoked only by the EventPoller. As such, it uses different locking semantics.

Throws:

IfsException - if the operation fails

(Unpublished)

blockBackgroundProcessing

public final void blockBackgroundProcessing()

Blocks any background event processing.

Necessary whenever IfsConnections are used in bean-side code. The caller must ensure that resumeBackgroundProcessing is called in a finally block to resume background processing.

(Unpublished)

resumeBackgroundProcessing

public final void resumeBackgroundProcessing()

Resumes any background event processing.

Must allows be called after a call to blockBackgroundProcessing.

(Unpublished)

processEvent

public final void processEvent(IfsEvent event)
                        throws IfsException

Processes the specified event. This is an internal method, and should only be used by the event processing methods in S_LibrarySession.

Parameters:

event - the event

Throws:

IfsException - if the operation fails

(Unpublished)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Handles the specified event.

Specified by:

handleEvent in interface IfsEventHandler

Parameters:

event - the event

Throws:

IfsException - if the operation fails

(Unpublished)

registerEventHandler

public final void registerEventHandler(LibraryObject lo,
                                       IfsEventHandler handler)
                                throws IfsException

Registers the specified IfsEventHandler to receive events for the specified LibraryObject.

This method allows any object implementing the IfsEventHandler interface to receive notification of events for any LibraryObject. This could be used, for example, to automatically refresh a window displaying the items in a Folder whenever the Folder's contents change.

Parameters:

lo - the LibraryObject of interest

handler - the IfsEventHandler

Throws:

IfsException - (IFS-11000) if the operation fails

(Published)

deregisterEventHandler

public final void deregisterEventHandler(LibraryObject lo,
                                         IfsEventHandler handler)
                                  throws IfsException

Deregisters the specified IfsEventHandler for the specified LibraryObject.

Parameters:

lo - the LibraryObject. If null, all LibraryObjects previously registered for the IfsEventHandler using registerEventHandler are deregistered.

handler - the IfsEventHandler. If null, all IfsEventHandlers previously registered for the LibraryObject using registerEventHandler are deregistered.

Throws:

IfsException - (IFS-11001) if the operation fails

(Published)

registerClassEventHandler

public final void registerClassEventHandler(ClassObject co,
                                            boolean includeSubclasses,
                                            IfsEventHandler handler)
                                     throws IfsException

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 LibraryObject. This could be used, for example, to automatically refresh a window displaying the items in a Folder whenever the Folder's contents change.

Parameters:

co - the 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 LibraryObjects of that new class

handler - the IfsEventHandler

Throws:

IfsException - (IFS-11000) if the operation fails

(Published)

deregisterClassEventHandler

public final void deregisterClassEventHandler(ClassObject co,
                                              boolean includeSubclasses,
                                              IfsEventHandler handler)
                                       throws IfsException

Deregisters the specified IfsEventHandler for the specified class.

Parameters:

co - the ClassObject. If null, all 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 ClassObject using registerClassEventHandler are deregistered.

Throws:

IfsException - (IFS-11001) if the operation fails

(Published)

registerServiceEventHandler

public final void registerServiceEventHandler(IfsEventHandler handler)
                                       throws IfsException

Registers the specified IfsEventHandler to receive events for all committed events processed by the current service.

This method allows any object implementing the IfsEventHandler interface to receive notification of all committed events processed by the S_LibraryService.

Parameters:

handler - the IfsEventHandler

Throws:

IfsException - 11000: if the operation fails

(Unpublished)

deregisterServiceEventHandler

public final void deregisterServiceEventHandler(IfsEventHandler handler)
                                         throws IfsException

Deregisters the specified IfsEventHandler.

Parameters:

handler - the IfsEventHandler. If null, all IfsEventHandlers previously registered are deregistered.

Throws:

IfsException - (IFS-11001) if the operation fails

(Unpublished)

isConnected

public boolean isConnected()

Return connection state of this LibrarySession

Returns:

the connection state; true if connected.

(Published)

isBusy

public final boolean isBusy()
                     throws IfsException

Return busy state of this LibrarySession. This returns true if there is an active operation in the server for this session

Returns:

the busy state; true if a server-side operation is in progress

Throws:

IfsException - if the operation fails

(Unpublished)

isOuterOperation

public final boolean isOuterOperation()
                               throws IfsException

Return indication as to whether the outer most operation (of a potentially nested operation) is currently in progress.

Returns:

true if the outermost operation is in progress

Throws:

IfsException - if the operation fails

(Unpublished)

setCreateContext

public final void setCreateContext(Long id,
                                   LibraryObjectDefinition def)
                            throws IfsException

Set the context of a create operation for the specified object.

Parameters:

id - the object ID

def - the create operation context

Throws:

IfsException - if the operation fails

(Unpublished)

getCreateContext

public final LibraryObjectDefinition getCreateContext(Long id)
                                               throws IfsException

Get the context of a create operation, if a create is in progress for the specified object.

Parameters:

id - the object ID

Returns:

the create operation context if the specified object has a create operation in progress, or null otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

clearCreateContext

public final void clearCreateContext(Long id)
                              throws IfsException

Remove the context of a create operation for the specified object.

Parameters:

id - the object ID

Throws:

IfsException - if the operation fails

(Unpublished)

setFreeContext

public final void setFreeContext(Long id,
                                 LibraryObjectDefinition def)
                          throws IfsException

Set the context of a free operation for the specified object.

Parameters:

id - the object ID

def - the free operation context

Throws:

IfsException - if the operation fails

(Unpublished)

getFreeContext

public final LibraryObjectDefinition getFreeContext(Long id)
                                             throws IfsException

Get the context of a free operation, if a free is in progress for the specified object.

Parameters:

id - the object ID

Returns:

the free operation context if the specified object has a free operation in progress, or null otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

clearFreeContext

public final void clearFreeContext(Long id)
                            throws IfsException

Remove the context of a free operation for the specified object.

Parameters:

id - the object ID

Throws:

IfsException - if the operation fails

(Unpublished)

setUpdateContext

public final void setUpdateContext(Long id,
                                   LibraryObjectDefinition def)
                            throws IfsException

Set the context of an update operation for the specified object.

Parameters:

id - the object ID

def - the update operation context

Throws:

IfsException - if the operation fails

(Unpublished)

getUpdateContext

public final LibraryObjectDefinition getUpdateContext(Long id)
                                               throws IfsException

Get the context of an update operation, if an update is in progress for the specified object.

Parameters:

id - the object ID

Returns:

the update operation context if the specified object has an update operation in progress, or null otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

clearUpdateContext

public final void clearUpdateContext(Long id)
                              throws IfsException

Remove the context of an update operation for the specified object.

Parameters:

id - the object ID

Throws:

IfsException - if the operation fails

(Unpublished)

setCopyContext

public final void setCopyContext(Long id,
                                 LibraryObjectDefinition def)
                          throws IfsException

Set the context of a copy operation for the specified object.

Parameters:

id - the object ID

def - the copy operation context

Throws:

IfsException - if the operation fails

(Unpublished)

getCopyContext

public final LibraryObjectDefinition getCopyContext(Long id)
                                             throws IfsException

Get the context of a copy operation, if a copy is in progress for the specified object.

Parameters:

id - the object ID

Returns:

the copy operation context if the specified object has a copy operation in progress, or null otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

clearCopyContext

public final void clearCopyContext(Long id)
                            throws IfsException

Remove the context of a copy operation for the specified object.

Parameters:

id - the object ID

Throws:

IfsException - if the operation fails

(Unpublished)

beginImplicitTransaction

public final Transaction beginImplicitTransaction()
                                           throws IfsException

Starts a writeable transaction implicitly at the beginning of an operation. Returns null and takes no action if an implicit transaction is already started, either initialted bean-side or server-side.

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)

completeImplicitTransaction

public final void completeImplicitTransaction(Transaction transaction)
                                       throws IfsException

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)

abortImplicitTransaction

public final void abortImplicitTransaction(Transaction transaction)

Aborts an implicit transaction. If the specified transaction is null, then an implicit transaction was not created, and no action is necessary. If an exception occurs while trying to abort the implicit transaction, the transaction will be forcefully rolled back, and the internal exception will be logged.

Parameters:

transaction - the transaction to abort

(Published)

isImplicitTransactionInProgress

public final boolean isImplicitTransactionInProgress()
                                              throws IfsException

Return indication as to whether there is an implicit transaction in progress.

Returns:

true if an implicit transaction is in progress

Throws:

IfsException - if the operation fails

(Unpublished)

isTransactionInProgress

public final boolean isTransactionInProgress()
                                      throws IfsException

Gets whether this LibrarySession is in a transaction, explicit or implicit.

Returns:

true if the session has a transaction context; false otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

cancel

public final void cancel()
                  throws IfsException

Cancel any server-side operation in progress for this session. If no server-side operation is in progress, this method simply returns without performing any action, and no exception is thrown. Otherwise, a cancel is signalled on the server-side. This method may return before the operation is completely cancelled, as the completion of the cancellation occurs in another thread.

Throws:

IfsException - if the operation fails

(Unpublished)

getResourceString

public String getResourceString(String key)
                         throws IfsException

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

(Unpublished)

getClassObject

public ClassObject getClassObject(Long classid)
                           throws IfsException

Gets the ClassObject for the specified class id.

Parameters:

classid - the class id

Returns:

the classobject

Throws:

IfsException - if the operation fails

(Unpublished)

getResourceString

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

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

(Unpublished)

getClassObjectByName

public final ClassObject getClassObjectByName(String className)
                                       throws IfsException

Returns a class object given a class name, throwing an exception if not found.

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)

getClassObjectByName

public final ClassObject getClassObjectByName(String className,
                                              boolean enforce)
                                       throws IfsException

Returns a class object given a class name, optionally returning null if not found.

This uses the ClassObjectCollection and is simply a convenience method.

Parameters:

className - the name of a class

enforce - if true, throw an exception if not found; if false, return null if not found

Returns:

the S_ClassObject

Throws:

IfsException - if the operation fails

(Published)

getClassObjectValueByName

public AttributeValue getClassObjectValueByName(String name)
                                         throws IfsException

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)

getAttributeSortName

public String getAttributeSortName(String classname,
                                   String attributename)
                            throws IfsException

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

This is part of the LibrarySessionInterface definition.

Specified by:

getAttributeSortName in interface LibrarySessionInterface

Parameters:

classname - the name of the ClassObject

attributename - the name of the Attribute

Returns:

the Database object name that corresponds to an Attribute.

Throws:

IfsException - if the operation fails

(Unpublished)

getDirectoryObject

public DirectoryObject getDirectoryObject(Long id)
                                   throws IfsException

Lookup a DirectoryObject by its id.

Parameters:

id - identifier for the object

Returns:

the DirectoryObject

Throws:

IfsException - if operation fails.

(Published)

getLibraryObject

public LibraryObject getLibraryObject(Long id)
                               throws IfsException

Lookup a LibraryObject by its id.

Parameters:

id - identifier for the object

Returns:

the LibraryObject

Throws:

IfsException - if operation fails.

(Published)

getLibraryObject

public LibraryObject getLibraryObject(Long id,
                                      Long classId)
                               throws IfsException

Lookup a LibraryObject by its id and classId.

Parameters:

id - ID for the object

classId - class ID for the object

Returns:

the LibraryObject

Throws:

IfsException - if operation fails.

(Published)

recacheObject

protected void recacheObject(LibraryObject obj)
                      throws IfsException

Re-cache the specified object.

Parameters:

obj - the object

Throws:

IfsException - if the operation fails

(Unpublished)

getSchemaObject

public SchemaObject getSchemaObject(Long id)
                             throws IfsException

Lookup a SchemaObject by its id.

Parameters:

id - identifier for the object

Returns:

the SchemaObject

Throws:

IfsException - if operation fails.

(Published)

getSchemaObject

public SchemaObject getSchemaObject(Long id,
                                    Long classId)
                             throws IfsException

Lookup a SchemaObject by its id and classId.

The classId can be specified as null if it is not known.

Parameters:

id - ID for the object

classId - class ID for the object

Returns:

the SchemaObject

Throws:

IfsException - if operation fails.

(Unpublished)

getSystemObject

public SystemObject getSystemObject(Long id)
                             throws IfsException

Lookup a SystemObject by its id.

Parameters:

id - identifier for the object

Returns:

the SystemObject

Throws:

IfsException - if operation fails.

(Published)

getSystemObject

public SystemObject getSystemObject(Long id,
                                    Long classId)
                             throws IfsException

Lookup a SystemObject by its id and classId.

The classId can be specified as null if it is not known.

Parameters:

id - ID for the object

classId - class ID for the object

Returns:

the SystemObject

Throws:

IfsException - if operation fails.

(Unpublished)

getSimpleObject

public SimpleObject getSimpleObject(Long id)
                             throws IfsException

Lookup a SimpleObject by its id.

Parameters:

id - identifier for the object

Returns:

the SimpleObject

Throws:

IfsException - if operation fails.

(Published)

getSimpleObject

public SimpleObject getSimpleObject(Long id,
                                    Long classId)
                             throws IfsException

Lookup a SimpleObject by its id and classId.

The classId can be specified as null if it is not known.

Parameters:

id - ID for the object

classId - class ID for the object

Returns:

the SimpleObject

Throws:

IfsException - if operation fails.

(Unpublished)

getPublicObject

public PublicObject getPublicObject(Long id)
                             throws IfsException

Lookup a PublicObject by its id.

Parameters:

id - identifier for the object

Returns:

the PublicObject

Throws:

IfsException - if operation fails.

(Published)

getPublicObject

public PublicObject getPublicObject(Long id,
                                    Long classId)
                             throws IfsException

Lookup a PublicObject by its id and classId.

The classId can be specified as null if it is not known.

Parameters:

id - ID for the object

classId - class ID for the object

Returns:

the PublicObject

Throws:

IfsException - if operation fails.

(Unpublished)

getDiscoverabilityOfPublicObjectsIds

public Long[] getDiscoverabilityOfPublicObjectsIds(Long[] ids)
                                            throws IfsException

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

(Unpublished)

isDiscoverablePublicObjectId

public boolean isDiscoverablePublicObjectId(Long id)
                                     throws IfsException

Return indication as to whether the PublicObject ID specified represents an object that the current user can discover.

Parameters:

id - the PublicObject ID to check

Returns:

true if the ID represents an ID the user can discover; false otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

isPublicObjectIdDiscoverable

public boolean isPublicObjectIdDiscoverable(Long id)
                                     throws IfsException

Return indication as to whether the PublicObject matching the specified object ID is discoverable.

Returns true if and only if the user is able to discover a PublicObject with the ID specified.

Parameters:

id - PublicObject ID

Returns:

true if the user can discover a PublicOBject with the specified ID; false otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

getDirectoryObjectInterface

public DirectoryObjectInterface getDirectoryObjectInterface(Long id)
                                                     throws IfsException

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

(Unpublished)

getDirectoryObjectInterfaces

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

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

(Unpublished)

getPublicObjectInterface

public PublicObjectInterface getPublicObjectInterface(Long id)
                                               throws IfsException

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

(Unpublished)

getPublicObjectInterfaces

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

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

(Unpublished)

getSchemaObjectInterface

public SchemaObjectInterface getSchemaObjectInterface(Long id)
                                               throws IfsException

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

(Unpublished)

getSchemaObjectInterfaces

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

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

(Unpublished)

getSystemObjectInterface

public SystemObjectInterface getSystemObjectInterface(Long id)
                                               throws IfsException

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

(Unpublished)

getSystemObjectInterfaces

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

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

(Unpublished)

getSimpleObjectInterface

public SimpleObjectInterface getSimpleObjectInterface(Long id,
                                                      Long classId)
                                               throws IfsException

Gets the SimpleObjectInterface for the specified id.

Specified by:

getSimpleObjectInterface in interface LibrarySessionInterface

Parameters:

id - the id of interest

classId - the classId of interest

Returns:

the SimpleObjectInterface

Throws:

IfsException - if the operation fails

(Unpublished)

getSimpleObjectInterfaces

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

Gets the SimpleObjectInterfaces for the specified ids.

Specified by:

getSimpleObjectInterfaces in interface LibrarySessionInterface

Parameters:

ids - the ids of interest

Returns:

the SimpleObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getSimpleObjectInterfaces

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

Gets the SimpleObjectInterfaces for the specified ids.

Specified by:

getSimpleObjectInterfaces in interface LibrarySessionInterface

Parameters:

ids - the ids of interest

primaryClassId - the primary class ID

Returns:

the SimpleObjectInterfaces

Throws:

IfsException - if the operation fails

(Unpublished)

getLowestCommonClassObjectIdAncestor

public Long getLowestCommonClassObjectIdAncestor(SimpleObjectInterface[] mos)
                                          throws IfsException

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

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

This is part of the LibrarySessionInterface.

Specified by:

getLowestCommonClassObjectIdAncestor in interface LibrarySessionInterface

Parameters:

mos - the SimpleObjects

Returns:

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

Throws:

IfsException - if the operation fails

(Unpublished)

getLibraryObject

public LibraryObject getLibraryObject(S_LibraryObjectData data)
                               throws IfsException

getLibraryObject - lookup a LibraryObject by its data.

Parameters:

data - a data object

Returns:

the corresponding object

Throws:

IfsException - if operation fails.

(Unpublished)

constructInstance

protected LibraryObject constructInstance(S_LibraryObjectData data)
                                   throws IfsException

construct a LibraryObject Instance

Parameters:

data - data for the object

Returns:

the object

Throws:

IfsException - if operation fails.

(Unpublished)

constructInstance

public LibraryObject constructInstance(Long id,
                                       Long class_id,
                                       S_ClassObjectData classData)
                                throws IfsException

construct a LibraryObject Instance

Parameters:

id - id for the object

class_id - Class id for the object

classData - Class data for the object's class

Returns:

the object

Throws:

IfsException - if operation fails.

(Unpublished)

cacheInstance

protected LibraryObject cacheInstance(Long id,
                                      LibraryObject obj)
                               throws IfsException

Put a LibraryObject Instance in the session's object cache.

This is done as part of normal construction, and is also done when after an object's creation is complete, if constructed prior to createPublicObject() etal.

Parameters:

id - id for the object

obj - the object

Throws:

IfsException - if operation fails.

(Unpublished)

getLibraryObjectData

public S_LibraryObjectData getLibraryObjectData(Long id,
                                                Long classId,
                                                String attributeName,
                                                boolean selectFully)
                                         throws IfsException

Gets the S_LibraryObjectData for the specified id and class id.

Parameters:

id - the id of interest

classId - the if 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)

Throws:

IfsException - if the operation fails

(Unpublished)

getServerSideLockObject

public Object getServerSideLockObject()

Gets the Object used by LibrarySession to synchronize invocations to the server-side class, mainly the invocations of the methods defined by the S_LibrarySessionInterface.

Returns:

the synchronization object

Throws:

IfsException - if the operation fails

(Unpublished)

getResolvedClassObjectData

public S_ClassObjectData getResolvedClassObjectData(Long id)
                                             throws IfsException

Gets the fully-resolved S_ClassObjectData.

Parameters:

id - the id

Returns:

the data

Throws:

IfsException - if the operation fails

(Unpublished)

delete

public void delete(PublicObject[] items)
            throws IfsException

Deletes all the passed PublicObjects. All objects are marked for delete and are 'moved' to the virtual wastebasket. The objects are deleted in a single transaction; any failure will rollback the entire operation.

Parameters:

items - the PublicObjects to be deleted.

Throws:

IfsException - if operation fails.

(Unpublished)

undelete

public void undelete(PublicObject[] items)
              throws IfsException

Undeletes all the passed PublicObjects. The passed objects are 'moved' from the virtual wastebasket by having their marked for delete attribute cleared. The objects are undeleted in a single transaction; any failure will rollback the entire operation.

Parameters:

items - the PublicObjects to be undeleted.

Throws:

IfsException - if operation fails.

(Unpublished)

free

public void free(LibraryObject[] items)
          throws IfsException

Free all the passed objects. All passed objects are permanently removed from the CM SDK Server. The objects are freed in a single transaction; any failure will rollback the entire operation.

Parameters:

items - the objects to be freed.

Throws:

IfsException - if operation fails.

(Unpublished)

getObjectsLockedForSession

public PublicObject[] getObjectsLockedForSession()
                                          throws IfsException

Gets the array of PublicObjects that the current session holds session locks on.

Returns:

the PublicObjects currently session locked by this session.

Throws:

IfsException - if operation fails.

(Published)

unlockForSession

public void unlockForSession(PublicObject[] items)
                      throws IfsException

Release session locks on a set of PublicObjects. This method is convenient for releasing session locks explicitly on all objects that are locked by this session; use this method in conjunction with the getObjectsLockedForSession() method.

The objects are unlocked in a single transaction; any failure will rollback the entire operation.

Parameters:

items - the PublicObjects to be unlocked.

Throws:

IfsException - if operation fails.

(Published)

getWorldDirectoryGroup

public DirectoryGroup getWorldDirectoryGroup()
                                      throws IfsException

Gets the DirectoryGroup that represents World access.

Returns:

the World group.

Throws:

IfsException - if operation fails.

(Published)

getSystemDirectoryUser

public DirectoryUser getSystemDirectoryUser()
                                     throws IfsException

Gets the DirectoryUser who is the permanent admin user.

Returns:

the system user

Throws:

IfsException - if operation fails.

(Published)

isSystemDirectoryUser

public boolean isSystemDirectoryUser()
                              throws IfsException

Returns true if the session's current user is the permanent admin user.

Returns:

true if the permanent admin user is the current user

Throws:

IfsException - if operation fails.

(Published)

isGuestUser

public boolean isGuestUser()
                    throws IfsException

Returns true if the session's current user is the guest user.

Returns:

true if the guest user is the current user

Throws:

IfsException - if operation fails.

(Published)

getGuestUser

public DirectoryUser getGuestUser()
                           throws IfsException

Gets the DirectoryUser who is the guest user.

Returns:

the guest user; returns null if there is no guest user

Throws:

IfsException - if operation fails.

(Published)

getArrayTypeAttributeValue

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

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

For internal use only. Do not use this method.

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

Specified by:

getArrayTypeAttributeValue in interface LibrarySessionInterface

Parameters:

av - the AttributeValue of interest

objectId - The LibraryObject ID.

attributeId - The Attribute id.

priClassId - The primary Class ID

count - the number of elements in the AttributeValue

Returns:

a fully-resolved copy of the AttributeValue

Throws:

IfsException - if the operation fails

(Unpublished)

getMapTypeAttributeValue

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

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

For internal use only. Do not use this method.

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

Specified by:

getMapTypeAttributeValue in interface LibrarySessionInterface

Parameters:

dataType - the AttributeValue's data type

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

attrIdVal - the ID value of the Attribute

count - the number of elements in the AttributeValue

Returns:

a fully-resolved copy of the AttributeValue

Throws:

IfsException - if the operation fails

(Unpublished)

grantAdministration

public void grantAdministration(DirectoryUser user)
                         throws IfsException

Grant the Administrator Mode state for the specified Directory User.

Parameters:

user - the user to receive the admin grant

Throws:

IfsException - if operation fails.

(Published)

registerCollection

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

Registers a collection so that it can be automatically reset by handleEvent as needed when new LibraryObjects are created, updated, or freed.

Parameters:

collection - the collection itself

classname - the classname corresponding to the ClassObject name specified at collection construction

Throws:

IfsException - if the operation fails

(Unpublished)

deregisterCollection

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

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)

verifyExecutionMode

public void verifyExecutionMode(int mode)
                         throws IfsException

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

(Unpublished)

verifyAdministrationMode

public void verifyAdministrationMode()
                              throws IfsException

Verify that the effective execution mode for the session is at least administration mode.

Throws:

IfsException - (IFS-21051) if not in administration mode

(Unpublished)

verifyInstallationMode

protected void verifyInstallationMode()
                               throws IfsException

Verify that the effective execution mode for the session is at least installation mode.

Throws:

IfsException - (IFS-21051) if not in installation mode

(Unpublished)

beginTransaction

public final Transaction beginTransaction()
                                   throws IfsException

Starts a writeable transaction.

Returns:

a token that can be passed to either completeTransaction or abortTransaction

Throws:

IfsException - (IFS-21000) if not connected; (IFS-10651) if the operation fails

(Published)

completeTransaction

public final void completeTransaction(Transaction transaction)
                               throws IfsException

Completes a transaction.

Parameters:

transaction - the transaction to complete

Throws:

IfsException - (IFS-21000) if not connected; (IFS-10652) if the operation fails

(Published)

abortTransaction

public final void abortTransaction(Transaction transaction)
                            throws IfsException

Aborts a transaction.

Parameters:

transaction - the transaction to abort

Throws:

IfsException - (IFS-21000) if not connected; (IFS-10653) if the operation fails

(Published)

abortTransaction

public final void abortTransaction(Transaction transaction,
                                   IfsException originalException)
                            throws IfsException

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

(Unpublished)

commit

public final void commit()
                  throws IfsException

Makes all pending changes for all in-progress Transactions for this LibrarySession visible to all other LibrarySessions.

After this method is invoked, attempting to abort any of the in-progress Transactions for this LibrarySession will throw an exception.

Throws:

IfsException - (IFS-21000) if not connected; (IFS-10654) if the operation fails

(Unpublished)

rollback

public final void rollback()
                    throws IfsException

Discards all pending changes for all in-progress Transactions for this LibrarySession.

After this method is invoked, attempting to complete any of the in-progress Transactions for this LibrarySession will throw an exception.

Throws:

IfsException - (IFS-21000) if not connected; (IFS-10655) if the operation fails

(Unpublished)

getIfsConnection

public IfsConnection getIfsConnection()
                               throws IfsException

Returns an IfsConnection for this LibrarySession.

A writeable transaction must be in progress; if not, an IfsException (IFS-10665) is thrown.

Returns:

the connection

Throws:

IfsException - if the operation fails

(Published)

invokeServerMethod

public Serializable invokeServerMethod(String methodName,
                                       Serializable payload)
                                throws IfsException

Invokes a custom server-side method. The payload and return are arbitrary Serializable objects. There must be a method with the specified name on the server-side S_LibrarySession class.

Parameters:

methodName - the method name.

payload - the method argument

Returns:

the method result

Throws:

IfsException - if operation fails.

(Published)

createView

public void createView(ViewSpecification vsp)
                throws IfsException

Creates a database view from a View specification.

Parameters:

vsp - the view specification

Throws:

IfsException - if operation fails

(Published)

getFolderIndexDeferredUpdates

public Vector getFolderIndexDeferredUpdates(int maxItems)
                                     throws IfsException

Gets a set of Deferred Folder Index Updates

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)

applyFolderIndexDeferredUpdate

public void applyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry)
                                    throws IfsException

Apply a Folder index deferred update

Parameters:

entry - the entry to apply

Throws:

IfsException - if the operation fails

(Unpublished)

isAclIndexUpdateModeSynchronous

public boolean isAclIndexUpdateModeSynchronous()
                                        throws IfsException

Check if ACL Index update mode is synchronous

Returns:

true if update mode is synchronous; false otherwise

Throws:

IfsException - if the operation fails

(Unpublished)

getAclIndexDeferredUpdates

public Vector getAclIndexDeferredUpdates(int maxItems)
                                  throws IfsException

Gets a set of Deferred ACL Resolution Entries

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)

applyAclIndexDeferredUpdate

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

Apply an ACL index deferred update

Parameters:

entry - the entry to apply

deleteAfterProcessing - whether to delete after processing

Throws:

IfsException - if the operation fails

(Unpublished)

deleteAclIndexDeferredUpdates

public void deleteAclIndexDeferredUpdates(Long[] ids)
                                   throws IfsException

Deletes a set of Deferred ACL Resolution Entries

Parameters:

ids - the set of AccessControlListDeferredUpdate IDs to delete

Throws:

IfsException - if the operation fails

(Unpublished)

resolveObjects

public void resolveObjects(LibraryObject[] objs,
                           ObjectResolverSpecification spec)
                    throws IfsException

Force resolution of a set of LibraryObjects

Parameters:

objs - the set of objects to resolve

spec - the resolution specification

Throws:

IfsException - if the operation fails

(Unpublished)

createRetainedEventDatabaseObjects

public void createRetainedEventDatabaseObjects(RetainedEvent event)
                                        throws IfsException

Create tables for a RetainedEvent type.

Parameters:

event - RetainedEvent that describes the type

Throws:

IfsException - if the operation fails

(Unpublished)

dropRetainedEventDatabaseObjects

public void dropRetainedEventDatabaseObjects(RetainedEvent event)
                                      throws IfsException

Drop tables for a RetainedEvent type.

Parameters:

event - RetainedEvent that describes the type

Throws:

IfsException - if the operation fails

(Unpublished)

insertRetainedEvent

public void insertRetainedEvent(RetainedEvent event)
                         throws IfsException

insert a RetainedEvent.

Parameters:

event - RetainedEvent to insert

Throws:

IfsException - if the operation fails

(Unpublished)

deleteRetainedEvent

public void deleteRetainedEvent(RetainedEvent event)
                         throws IfsException

delete a RetainedEvent.

Parameters:

event - RetainedEvent to delete

Throws:

IfsException - if the operation fails

(Unpublished)

getRetainedEvents

public RetainedEvent[] getRetainedEvents(RetainedEvent event,
                                         int maxItems)
                                  throws IfsException

get a set of RetainedEvents, using a specified RetainedEvent to indicate the type of RetainedEvent desired.

Parameters:

event - Type of RetainedEvent desired

maxItems - max number of items desired

Returns:

The set of RetainedEvents, can return null if none

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetLibrarySession

protected void DMSetLibrarySession(LibrarySession session)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSessionId

protected Long DMGetSessionId()
                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetServiceId

protected Long DMGetServiceId()
                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSchemaName

public String DMGetSchemaName()
                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetClockOffset

protected Long DMGetClockOffset()
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetServiceConfigurationProperties

protected Hashtable DMGetServiceConfigurationProperties()
                                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetRepositoryParameterNames

protected String[] DMGetRepositoryParameterNames(String prefix)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetRepositoryParameter

protected String DMGetRepositoryParameter(String name)
                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetRepositoryParameter

protected void DMSetRepositoryParameter(String name,
                                        String value)
                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDeleteRepositoryParameter

protected void DMDeleteRepositoryParameter(String name)
                                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetEncryptedRepositoryParameter

protected String DMGetEncryptedRepositoryParameter(String name)
                                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetEncryptedRepositoryParameter

protected void DMSetEncryptedRepositoryParameter(String name,
                                                 String value)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMUpdateSessionDefaults

public final void DMUpdateSessionDefaults(Hashtable properties)
                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMUpdateLocalizer

public final void DMUpdateLocalizer(Hashtable properties)
                             throws IfsException

Updates the S_LibrarySession Localizer to reflect the Localizer properties specified as name/value pairs.

Parameters:

properties - the Localizer properties

Throws:

IfsException - if the operation fails

(Unpublished)

DMRegisterEventHandler

public void DMRegisterEventHandler(Long id)
                            throws IfsException

Notify server-side of a registered event handler for the specified object.

Parameters:

id - the object ID that has a registered handler

Throws:

IfsException - if the operation fails

(Unpublished)

DMDeregisterEventHandler

public void DMDeregisterEventHandler(Long id)
                              throws IfsException

Notify server-side that previously registered event handlers for the specified object have been de-registered.

Parameters:

id - the object ID that no longer has any registered handlers

Throws:

IfsException - if the operation fails

(Unpublished)

DMRegisterClassEventHandler

public void DMRegisterClassEventHandler(Long classId)
                                 throws IfsException

Notify server-side of a registered event handler for the specified ClassObject.

Parameters:

classId - the Class ID that has a registered handler

Throws:

IfsException - if the operation fails

(Unpublished)

DMDeregisterClassEventHandler

public void DMDeregisterClassEventHandler(Long classId)
                                   throws IfsException

Notify server-side that previously registered event handlers for the specified ClassObject have been de-registered.

Parameters:

classId - the Class ID that no longer has any registered handlers

Throws:

IfsException - if the operation fails

(Unpublished)

DMRegisterServiceEventHandler

protected void DMRegisterServiceEventHandler(IfsEventHandler handler)
                                      throws IfsException

Notify server-side of a new registered Service event handler.

Parameters:

handler - the handler to register

Throws:

IfsException - if the operation fails

(Unpublished)

DMDeregisterServiceEventHandler

protected void DMDeregisterServiceEventHandler(IfsEventHandler handler)
                                        throws IfsException

Notify server-side to de-register a Service event handler.

Parameters:

handler - the handler to de-register

Throws:

IfsException - if the operation fails

(Unpublished)

DMTrace

protected void DMTrace(int channel,
                       int level,
                       Long serviceId,
                       Long sessionId,
                       Long id,
                       String classname,
                       String payload)
                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetSessionTraceLoggerLevels

protected void DMSetSessionTraceLoggerLevels(int[] levels)
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSessionTraceLoggerLevels

protected int[] DMGetSessionTraceLoggerLevels()
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetServiceTraceLoggerLevels

protected void DMSetServiceTraceLoggerLevels(int[] levels)
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetServiceTraceLoggerLevels

protected int[] DMGetServiceTraceLoggerLevels()
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMPostEvent

protected void DMPostEvent(IfsEvent event)
                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMProcessEvents

protected void DMProcessEvents()
                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFlushEvents

protected void DMFlushEvents()
                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMForceReadEvents

protected void DMForceReadEvents()
                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMProcessEventsInBackground

protected Vector DMProcessEventsInBackground()
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDisconnect

protected void DMDisconnect()
                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMVersionNumber

protected long DMVersionNumber()
                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMVersionString

protected String DMVersionString()
                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSchemaVersionNumber

protected long DMSchemaVersionNumber()
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSchemaVersionString

protected String DMSchemaVersionString()
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMListWastebasketSelectorItems

protected Vector DMListWastebasketSelectorItems(String searchClass,
                                                String searchDefinition,
                                                boolean recursive,
                                                SortSpecification sort)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetWastebasketSelectorItemCount

protected long DMGetWastebasketSelectorItemCount(String searchClass,
                                                 String searchDefinition,
                                                 boolean recursive)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMOpenWastebasketSelector

protected long DMOpenWastebasketSelector(String searchClass,
                                         String searchDefinition,
                                         boolean recursive,
                                         SortSpecification sort)
                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMPostAuditEvent

protected void DMPostAuditEvent(AuditEvent event,
                                int mode)
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDirectlyDispatchAuditEvent

protected Long DMDirectlyDispatchAuditEvent(AuditEvent event,
                                            Long specId)
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSelectRawAuditEvents

protected RawAuditEvent[] DMSelectRawAuditEvents(String filterClause,
                                                 int maxItems)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveRawAuditEvents

protected void DMRemoveRawAuditEvents(RawAuditEvent[] rawEvents)
                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMHandleAuditEventDispatchRequests

protected void DMHandleAuditEventDispatchRequests(ArrayList reqList,
                                                  String tableName)
                                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSelectAuditEvents

protected AuditEvent[] DMSelectAuditEvents(Long auditSpec,
                                           String filterClause,
                                           AttributeValue[] bindValues,
                                           String sortClause,
                                           int maxItems)
                                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSelectAggregateAuditEventColumns

protected AttributeValue[] DMSelectAggregateAuditEventColumns(Long auditSpec,
                                                              String aggFuncName,
                                                              String[] columnNames,
                                                              String[] aggColumnNames,
                                                              String filterClause,
                                                              String sortClause)
                                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveAuditEvents

protected void DMRemoveAuditEvents(long[] eventIds,
                                   String tableName)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveAuditEventsForTarget

protected void DMRemoveAuditEventsForTarget(Long specId,
                                            Long targetId)
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSelectSpecificAuditFolderPath

protected AuditFolderPath DMSelectSpecificAuditFolderPath(long folderPathId)
                                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRegisterAuditEventOperationType

protected int DMRegisterAuditEventOperationType(String opTypeKey,
                                                int targetCode,
                                                String targetClass,
                                                int opCode,
                                                Boolean createOrFree)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMUnregisterAuditEventOperationType

protected void DMUnregisterAuditEventOperationType(String opTypeKey)
                                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMLookupAuditEventOperationTypes

protected int[] DMLookupAuditEventOperationTypes(String[] keys)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMLookupAuditEventOperationTypeKeys

protected String[] DMLookupAuditEventOperationTypeKeys(int[] opTypes)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMLookupAuditTargetCode

public AuditTargetCode DMLookupAuditTargetCode(String className)
                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAuditTypesForClass

protected AttributeValue[] DMGetAuditTypesForClass(String className,
                                                   boolean includeNested)
                                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAuditTypesForCreateOperations

protected AttributeValue[] DMGetAuditTypesForCreateOperations()
                                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAuditTypesForFreeOperations

protected AttributeValue[] DMGetAuditTypesForFreeOperations()
                                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetCustomAuditTypes

protected AttributeValue[] DMGetCustomAuditTypes()
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRegisterCustomAuditEventOperationCodeKey

protected int DMRegisterCustomAuditEventOperationCodeKey(String opCodeKey)
                                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetHighestAuditId

protected long DMGetHighestAuditId()
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAuditCertificates

protected AuditCertificate[] DMGetAuditCertificates(Long[] objectIds)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMEmptyWastebasket

protected void DMEmptyWastebasket()
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFilterDeletedObjects

protected void DMFilterDeletedObjects(boolean mode)
                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetExecutionMode

protected void DMSetExecutionMode(int mode)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsExecutionMode

protected boolean DMIsExecutionMode(int mode)
                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMPushTemporaryExecutionMode

protected void DMPushTemporaryExecutionMode(int mode)

Invokes the identically-named remote S_LibrarySession method.

(Unpublished)

DMPopTemporaryExecutionMode

protected void DMPopTemporaryExecutionMode()

Invokes the identically-named remote S_LibrarySession method.

(Unpublished)

DMPushTemporaryAccessCheckMode

protected void DMPushTemporaryAccessCheckMode(boolean mode)

Invokes the identically-named remote S_LibrarySession method.

(Unpublished)

DMPopTemporaryAccessCheckMode

protected void DMPopTemporaryAccessCheckMode()

Invokes the identically-named remote S_LibrarySession method.

(Unpublished)

DMSendClientVersionInformation

protected void DMSendClientVersionInformation(long versionNumber,
                                              String versionString)
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFeignUser

protected void DMFeignUser(Long id,
                           Long classid)
                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMPersistTokenCredential

public void DMPersistTokenCredential(TokenCredential credential)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMInvalidateTokenCredentials

public void DMInvalidateTokenCredentials(Long userId)
                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMReauthenticate

protected boolean DMReauthenticate(Credential credential,
                                   ConnectOptions options)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGrantAdmin

protected void DMGrantAdmin(Long userid)
                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetPrimaryUserProfile

protected S_LibraryObjectData DMGetPrimaryUserProfile(Long id)
                                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetDirectoryUserData

protected S_LibraryObjectData DMGetDirectoryUserData()
                                              throws IfsException

Invokes the identically-name remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetOurPrimaryUserProfile

protected S_LibraryObjectData DMGetOurPrimaryUserProfile()
                                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCalculateConsumedStorage

protected void DMCalculateConsumedStorage(Long id,
                                          Long classid)
                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetArrayTypeAttributeValue

protected AttributeValue DMGetArrayTypeAttributeValue(long objectId,
                                                      long attributeId,
                                                      Long priClassId,
                                                      int count)
                                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetMapTypeAttributeValue

protected AttributeValue DMGetMapTypeAttributeValue(int dataType,
                                                    long objectId,
                                                    long attributeId,
                                                    int count)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetArrayReferencingObjects

protected Vector DMGetArrayReferencingObjects(Long attributeId,
                                              AttributeValue referencedValue,
                                              SortSpecification sort)
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetResolvedClassObjectData

protected S_ClassObjectData DMGetResolvedClassObjectData(Long id)
                                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAttributesRsn

protected long DMGetAttributesRsn()
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAddMemberToDirectoryGroup

protected void DMAddMemberToDirectoryGroup(Long group_id,
                                           Long classid,
                                           Long rightObj,
                                           Long rightObjClassid)
                                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveMemberFromDirectoryGroup

protected void DMRemoveMemberFromDirectoryGroup(Long group_id,
                                                Long classid,
                                                Long rightObj,
                                                Long rightObjClassid)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAddMembersToDirectoryGroup

protected void DMAddMembersToDirectoryGroup(Long group_id,
                                            Long classid,
                                            Long[] rightObjIds,
                                            Long[] rightObjClassids)
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveMembersFromDirectoryGroup

protected void DMRemoveMembersFromDirectoryGroup(Long group_id,
                                                 Long classid,
                                                 Long[] rightObjIds,
                                                 Long[] rightObjClassids)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAllMembersOfDirectoryGroup

protected Long[] DMGetAllMembersOfDirectoryGroup(Long id,
                                                 Long classid,
                                                 boolean filterForDiscoverability)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetDirectMembersOfDirectoryGroup

protected Long[] DMGetDirectMembersOfDirectoryGroup(Long id,
                                                    Long userid,
                                                    boolean filterForDiscoverability)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsDirectMemberOfDirectoryGroup

protected boolean DMIsDirectMemberOfDirectoryGroup(Long groupId,
                                                   Long groupClassId,
                                                   Long userId,
                                                   Long userClassId)
                                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsMemberOfDirectoryGroup

protected boolean DMIsMemberOfDirectoryGroup(Long groupId,
                                             Long groupClassId,
                                             Long userId,
                                             Long userClassId)
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetCategoryIds

protected Long[] DMGetCategoryIds(Long id,
                                  Long classid)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAllAncestorsOfDirectoryObject

protected Long[] DMGetAllAncestorsOfDirectoryObject(Long id,
                                                    Long userid)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetDirectAncestorsOfDirectoryObject

protected Long[] DMGetDirectAncestorsOfDirectoryObject(Long id,
                                                       Long userid)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetMemberThreshold

protected int DMGetMemberThreshold()
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAncestorThreshold

protected int DMGetAncestorThreshold()
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsArrayInputsUsedForMemberSelection

protected boolean DMIsArrayInputsUsedForMemberSelection()
                                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsArrayInputsUsedForAncestorSelection

protected boolean DMIsArrayInputsUsedForAncestorSelection()
                                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetCompositeAclIds

protected Long[] DMGetCompositeAclIds(Long id,
                                      Long classid,
                                      SortSpecification sort)
                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetPublicObjectsReferringToLockObject

protected Vector DMGetPublicObjectsReferringToLockObject(Long id,
                                                         Long classid,
                                                         SortSpecification sort)
                                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsLockObjectShared

protected boolean DMIsLockObjectShared(Long id,
                                       Long classid)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetLockedForSessionObjects

protected Vector DMGetLockedForSessionObjects()
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCopyLibraryObject

protected S_LibraryObjectData DMCopyLibraryObject(Long id,
                                                  Long classId,
                                                  S_LibraryObjectDefinition sdef)
                                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetObjectReferenceAttribute

protected ObjectReferenceAttributeValue DMGetObjectReferenceAttribute(Long id,
                                                                      Long classId,
                                                                      String attrName)
                                                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMConvertToPrivateACL

protected S_LibraryObjectData DMConvertToPrivateACL(Long id,
                                                    Long classId,
                                                    S_LibraryObjectDefinition sdef)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewPublicObject

protected S_LibraryObjectData DMNewPublicObject(S_LibraryObjectDefinition def)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewSystemObject

protected S_LibraryObjectData DMNewSystemObject(S_LibraryObjectDefinition def)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewSimpleObject

protected S_LibraryObjectData DMNewSimpleObject(S_LibraryObjectDefinition def)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewSchemaObject

protected S_LibraryObjectData DMNewSchemaObject(S_LibraryObjectDefinition def)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetAttributes

protected S_LibraryObjectDefinition DMSetAttributes(Long id,
                                                    Long classId,
                                                    S_LibraryObjectDefinition def)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMLockRows

protected void DMLockRows(Long id,
                          Long classId)
                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMInvokeServerMethod

protected Serializable DMInvokeServerMethod(Long id,
                                            Long classId,
                                            String methodName,
                                            Serializable payload)
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMInvokeOperation

protected Object DMInvokeOperation(Long id,
                                   Long classId,
                                   OperationContext op)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDelete

protected void DMDelete(Long id,
                        Long classId,
                        S_LibraryObjectDefinition def)
                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMUndelete

protected void DMUndelete(Long id,
                          Long classId,
                          S_LibraryObjectDefinition def)
                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFree

protected void DMFree(Long id,
                      Long classId,
                      S_LibraryObjectDefinition def)
               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAddAttributeToClassObject

public Long DMAddAttributeToClassObject(Long id,
                                        S_LibraryObjectDefinition def)
                                 throws IfsException

Adds an Attribute to an existing ClassObject.

Parameters:

id - the ClassObject id

def - the Attribute definition

Returns:

the new Attribute id

Throws:

IfsException - (IFS-30820) if the operation fails

(Unpublished)

DMRemoveAttributeFromClassObject

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

Removes an Attribute from an existing ClassObject.

Parameters:

id - the Attribute id

def - a definition that influences how the attribute is removed, or null for default behavior

Throws:

IfsException - (IFS-30821) if the operation fails

(Unpublished)

DMfetchACEs

protected Long[] DMfetchACEs(Long id,
                             Long classId)
                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMaddAccessControlEntry

protected S_LibraryObjectData DMaddAccessControlEntry(Long id,
                                                      Long classId,
                                                      S_LibraryObjectDefinition sdef)
                                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveAccessControlEntry

protected void DMRemoveAccessControlEntry(Long id,
                                          Long classId,
                                          Long aceId,
                                          Long aceClassId)
                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMupdateAccessControlEntry

protected void DMupdateAccessControlEntry(Long id,
                                          Long classId,
                                          Long aceId,
                                          Long aceClassId,
                                          S_LibraryObjectDefinition sdef)
                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMremoveAllAccessControlEntries

protected void DMremoveAllAccessControlEntries(Long id,
                                               Long classId)
                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAccessLevel

protected AccessLevel DMGetAccessLevel(Long id,
                                       Long classId,
                                       Long userId)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetDiscoverabilityOfPublicObjectsIds

protected Long[] DMGetDiscoverabilityOfPublicObjectsIds(Long[] ids)
                                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMApplyFolderIndexDeferredUpdate

protected void DMApplyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetFolderIndexDeferredUpdates

protected Vector DMGetFolderIndexDeferredUpdates(int maxItems)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsAclIndexUpdateModeSynchronous

protected boolean DMIsAclIndexUpdateModeSynchronous()
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMApplyAclIndexDeferredUpdate

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

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAclIndexDeferredUpdates

protected Vector DMGetAclIndexDeferredUpdates(int maxItems)
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDeleteAclIndexDeferredUpdates

protected void DMDeleteAclIndexDeferredUpdates(Long[] ids)
                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetExpiredTimedLocks

protected Vector DMGetExpiredTimedLocks(int maxItems,
                                        int offset)
                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMReleaseExpiredLockObject

protected int DMReleaseExpiredLockObject(Long id,
                                         Long classId)
                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMResolveObjects

protected void DMResolveObjects(Long[] ids,
                                Long[] classIds,
                                ObjectResolverSpecification spec)
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFetchProperties

protected Vector DMFetchProperties(Long propertyBundleId,
                                   Long propertyBundleClassId)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetProperty

protected AttributeValue DMGetProperty(Long propertyBundleId,
                                       Long propertyBundleClassId,
                                       String propertyName)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFetchPolicyListElements

protected Vector DMFetchPolicyListElements(Long policyListId,
                                           Long policyListClassId)
                                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetEffectiveClassPolicyListElements

protected Vector DMGetEffectiveClassPolicyListElements(Long id,
                                                       Long classId,
                                                       String operation)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetEffectivePolicyListElements

protected Vector DMGetEffectivePolicyListElements(Long id,
                                                  Long classId,
                                                  String operation)
                                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetFolderReferences

protected Long[] DMGetFolderReferences(Long publicObject_id,
                                       Long classid,
                                       SortSpecification sort)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMListItems

protected Vector DMListItems(Long folder_id,
                             Long classid,
                             String folderRelClassname,
                             SortSpecification sort)
                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAddToFolder

protected void DMAddToFolder(Long folder_id,
                             Long classid,
                             Long rightObj,
                             Long rightObjClassid)
                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAddFolderRelationship

protected void DMAddFolderRelationship(Long id,
                                       Long classId,
                                       S_LibraryObjectDefinition def)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveFromFolder

protected void DMRemoveFromFolder(Long folder_id,
                                  Long classid,
                                  Long rightObj,
                                  Long rightObjClassid,
                                  S_LibraryObjectDefinition def)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFindPublicObjectByPath

protected S_LibraryObjectData DMFindPublicObjectByPath(Long folder_id,
                                                       Long classid,
                                                       String path)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCheckExistenceOfPublicObjectByPath

protected boolean DMCheckExistenceOfPublicObjectByPath(Long folder_id,
                                                       Long classid,
                                                       String path)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAnyFolderPath

protected String DMGetAnyFolderPath(Long id,
                                    Long classid,
                                    Long folderRefId,
                                    Long folderRefClassid,
                                    FolderPathOptions fpo,
                                    SortSpecification sort)
                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetAllFolderPaths

protected String[] DMGetAllFolderPaths(Long id,
                                       Long classid,
                                       Long folderRefId,
                                       Long folderRefClassid,
                                       FolderPathOptions fpo,
                                       SortSpecification sort)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetFolderItemCount

protected long DMGetFolderItemCount(Long folder_id,
                                    Long classId,
                                    String folderRelClassname)
                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFolderHasSubFolders

public boolean DMFolderHasSubFolders(Long folder_id,
                                     Long classId)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSubfolderCount

protected long DMGetSubfolderCount(Long folder_id,
                                   Long classId,
                                   String folderRelClassname)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMOpenFolder

protected void DMOpenFolder(Long folder_id,
                            Long classid,
                            String folderRelClassname,
                            SortSpecification sort)
                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNextFolderItem

protected S_LibraryObjectData DMNextFolderItem(Long folder_id,
                                               Long classid)
                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCloseFolder

protected void DMCloseFolder(Long folder_id,
                             Long classid)
                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetFolderItemList

protected Long[] DMGetFolderItemList(Long folder_id,
                                     Long classid,
                                     SortSpecification sort)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetTotalFolderItemCount

protected int DMGetTotalFolderItemCount(Long folder_id,
                                        Long classid)
                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMListSelectorItems

protected Vector DMListSelectorItems(String searchClass,
                                     String searchDefinition,
                                     boolean recursive,
                                     int maxItemCount,
                                     SortSpecification sort)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMListPreparedSelectorItems

protected Vector DMListPreparedSelectorItems(String statementKey,
                                             boolean distinct,
                                             AttributeValue searchTarget,
                                             AttributeValue[] auxSearchTargets,
                                             String[] bypassSecAliases,
                                             String joinCondition,
                                             String searchDefinition,
                                             boolean recursive,
                                             String language,
                                             int maxItemCount,
                                             int rowNumber,
                                             String hint,
                                             SortSpecification sort,
                                             AttributeValue[] bindValues)
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetPreparedSelectorResults

protected AttributeValueTable[] DMGetPreparedSelectorResults(String statementKey,
                                                             boolean distinct,
                                                             AttributeValue searchTarget,
                                                             AttributeValue[] auxSearchTargets,
                                                             ColumnDescriptor[] colDescs,
                                                             String[] bypassSecAliases,
                                                             String joinCondition,
                                                             String searchDefinition,
                                                             boolean recursive,
                                                             String language,
                                                             int maxItemCount,
                                                             int rowNumber,
                                                             String hint,
                                                             SortSpecification sort,
                                                             AttributeValue[] bindValues)
                                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetPreparedSelectorItemCount

protected int DMGetPreparedSelectorItemCount(String statementKey,
                                             boolean distinct,
                                             AttributeValue searchTarget,
                                             AttributeValue[] auxSearchTargets,
                                             String[] bypassSecAliases,
                                             String joinCondition,
                                             String searchDefinition,
                                             boolean recursive,
                                             String hint,
                                             AttributeValue[] bindValues)
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSelectorItemCount

protected long DMGetSelectorItemCount(String searchClass,
                                      String searchDefinition,
                                      boolean recursive)
                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMOpenSelector

protected long DMOpenSelector(String searchClass,
                              String searchDefinition,
                              boolean recursive,
                              SortSpecification sort)
                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNextSelectorItem

protected S_LibraryObjectData DMNextSelectorItem(long cursorId)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNextSelectorBatch

protected Vector DMNextSelectorBatch(long cursorId,
                                     int batchSize)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCloseSelector

protected void DMCloseSelector(long cursorId)
                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewSearch

protected Long DMNewSearch()
                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewSearchFromObject

protected Long DMNewSearchFromObject(Long srchObjId)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSearchSpecification

protected SearchSpecification DMGetSearchSpecification(Long srchId)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetSearchSpecification

protected void DMSetSearchSpecification(Long srchId,
                                        SearchSpecification sp)
                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMOpenSearch

protected void DMOpenSearch(Long id,
                            Vector bindValues,
                            String language,
                            int timeout)
                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMgetSearchItemCount

protected int DMgetSearchItemCount(Long id,
                                   Vector bindValues,
                                   String language,
                                   int timeout)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMgetSearchSQLString

protected String DMgetSearchSQLString(Long id)
                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNextSearchItems

protected Vector DMNextSearchItems(Long id,
                                   int batchCount)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCloseSearch

protected void DMCloseSearch(Long id)
                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDisposeSearch

protected void DMDisposeSearch(Long id)
                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCreateView

protected void DMCreateView(ViewSpecification vsp)
                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetPartitionValue

public Long DMGetPartitionValue(Long id,
                                Long classId)
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetLastAccessDate

public Date DMGetLastAccessDate(Long id,
                                Long classId)
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetContentStream

protected ContentStreamSerializer DMGetContentStream(Long id,
                                                     Long classId,
                                                     Long refObjId,
                                                     Long refObjClassId)
                                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetContentReader

protected ContentStreamSerializer DMGetContentReader(Long id,
                                                     Long classId,
                                                     Long refObjId,
                                                     Long refObjClassId)
                                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

clearRaciSessionContext

public void clearRaciSessionContext(RandomAccessContentInterface raci)
                             throws IfsException

Deprecated. CMSDK 10gR2: use RandomAccessor

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

reestablishRaciSessionContext

public void reestablishRaciSessionContext(RandomAccessContentInterface raci)
                                   throws IfsException

Deprecated. CMSDK 10gR2: use RandomAccessor

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetContentByRandomAccess

protected RandomAccessor DMGetContentByRandomAccess(Long coId,
                                                    Long coClassId,
                                                    Long refObjId,
                                                    Long refObjClassId)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMUpdateContentByRandomAccess

protected RandomAccessor DMUpdateContentByRandomAccess(Long docId,
                                                       Long docClassId,
                                                       S_LibraryObjectDefinition sdocdef,
                                                       Long expirationPeriod)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorGetDocumentId

protected Long DMRandomAccessorGetDocumentId(S_RandomAccessorImpl ra)
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorGetContentObjectId

protected Long DMRandomAccessorGetContentObjectId(S_RandomAccessorImpl ra)
                                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorSetSession

protected void DMRandomAccessorSetSession(S_RandomAccessorImpl ra)
                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorRead

protected int DMRandomAccessorRead(S_RandomAccessorImpl ra,
                                   long pos,
                                   byte[] b,
                                   int off,
                                   int len)
                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorIsWriteable

protected boolean DMRandomAccessorIsWriteable(S_RandomAccessorImpl ra)
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorWrite

protected void DMRandomAccessorWrite(S_RandomAccessorImpl ra,
                                     long pos,
                                     byte[] b,
                                     int off,
                                     int len)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorTruncate

protected void DMRandomAccessorTruncate(S_RandomAccessorImpl ra,
                                        long len)
                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorLength

protected long DMRandomAccessorLength(S_RandomAccessorImpl ra)
                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorDispose

protected void DMRandomAccessorDispose(S_RandomAccessorImpl ra)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRandomAccessorClose

protected void DMRandomAccessorClose(S_RandomAccessorImpl ra)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewContentStreamSerializer

protected ContentStreamSerializer DMNewContentStreamSerializer()
                                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsContentReadByUser

protected boolean DMIsContentReadByUser(Long id,
                                        Long classId)
                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsContextIndexEnabled

protected boolean DMIsContextIndexEnabled()
                                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMSetContentReadByUser

protected void DMSetContentReadByUser(Long id,
                                      Long classId,
                                      boolean readState,
                                      Long refObjId,
                                      Long refObjClassId)
                               throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRender

protected ContentStreamSerializer DMRender(Long id,
                                           Long classId,
                                           String rendererType,
                                           String rendererName,
                                           Hashtable options,
                                           boolean reader)
                                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsVersionable

protected boolean DMIsVersionable(Long id,
                                  Long classId)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsInstanceOfClassVersionable

protected boolean DMIsInstanceOfClassVersionable(Long classId)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMUnReserve

protected void DMUnReserve(Long id,
                           Long classId)
                    throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewRevision

protected S_LibraryObjectData DMNewRevision(Long id,
                                            Long classId,
                                            S_LibraryObjectDefinition def)
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMReserveNext

protected void DMReserveNext(Long id,
                             Long classId,
                             String contentPath,
                             String comment)
                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewVersionSeries

protected S_LibraryObjectData DMNewVersionSeries(Long id,
                                                 Long classId,
                                                 S_LibraryObjectDefinition def)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMNewBranchedVersionSeries

protected S_LibraryObjectData DMNewBranchedVersionSeries(Long id,
                                                         Long classId,
                                                         S_LibraryObjectDefinition def)
                                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIntegrateIntoVersionSeries

protected void DMIntegrateIntoVersionSeries(Long sid,
                                            Long sclassId,
                                            Long tid,
                                            Long tclassId)
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMfetchRevisions

protected Long[] DMfetchRevisions(Long id,
                                  Long classId)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMfetchVersionSerieses

protected Long[] DMfetchVersionSerieses(Long id,
                                        Long classId)
                                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetLinks

protected Long[] DMGetLinks(Long id,
                            Long classId)
                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMReassociateLinks

protected void DMReassociateLinks(Long oldId,
                                  Long oldClassId,
                                  Long newId,
                                  Long newClassId)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAddRelationship

protected S_LibraryObjectData DMAddRelationship(Long id,
                                                Long classId,
                                                S_LibraryObjectDefinition def)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRemoveRelationship

protected void DMRemoveRelationship(Long id,
                                    Long classId,
                                    Long relId,
                                    Long relClassId)
                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetRightwardRelationshipObjects

protected Vector DMGetRightwardRelationshipObjects(Long id,
                                                   Long classId,
                                                   Long relClassId,
                                                   SortSpecification sort)
                                            throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetLeftwardRelationshipObjects

protected Vector DMGetLeftwardRelationshipObjects(Long id,
                                                  Long classId,
                                                  Long relClassId,
                                                  SortSpecification sort)
                                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetRightwardRelationships

protected Vector DMGetRightwardRelationships(Long id,
                                             Long classId,
                                             Long relClassId,
                                             SortSpecification sort)
                                      throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetLeftwardRelationships

protected Vector DMGetLeftwardRelationships(Long id,
                                            Long classId,
                                            Long relClassId,
                                            SortSpecification sort)
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetLeftwardRelationshipsCount

protected long DMGetLeftwardRelationshipsCount(Long id,
                                               Long classId,
                                               Long relClassId)
                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMBeginTransaction

protected Transaction DMBeginTransaction(boolean writeable)
                                  throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCompleteTransaction

protected void DMCompleteTransaction(Transaction transaction)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAbortTransaction

protected void DMAbortTransaction(Transaction transaction)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCommit

protected void DMCommit()
                 throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMRollback

protected void DMRollback()
                   throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsTransactionInProgress

protected boolean DMIsTransactionInProgress()
                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMgetLibraryObjectData

protected S_LibraryObjectData DMgetLibraryObjectData(Long id,
                                                     Long classId,
                                                     String attributeName,
                                                     boolean selectFully)
                                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetPublicObjectData

protected S_LibraryObjectData DMGetPublicObjectData(Long id,
                                                    Long classId)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSystemObjectData

protected S_LibraryObjectData DMGetSystemObjectData(Long id,
                                                    Long classId)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSimpleObjectData

protected S_LibraryObjectData DMGetSimpleObjectData(Long id,
                                                    Long classId)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSchemaObjectData

protected S_LibraryObjectData DMGetSchemaObjectData(Long id,
                                                    Long classId)
                                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGenerateThemes

protected void DMGenerateThemes(Long contentId,
                                Long contentClassId,
                                boolean fullThemes,
                                Long refObjId,
                                Long refObjClassId)
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMAddManualTextIndexing

protected void DMAddManualTextIndexing(Long id,
                                       Long classId,
                                       ContentStreamSerializer css)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMEnqueueMessage

protected void DMEnqueueMessage(Long id,
                                Long classId,
                                oracle.sql.ORAData message)
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Parameters:

id - id of the Queue

classId - classId of the Queue

message - message to be enqueued

Throws:

IfsException - if the operation fails

(Unpublished)

DMEnqueueMessage

protected void DMEnqueueMessage(Long id,
                                Long classId,
                                oracle.sql.ORAData message,
                                String correlation)
                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

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)

DMGetConsumedStorage

protected long DMGetConsumedStorage(Long id,
                                    Long classId)
                             throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Parameters:

id - id of the object

classId - classId of the object

Returns:

storage consumed by the object

Throws:

IfsException - if the operation fails

(Unpublished)

DMDequeueMessage

protected oracle.sql.ORAData DMDequeueMessage(Long id,
                                              Long classId,
                                              String subscriberName)
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Parameters:

id - id of the Queue

classId - classId of the Queue

subscriberName - name of the subscriber dequeueing the message

Returns:

message if one is available; NULL otherwise.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDequeueMessageFromExceptionQueue

protected oracle.sql.ORAData DMDequeueMessageFromExceptionQueue(Long id,
                                                                Long classId)
                                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Parameters:

id - id of the Queue

classId - classId of the Queue

Returns:

message if one is available; NULL otherwise.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetThemes

protected ContextTheme[] DMGetThemes(Long contentId,
                                     Long contentClassId,
                                     Long refObjId,
                                     Long refObjClassId)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGenerateSummary

protected void DMGenerateSummary(Long contentId,
                                 Long contentClassId,
                                 String pointOfView,
                                 long sizeAsPercent,
                                 long sizeAsNumParagraphs,
                                 String summaryLevel,
                                 Long refObjId,
                                 Long refObjClassId)
                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSummary

protected ContentStreamSerializer DMGetSummary(Long contentId,
                                               Long contentClassId,
                                               String pointOfView,
                                               Long refObjId,
                                               Long refObjClassId)
                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMFilterContent

protected void DMFilterContent(Long contentId,
                               Long contentClassId,
                               boolean plaintext,
                               Long refObjId,
                               Long refObjClassId)
                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetSLibraryObjectDefinition

protected S_LibraryObjectDefinition DMGetSLibraryObjectDefinition(Long id,
                                                                  Long classId)
                                                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetIdsForNewObjects

protected Long[] DMGetIdsForNewObjects(int length)
                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetFilteredContent

protected ContentStreamSerializer DMGetFilteredContent(Long contentId,
                                                       Long contentClassId,
                                                       Long refObjId,
                                                       Long refObjClassId)
                                                throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetNLSDatabaseParameterValue

protected String DMGetNLSDatabaseParameterValue(String parameter)
                                         throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCreateDefaultPropertyBundle

protected S_LibraryObjectData DMCreateDefaultPropertyBundle(Long id,
                                                            Long classId)
                                                     throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCreateDefaultPolicyPropertyBundle

protected S_LibraryObjectData DMCreateDefaultPolicyPropertyBundle(Long id,
                                                                  Long classId)
                                                           throws IfsException

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

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMIsAttributeValueInValueDomain

protected boolean DMIsAttributeValueInValueDomain(Long id,
                                                  Long classId,
                                                  AttributeValue av)
                                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMCreateRetainedEventDatabaseObjects

public void DMCreateRetainedEventDatabaseObjects(RetainedEvent event)
                                          throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDropRetainedEventDatabaseObjects

public void DMDropRetainedEventDatabaseObjects(RetainedEvent event)
                                        throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMInsertRetainedEvent

public void DMInsertRetainedEvent(RetainedEvent event)
                           throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMDeleteRetainedEvent

protected void DMDeleteRetainedEvent(RetainedEvent event)
                              throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

DMGetRetainedEvents

protected RetainedEvent[] DMGetRetainedEvents(RetainedEvent event,
                                              int maxItems)
                                       throws IfsException

Invokes the identically-named remote S_LibrarySession method.

Throws:

IfsException - if the operation fails

(Unpublished)

getServerProperty

public final String getServerProperty(String key,
                                      String defaultValue)
                               throws IfsException

Gets the String value for the specified key in the server properties file.

Parameters:

key - the key

defaultValue - the default value if the key is invalid

Returns:

the value

Throws:

IfsException - if an error occurs

(Published)