Interface CatalogingManager

All Superinterfaces:

AutoCloseable, CatalogingProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

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.

CatalogingManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface CatalogingProfile

getCatalogRecordTypes, getCatalogSearchRecordTypes, supportsCatalog, supportsCatalogAdmin, supportsCatalogAssignment, supportsCatalogEntryNotification, supportsCatalogHierarchy, supportsCatalogHierarchyDesign, supportsCatalogingRules, supportsCatalogLookup, supportsCatalogNotification, supportsCatalogQuery, supportsCatalogRecordType, supportsCatalogSearch, supportsCatalogSearchRecordType, supportsVisibleFederation

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getCatalogSession

CatalogSession getCatalogSession()
                          throws OperationFailedException

Gets the cataloging session for retrieving mappings to catalogs.

Returns:

a CatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalog()} is {@code true}.

getCatalogAssignmentSession

CatalogAssignmentSession getCatalogAssignmentSession()
                                              throws OperationFailedException

Gets the cataloging session for adding and removing mappings to catalogs.

Returns:

a CatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogAssignment()} is {@code true}.

getCatalogEntryNotificationSession

CatalogEntryNotificationSession getCatalogEntryNotificationSession(CatalogEntryReceiver catalogEntryReceiver)
                                                            throws OperationFailedException

Gets the notification session for subscribing to changes to catalogs.

Parameters:

catalogEntryReceiver - the notification callback

Returns:

a CatalogEntryNotificationSession

Throws:

NullArgumentException - catalogEntryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEntryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogEntryNotification()} is {@code true}.

getCatalogEntryNotificationSessionForCatalog

CatalogEntryNotificationSession getCatalogEntryNotificationSessionForCatalog(CatalogEntryReceiver catalogEntryReceiver,
 Id catalogId)
                                                                      throws OperationFailedException

Gets the notification session for subscribing to changes to catalogs for the given catalog.

Parameters:

catalogEntryReceiver - the notification callback

catalogId - the Id of the Catalog

Returns:

a CatalogEntryNotificationSession

Throws:

NullArgumentException - catalogEntryReceiver or catalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogEntryNotification()} and {@code supportsVisibleFederation()} are {@code true}

getCatalogLookupSession

CatalogLookupSession getCatalogLookupSession()
                                      throws OperationFailedException

Gets the catalog lookup session.

Returns:

a CatalogLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogLookup()} is {@code true}.

getCatalogQuerySession

CatalogQuerySession getCatalogQuerySession()
                                    throws OperationFailedException

Gets the catalog query session.

Returns:

a CatalogQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogQuery()} is {@code true}.

getCatalogSearchSession

CatalogSearchSession getCatalogSearchSession()
                                      throws OperationFailedException

Gets the catalog search session.

Returns:

a CatalogSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogSearch()} is {@code true}.

getCatalogAdminSession

CatalogAdminSession getCatalogAdminSession()
                                    throws OperationFailedException

Gets the catalog administrative session for creating, updating and deleting catalogs.

Returns:

a CatalogAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogAdmin()} is {@code true}.

getCatalogNotificationSession

CatalogNotificationSession getCatalogNotificationSession(CatalogReceiver catalogReceiver)
                                                  throws OperationFailedException

Gets the notification session for subscribing to changes to catalogs.

Parameters:

catalogReceiver - the notification callback

Returns:

a CatalogNotificationSession

Throws:

NullArgumentException - catalogReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogNotification()} is {@code true}.

getCatalogHierarchySession

CatalogHierarchySession getCatalogHierarchySession()
                                            throws OperationFailedException

Gets the catalog hierarchy traversal session.

Returns:

a CatalogHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogHierarchy()} is {@code true}.

getCatalogHierarchyDesignSession

CatalogHierarchyDesignSession getCatalogHierarchyDesignSession()
                                                        throws OperationFailedException

Gets the catalog hierarchy design session.

Returns:

a CatalogHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogHierarchyDesign()} is {@code true}.

getCatalogingRulesManager

CatalogingRulesManager getCatalogingRulesManager()
                                          throws OperationFailedException

Gets the cataloging rules manager.

Returns:

a CatalogingRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogingRules() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogingRules()} is {@code true}.