OSID - osid.cataloging.CatalogingManager Service Interface Definition

Interface	osid.cataloging.CatalogingManager
Implements	`osid.OsidManager`
Implements	`osid.cataloging.CatalogingProfile`
Description	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.
Method	getCatalogSession
Description	Gets the cataloging session for retrieving mappings to catalogs.
Return	`osid.cataloging.CatalogSession`		a `CatalogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalog()` is `true.`
Method	getCatalogAssignmentSession
Description	Gets the cataloging session for adding and removing mappings to catalogs.
Return	`osid.cataloging.CatalogAssignmentSession`		a `CatalogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogAssignment()` is `true.`
Method	getCatalogEntryNotificationSession
Description	Gets the notification session for subscribing to changes to catalogs.
Parameters	`osid.cataloging.CatalogEntryReceiver`	`catalogEntryReceiver`	the notification callback
Return	`osid.cataloging.CatalogEntryNotificationSession`		a `CatalogEntryNotificationSession`
Errors	NULL_ARGUMENT		`catalogEntryReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEntryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEntryNotification()` is `true.`
Method	getCatalogEntryNotificationSessionForCatalog
Description	Gets the notification session for subscribing to changes to catalogs for the given catalog.
Parameters	`osid.cataloging.CatalogEntryReceiver`	`catalogEntryReceiver`	the notification callback
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.CatalogEntryNotificationSession`		a `CatalogEntryNotificationSession`
Errors	NULL_ARGUMENT		`catalogEntryReceiver` or `catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEntryNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEntryNotification()` and `supportsVisibleFederation()` are `true`
Method	getCatalogLookupSession
Description	Gets the catalog lookup session.
Return	`osid.cataloging.CatalogLookupSession`		a `CatalogLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogLookup()` is `true.`
Method	getCatalogQuerySession
Description	Gets the catalog query session.
Return	`osid.cataloging.CatalogQuerySession`		a `CatalogQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogQuery()` is `true.`
Method	getCatalogSearchSession
Description	Gets the catalog search session.
Return	`osid.cataloging.CatalogSearchSession`		a `CatalogSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogSearch()` is `true.`
Method	getCatalogAdminSession
Description	Gets the catalog administrative session for creating, updating and deleting catalogs.
Return	`osid.cataloging.CatalogAdminSession`		a `CatalogAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogAdmin()` is `true.`
Method	getCatalogNotificationSession
Description	Gets the notification session for subscribing to changes to catalogs.
Parameters	`osid.cataloging.CatalogReceiver`	`catalogReceiver`	the notification callback
Return	`osid.cataloging.CatalogNotificationSession`		a `CatalogNotificationSession`
Errors	NULL_ARGUMENT		`catalogReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogNotification()` is `true.`
Method	getCatalogHierarchySession
Description	Gets the catalog hierarchy traversal session.
Return	`osid.cataloging.CatalogHierarchySession`		a `CatalogHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogHierarchy()` is `true.`
Method	getCatalogHierarchyDesignSession
Description	Gets the catalog hierarchy design session.
Return	`osid.cataloging.CatalogHierarchyDesignSession`		a `CatalogHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogHierarchyDesign()` is `true.`
Method	getCatalogingRulesManager
Description	Gets the cataloging rules manager.
Return	`osid.cataloging.rules.CatalogingRulesManager`		a `CatalogingRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogingRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogingRules()` is `true.`