OSID - osid.hold.rules.HoldRulesProxyManager Service Interface Definition

Interface	osid.hold.rules.HoldRulesProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.hold.rules.HoldRulesProfile`
Description	The hold rules proxy manager provides access to hold rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a `Proxy` for passing information from server environments. The sessions included in this manager are: `HoldEnablerLookupSession:` a session to retrieve hold enablers `HoldEnablerQuerySession:` a session to query for hold enablers `HoldEnablerSearchSession:` a session to search for hold enablers `HoldEnablerAdminSession:` a session to create and delete hold enablers `HoldEnablerNotificationSession:` a session to receive notifications pertaining to hold enabler changes `HoldEnablerOublietteSession:` a session to look up hold enabler oubliette mappings `HoldEnablerOublietteAssignmentSession:` a session to manage hold enabler to oubliette mappings `HoldEnablerSmartOublietteSession:` a session to manage dynamic oubliettes of hold enablers `HoldEnablerRuleLookupSession:` a session to look up hold enabler to hold mappings `HoldEnablerRuleApplicationSession:` a session to apply hold enablers to holds
Method	getHoldEnablerLookupSession
Description	Gets the `OsidSession` associated with the hold enabler lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerLookupSession`		a `HoldEnablerLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerLookup()` is `true.`
Method	getHoldEnablerLookupSessionForOubliette
Description	Gets the `OsidSession` associated with the hold enabler lookup service for the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerLookupSession`		a `HoldEnablerLookupSession`
Errors	NOT_FOUND		no `Oubliette` found by the given `Id`
	NULL_ARGUMENT		`oublietteId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getHoldEnablerQuerySession
Description	Gets the `OsidSession` associated with the hold enabler query service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerQuerySession`		a `HoldEnablerQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerQuery()` is `true.`
Method	getHoldEnablerQuerySessionForOubliette
Description	Gets the `OsidSession` associated with the hold enabler query service for the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerQuerySession`		a `HoldEnablerQuerySession`
Errors	NOT_FOUND		no `Oubliette` found by the given `Id`
	NULL_ARGUMENT		`oublietteId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getHoldEnablerSearchSession
Description	Gets the `OsidSession` associated with the hold enabler search service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerSearchSession`		a `HoldEnablerSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerSearch()` is `true.`
Method	getHoldEnablerSearchSessionForOubliette
Description	Gets the `OsidSession` associated with the hold enablers earch service for the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerSearchSession`		a `HoldEnablerSearchSession`
Errors	NOT_FOUND		no `Oubliette` found by the given `Id`
	NULL_ARGUMENT		`oublietteId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getHoldEnablerAdminSession
Description	Gets the `OsidSession` associated with the hold enabler administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerAdminSession`		a `HoldEnablerAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerAdmin()` is `true.`
Method	getHoldEnablerAdminSessionForOubliette
Description	Gets the `OsidSession` associated with the hold enabler administration service for the given oubliette.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerAdminSession`		a `HoldEnablerAdminSession`
Errors	NOT_FOUND		no `Oubliette` found by the given `Id`
	NULL_ARGUMENT		`oublietteId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getHoldEnablerNotificationSession
Description	Gets the `OsidSession` associated with the hold enabler notification service.
Parameters	`osid.hold.rules.HoldEnablerReceiver`	`holdEnablerReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerNotificationSession`		a `HoldEnablerNotificationSession`
Errors	NULL_ARGUMENT		`holdEnablerReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerNotification()` is `true.`
Method	getHoldEnablerNotificationSessionForOubliette
Description	Gets the `OsidSession` associated with the hold enabler notification service for the given oubliette.
Parameters	`osid.hold.rules.HoldEnablerReceiver`	`holdEnablerReceiver`	the notification callback
	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerNotificationSession`		a `HoldEnablerNotificationSession`
Errors	NOT_FOUND		no oubliette found by the given `Id`
	NULL_ARGUMENT		`holdEnablerReceiver, oublietteId,` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getHoldEnablerOublietteSession
Description	Gets the `OsidSession` to lookup hold enabler/oubliette mappings for hold enablers.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerOublietteSession`		a `HoldEnablerSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerOubliette()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerOubliette()` is `true.`
Method	getHoldEnablerOublietteAssignmentSession
Description	Gets the `OsidSession` associated with assigning hold enablers to oubliettes
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerOublietteAssignmentSession`		a `HoldEnablerOublietteAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerOublietteAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerOublietteAssignment()` is `true.`
Method	getHoldEnablerSmartOublietteSession
Description	Gets the `OsidSession` to manage hold enabler smart oubliettes.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerSmartOublietteSession`		a `HoldEnablerSmartOublietteSession`
Errors	NOT_FOUND		no `Oubliette` found by the given `Id`
	NULL_ARGUMENT		`oublietteId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerSmartOubliette()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerSmarOubliette()` is `true.`
Method	getHoldEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the hold enabler mapping lookup service for looking up the rules applied to the hold.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerRuleLookupSession`		a `HoldEnablerRuleLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerRuleLookup()` is `true.`
Method	getHoldEnablerRuleLookupSessionForOubliette
Description	Gets the `OsidSession` associated with the hold enabler mapping lookup service for the given hold for looking up rules applied to a hold.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerRuleLookupSession`		a `HoldEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Oubliette` found by the given `Id`
	NULL_ARGUMENT		`oublietteId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getHoldEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the hold enabler assignment service to apply enablers to holds.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerRuleApplicationSession`		a `HoldEnablerRuleApplicationSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerRuleApplication()` is `true.`
Method	getHoldEnablerRuleApplicationSessionForOubliette
Description	Gets the `OsidSession` associated with the hold enabler assignment service for the given hold to apply enablers to holds.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.hold.rules.HoldEnablerRuleApplicationSession`		a `HoldEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Oubliette` found by the given `Id`
	NULL_ARGUMENT		`oublietteId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsHoldEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`