public interface CatalogingManager extends OsidManager, CatalogingProfile
The cataloging manager provides access to cataloging sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
CatalogSession:
a session to lookup mappings to
catalogs CatalogAssignmentSession:
a session to manage Id
to Catalog mappings CatalogEntryNotificationSession:
a session to
receive notification of changed mappings CatalogLookupSession:
a session to retrieve
catalogs CatalogQuerySession:
a session to query catalogs
CatalogSearchSession:
a session to search for
catalogs CatalogAdminSession:
a session to create, update
and delete catalogs CatalogNotificationSession:
a session to receive
notifications for changes in catalogs CatalogHierarchyTraversalSession:
a session to
traverse hierarchies of catalogs CatalogHierarchyDesignSession:
a session to manage
hierarchues of catalogs The cataloging manager also provides a profile for determing the supported search types supported by this service.
Modifier and Type | Method and Description |
---|---|
CatalogAdminSession |
getCatalogAdminSession()
Gets the catalog administrative session for creating, updating and
deleting catalogs.
|
CatalogAssignmentSession |
getCatalogAssignmentSession()
Gets the cataloging session for adding and removing mappings to
catalogs.
|
CatalogEntryNotificationSession |
getCatalogEntryNotificationSession(CatalogEntryReceiver catalogEntryReceiver)
Gets the notification session for subscribing to changes to catalogs.
|
CatalogEntryNotificationSession |
getCatalogEntryNotificationSessionForCatalog(CatalogEntryReceiver catalogEntryReceiver,
Id catalogId)
Gets the notification session for subscribing to changes to catalogs
for the given catalog.
|
CatalogHierarchyDesignSession |
getCatalogHierarchyDesignSession()
Gets the catalog hierarchy design session.
|
CatalogHierarchySession |
getCatalogHierarchySession()
Gets the catalog hierarchy traversal session.
|
CatalogingRulesManager |
getCatalogingRulesManager()
Gets the cataloging rules manager.
|
CatalogLookupSession |
getCatalogLookupSession()
Gets the catalog lookup session.
|
CatalogNotificationSession |
getCatalogNotificationSession(CatalogReceiver catalogReceiver)
Gets the notification session for subscribing to changes to catalogs.
|
CatalogQuerySession |
getCatalogQuerySession()
Gets the catalog query session.
|
CatalogSearchSession |
getCatalogSearchSession()
Gets the catalog search session.
|
CatalogSession |
getCatalogSession()
Gets the cataloging session for retrieving mappings to catalogs.
|
changeBranch, initialize, rollbackService
close
getCatalogRecordTypes, getCatalogSearchRecordTypes, supportsCatalog, supportsCatalogAdmin, supportsCatalogAssignment, supportsCatalogEntryNotification, supportsCatalogHierarchy, supportsCatalogHierarchyDesign, supportsCatalogingRules, supportsCatalogLookup, supportsCatalogNotification, supportsCatalogQuery, supportsCatalogRecordType, supportsCatalogSearch, supportsCatalogSearchRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CatalogSession getCatalogSession() throws OperationFailedException
CatalogSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCatalog()
is false
optional
- This method must be implemented if
supportsCatalog()
is true.
CatalogAssignmentSession getCatalogAssignmentSession() throws OperationFailedException
CatalogAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogAssignment()
is false
optional
- This method must be implemented if
supportsCatalogAssignment()
is true.
CatalogEntryNotificationSession getCatalogEntryNotificationSession(CatalogEntryReceiver catalogEntryReceiver) throws OperationFailedException
catalogEntryReceiver
- the notification callback CatalogEntryNotificationSession
NullArgumentException
- catalogEntryReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEntryNotification()
is false
optional
- This method must be implemented if
supportsCatalogEntryNotification()
is true.
CatalogEntryNotificationSession getCatalogEntryNotificationSessionForCatalog(CatalogEntryReceiver catalogEntryReceiver, Id catalogId) throws OperationFailedException
catalogEntryReceiver
- the notification callbackcatalogId
- the Id
of the Catalog
CatalogEntryNotificationSession
NullArgumentException
- catalogEntryReceiver
or catalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEntryNotification()
and
supportsVisibleFederation()
are true
CatalogLookupSession getCatalogLookupSession() throws OperationFailedException
CatalogLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCatalogLookup()
is false
optional
- This method must be implemented if
supportsCatalogLookup()
is true.
CatalogQuerySession getCatalogQuerySession() throws OperationFailedException
CatalogQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCatalogQuery()
is false
optional
- This method must be implemented if
supportsCatalogQuery()
is true.
CatalogSearchSession getCatalogSearchSession() throws OperationFailedException
CatalogSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCatalogSearch()
is false
optional
- This method must be implemented if
supportsCatalogSearch()
is true.
CatalogAdminSession getCatalogAdminSession() throws OperationFailedException
CatalogAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCatalogAdmin()
is false
optional
- This method must be implemented if
supportsCatalogAdmin()
is true.
CatalogNotificationSession getCatalogNotificationSession(CatalogReceiver catalogReceiver) throws OperationFailedException
catalogReceiver
- the notification callback CatalogNotificationSession
NullArgumentException
- catalogReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogNotification()
is false
optional
- This method must be implemented if
supportsCatalogNotification()
is true.
CatalogHierarchySession getCatalogHierarchySession() throws OperationFailedException
CatalogHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogHierarchy()
is false
optional
- This method must be implemented if
supportsCatalogHierarchy()
is true.
CatalogHierarchyDesignSession getCatalogHierarchyDesignSession() throws OperationFailedException
CatalogHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogHierarchyDesign()
is false
optional
- This method must be implemented if
supportsCatalogHierarchyDesign()
is true.
CatalogingRulesManager getCatalogingRulesManager() throws OperationFailedException
CatalogingRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogingRules()
is false
optional
- This method must be implemented if
supportsCatalogingRules()
is true.