OSID - osid.cataloging.rules.CatalogingRulesManager Service Interface Definition

Interface	osid.cataloging.rules.CatalogingRulesManager
Implements	`osid.OsidManager`
Implements	`osid.cataloging.rules.CatalogingRulesProfile`
Used By	`osid.cataloging.CatalogingManager`
Description	The catalogingrules manager provides access to cataloging rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `CatalogEnablerLookupSession`: a session to retrieve catalog enablers `CatalogEnablerQuerySession`: a session to query for catalog enablers `CatalogEnablerSearchSession`: a session to search for catalog enablers `CatalogEnablerAdminSession`: a session to create and delete catalog enablers `CatalogEnablerNotificationSession`: a session to receive notifications pertaining to catalog enabler changes `CatalogEnablerCatalogSession`: a session to look up catalog enabler catalog mappings `CatalogEnablerCatalogAssignmentSession`: a session to manage catalog enabler to catalog mappings `CatalogEnablerSmartCatalogSession`: a session to manage dynamic catalogs of catalog enablers `CatalogEnableRuleLookupSession`: a session to look up catalog enabler to catalog mappings `CatalogEnablerRuleApplicationSession`: a session to apply catalog enablers to catalogs `CatalogingRulesManager` may be accessed by multiple processing threads.
Method	getCatalogEnablerLookupSession
Description	Gets the `OsidSession` associated with the catalog enabler lookup service.
Return	`osid.cataloging.rules.CatalogEnablerLookupSession`		a `CatalogEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerLookup()` is `true`.
Method	getCatalogEnablerLookupSessionForCatalog
Description	Gets the `OsidSession` associated with the catalog enabler lookup service for the given catalog.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerLookupSession`		a `CatalogEnablerLookupSession`
Errors	NOT_FOUND		no `Catalog` found by the given `Id`
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerLookup()` and `supportsVisibleFederation()` are `true`.
Method	getCatalogEnablerQuerySession
Description	Gets the `OsidSession` associated with the catalog enabler query service.
Return	`osid.cataloging.rules.CatalogEnablerQuerySession`		a `CatalogEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerQuery()` is `true`.
Method	getCatalogEnablerQuerySessionForCatalog
Description	Gets the `OsidSession` associated with the catalog enabler query service for the given catalog.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerQuerySession`		a `CatalogEnablerQuerySession`
Errors	NOT_FOUND		no `Catalog` found by the given `Id`
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerQuery()` and `supportsVisibleFederation()` are `true`.
Method	getCatalogEnablerSearchSession
Description	Gets the `OsidSession` associated with the catalog enabler search service.
Return	`osid.cataloging.rules.CatalogEnablerSearchSession`		a `CatalogEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerSearch()` is `true`.
Method	getCatalogEnablerSearchSessionForCatalog
Description	Gets the `OsidSession` associated with the catalog enablers earch service for the given catalog.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerSearchSession`		a `CatalogEnablerSearchSession`
Errors	NOT_FOUND		no `Catalog` found by the given `Id`
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerSearch()` and `supportsVisibleFederation()` are `true`.
Method	getCatalogEnablerAdminSession
Description	Gets the `OsidSession` associated with the catalog enabler administration service.
Return	`osid.cataloging.rules.CatalogEnablerAdminSession`		a `CatalogEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerAdmin()` is `true`.
Method	getCatalogEnablerAdminSessionForCatalog
Description	Gets the `OsidSession` associated with the catalog enabler administration service for the given catalog.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerAdminSession`		a `CatalogEnablerAdminSession`
Errors	NOT_FOUND		no `Catalog` found by the given `Id`
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerAdmin()` and `supportsVisibleFederation()` are `true`.
Method	getCatalogEnablerNotificationSession
Description	Gets the `OsidSession` associated with the catalog enabler notification service.
Parameters	`osid.cataloging.rules.CatalogEnablerReceiver`	`catalogEnablerReceiver`	the notification callback
Return	`osid.cataloging.rules.CatalogEnablerNotificationSession`		a `CatalogEnablerNotificationSession`
Errors	NULL_ARGUMENT		`catalogEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerNotification()` is `true`.
Method	getCatalogEnablerNotificationSessionForCatalog
Description	Gets the `OsidSession` associated with the catalog enabler notification service for the given catalog.
Parameters	`osid.cataloging.rules.CatalogEnablerReceiver`	`catalogEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerNotificationSession`		a `CatalogEnablerNotificationSession`
Errors	NOT_FOUND		no catalog found by the given `Id`
	NULL_ARGUMENT		`catalogEnablerReceiver` or `catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerNotification()` and `supportsVisibleFederation()` are `true`.
Method	getCatalogEnablerCatalogSession
Description	Gets the `OsidSession` to lookup catalog enabler/catalog mappings for cataloging enablers.
Return	`osid.cataloging.rules.CatalogEnablerCatalogSession`		a `CatalogEnablerCatalogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerCatalog()` is `true`.
Method	getCatalogEnablerCatalogAssignmentSession
Description	Gets the `OsidSession` associated with assigning catalog enablers to catalogs for cataloging.
Return	`osid.cataloging.rules.CatalogEnablerCatalogAssignmentSession`		a `CatalogEnablerCatalogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerCatalogAssignment()` is `true`.
Method	getCatalogEnablerSmartCatalogSession
Description	Gets the `OsidSession` to manage catalog enabler smart catalogs.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerSmartCatalogSession`		a `CatalogEnablerSmartCatalogSession`
Errors	NOT_FOUND		no `Catalog` found by the given `Id`
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerSmartCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerSmartCatalog()` is `true`.
Method	getCatalogEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the catalog enabler mapping lookup service for looking up the rules applied to the catalog.
Return	`osid.cataloging.rules.CatalogEnablerRuleLookupSession`		a `CatalogEnablerRuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerRuleLookup()` is `true`.
Method	getCatalogEnablerRuleLookupSessionForCatalog
Description	Gets the `OsidSession` associated with the catalog enabler mapping lookup service for the given catalog for looking up rules applied to a catalog.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerRuleLookupSession`		a `CatalogEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Catalog` found by the given `Id`
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerRuleLookup()` and `supportsVisibleFederation()` are `true`.
Method	getCatalogEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the catalog enabler assignment service to apply enablers to catalogs.
Return	`osid.cataloging.rules.CatalogEnablerRuleApplicationSession`		a `CatalogEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCatalogEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerRuleApplication()` is `true`.
Method	getCatalogEnablerRuleApplicationSessionForCatalog
Description	Gets the `OsidSession` associated with the catalog enabler assignment service for the given catalog to apply enablers to catalogs.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.rules.CatalogEnablerRuleApplicationSession`		a `CatalogEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Catalog` found by the given `Id`
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCatalogEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogEnablerRuleApplication()` and `supportsVisibleFederation()` are `true`.