Interface | osid.hold.rules.HoldRulesManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.hold.rules.HoldRulesProfile | |||
Description |
The hold rules manager provides access to hold rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getHoldEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.hold.rules.HoldEnablerLookupSession | a HoldEnablerLookupSession | |
Errors | 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 | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.hold.rules.HoldEnablerLookupSession | a HoldEnablerLookupSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId 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 | ||
Return | osid.hold.rules.HoldEnablerQuerySession | a HoldEnablerQuerySession | |
Errors | 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 | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.hold.rules.HoldEnablerQuerySession | a HoldEnablerQuerySession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId 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 | ||
Return | osid.hold.rules.HoldEnablerSearchSession | a HoldEnablerSearchSession | |
Errors | 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 | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.hold.rules.HoldEnablerSearchSession | a HoldEnablerSearchSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId 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 | ||
Return | osid.hold.rules.HoldEnablerAdminSession | a HoldEnablerAdminSession | |
Errors | 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 | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.hold.rules.HoldEnablerAdminSession | a HoldEnablerAdminSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId 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 | ||
Parameters | osid.hold.rules.HoldEnablerReceiver | holdEnablerReceiver | the notification callback |
Return | osid.hold.rules.HoldEnablerNotificationSession | a HoldEnablerNotificationSession | |
Errors | NULL_ARGUMENT | holdEnablerReceiver 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 | ||
Parameters | osid.hold.rules.HoldEnablerReceiver | holdEnablerReceiver | the notification callback |
osid.id.Id | oublietteId | the Id of the Oubliette | |
Return | osid.hold.rules.HoldEnablerNotificationSession | a HoldEnablerNotificationSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | holdEnablerReceiver or oublietteId 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 | ||
Return | osid.hold.rules.HoldEnablerOublietteSession | a HoldEnablerOublietteSession | |
Errors | 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 | ||
Return | osid.hold.rules.HoldEnablerOublietteAssignmentSession | a HoldEnablerOublietteAssignmentSession | |
Errors | 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 | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.hold.rules.HoldEnablerSmartOublietteSession | a HoldEnablerSmartOublietteSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldEnablerSmartOubliette() is false | ||
Compliance | optional | This method must be implemented if
supportsHoldEnablerSmartOubliette() is true. | |
Method | getHoldEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.hold.rules.HoldEnablerRuleLookupSession | a HoldEnablerRuleSession | |
Errors | 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 | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.hold.rules.HoldEnablerRuleLookupSession | a HoldEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId 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 | ||
Return | osid.hold.rules.HoldEnablerRuleApplicationSession | a HoldEnablerRuleApplicationSession | |
Errors | 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 | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.hold.rules.HoldEnablerRuleApplicationSession | a HoldEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId 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. |