OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldRulesProxyManager
Implementsosid.OsidProxyManager
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
MethodgetHoldEnablerLookupSession
Description

Gets the OsidSession associated with the hold enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerLookupSessiona HoldEnablerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerLookup() is true.
MethodgetHoldEnablerLookupSessionForOubliette
Description

Gets the OsidSession associated with the hold enabler lookup service for the given oubliette.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerLookupSessiona HoldEnablerLookupSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerLookup() and supportsVisibleFederation() are true.
MethodgetHoldEnablerQuerySession
Description

Gets the OsidSession associated with the hold enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerQuerySessiona HoldEnablerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerQuery() is true.
MethodgetHoldEnablerQuerySessionForOubliette
Description

Gets the OsidSession associated with the hold enabler query service for the given oubliette.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerQuerySessiona HoldEnablerQuerySession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerQuery() and supportsVisibleFederation() are true.
MethodgetHoldEnablerSearchSession
Description

Gets the OsidSession associated with the hold enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerSearchSessiona HoldEnablerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerSearch() is true.
MethodgetHoldEnablerSearchSessionForOubliette
Description

Gets the OsidSession associated with the hold enablers earch service for the given oubliette.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerSearchSessiona HoldEnablerSearchSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerSearch() and supportsVisibleFederation() are true.
MethodgetHoldEnablerAdminSession
Description

Gets the OsidSession associated with the hold enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerAdminSessiona HoldEnablerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerAdmin() is true.
MethodgetHoldEnablerAdminSessionForOubliette
Description

Gets the OsidSession associated with the hold enabler administration service for the given oubliette.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerAdminSessiona HoldEnablerAdminSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetHoldEnablerNotificationSession
Description

Gets the OsidSession associated with the hold enabler notification service.

Parametersosid.hold.rules.HoldEnablerReceiverholdEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerNotificationSessiona HoldEnablerNotificationSession
ErrorsNULL_ARGUMENT holdEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerNotification() is true.
MethodgetHoldEnablerNotificationSessionForOubliette
Description

Gets the OsidSession associated with the hold enabler notification service for the given oubliette.

Parametersosid.hold.rules.HoldEnablerReceiverholdEnablerReceiverthe notification callback
osid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerNotificationSessiona HoldEnablerNotificationSession
ErrorsNOT_FOUNDno oubliette found by the given Id
NULL_ARGUMENT holdEnablerReceiver, oublietteId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerNotification() and supportsVisibleFederation() are true.
MethodgetHoldEnablerOublietteSession
Description

Gets the OsidSession to lookup hold enabler/oubliette mappings for hold enablers.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerOublietteSessiona HoldEnablerSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerOubliette() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerOubliette() is true.
MethodgetHoldEnablerOublietteAssignmentSession
Description

Gets the OsidSession associated with assigning hold enablers to oubliettes

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerOublietteAssignmentSessiona HoldEnablerOublietteAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerOublietteAssignment() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerOublietteAssignment() is true.
MethodgetHoldEnablerSmartOublietteSession
Description

Gets the OsidSession to manage hold enabler smart oubliettes.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerSmartOublietteSessiona HoldEnablerSmartOublietteSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerSmartOubliette() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerSmarOubliette() is true.
MethodgetHoldEnablerRuleLookupSession
Description

Gets the OsidSession associated with the hold enabler mapping lookup service for looking up the rules applied to the hold.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerRuleLookupSessiona HoldEnablerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerRuleLookup() is true.
MethodgetHoldEnablerRuleLookupSessionForOubliette
Description

Gets the OsidSession associated with the hold enabler mapping lookup service for the given hold for looking up rules applied to a hold.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerRuleLookupSessiona HoldEnablerRuleLookupSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetHoldEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the hold enabler assignment service to apply enablers to holds.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerRuleApplicationSessiona HoldEnablerRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerRuleApplication() is true.
MethodgetHoldEnablerRuleApplicationSessionForOubliette
Description

Gets the OsidSession associated with the hold enabler assignment service for the given hold to apply enablers to holds.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
osid.proxy.Proxyproxya proxy
Returnosid.hold.rules.HoldEnablerRuleApplicationSessiona HoldEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldEnablerRuleApplication() and supportsVisibleFederation() are true.