Interface | osid.hold.HoldProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.hold.HoldProfile | |||
Description |
The hold proxy manager provides access to rules sessions
and provides interoperability tests for various aspects of
this service. Methods in this manager pass a
| ||
Method | getBlockSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.BlockSession | a BlockSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlock() is false | ||
Compliance | optional | This method must be implemented if supportsBlock() is
true. | |
Method | getBlockSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockSession | a BlockSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlock() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBlock() and
supportsVisibleFederation() are true | |
Method | getMyHoldSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.MyHoldSession | a MyHoldSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyHold() is false | ||
Compliance | optional | This method must be implemented if supportsMyHold() is
true. | |
Method | getMyHoldSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.MyHoldSession | a MyHoldSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyHold() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsMyHold() and
supportsVisibleFederation() are true | |
Method | getBlockLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.BlockLookupSession | a BlockLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBlockLookup() is
true. | |
Method | getBlockLookupSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockLookupSession | a BlockLookupSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBlockLookup() and
supportsVisibleFederation() are true | |
Method | getBlockQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.BlockQuerySession | a BlockQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBlockQuery() is
true. | |
Method | getBlockQuerySessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockQuerySession | a BlockQuerySession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBlockQuery() and
supportsVisibleFederation() are true | |
Method | getBlockSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.BlockSearchSession | a BlockSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBlockSearch() is
true. | |
Method | getBlockSearchSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockSearchSession | a BlockSearchSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBlockSearch() and
supportsVisibleFederation() are true | |
Method | getBlockAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.BlockAdminSession | a BlockAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBlockAdmin() is
true. | |
Method | getBlockAdminSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockAdminSession | a BlockAdminSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBlockAdmin() and
supportsVisibleFederation() are true | |
Method | getBlockNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.hold.BlockReceiver | blockReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockNotificationSession | a BlockNotificationSession | |
Errors | NULL_ARGUMENT | blockReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBlockNotification()
is true. | |
Method | getBlockNotificationSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.hold.BlockReceiver | blockReceiver | the notification callback |
osid.id.Id | oublietteId | the Id of the Oubliette | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockNotificationSession | a BlockNotificationSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | blockReceiver, oublietteId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBlockNotification()
and supportsVisibleFederation() are true | |
Method | getBlockOublietteSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.BlockOublietteSession | a BlockOublietteSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockOubliette() is false | ||
Compliance | optional | This method must be implemented if supportsBlockOubliette()
is true. | |
Method | getBlockOublietteAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.BlockOublietteAssignmentSession | a BlockOublietteAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockOublietteAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsBlockOublietteAssignment() is true. | |
Method | getBlockSmartOublietteSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.BlockSmartOublietteSession | a BlockSmartOublietteSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockSmartOubliette() is false | ||
Compliance | optional | This method must be implemented if supportsBlockSmartOubliette()
is true. | |
Method | getIssueLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.IssueLookupSession | an IssueLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsIssueLookup() is
true. | |
Method | getIssueLookupSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.IssueLookupSession | an IssueLookupSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueLookup() and
supportsVisibleFederation() are true | |
Method | getIssueQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.IssueQuerySession | an IssueQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueQuery() is false | ||
Compliance | optional | This method must be implemented if supportsIssueQuery() is
true. | |
Method | getIssueQuerySessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.IssueQuerySession | an IssueQuerySession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueQuery() and
supportsVisibleFederation() are true | |
Method | getIssueSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.IssueSearchSession | an IssueSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueSearch() is false | ||
Compliance | optional | This method must be implemented if supportsIssueSearch() is
true. | |
Method | getIssueSearchSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.IssueSearchSession | an IssueSearchSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueSearch() and
supportsVisibleFederation() are true | |
Method | getIssueAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.IssueAdminSession | an IssueAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsIssueAdmin() is
true. | |
Method | getIssueAdminSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.IssueAdminSession | an IssueAdminSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueAdmin() and
supportsVisibleFederation() are true | |
Method | getIssueNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.hold.IssueReceiver | issueReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.IssueNotificationSession | an IssueNotificationSession | |
Errors | NULL_ARGUMENT | issueReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueNotification() is false | ||
Compliance | optional | This method must be implemented if supportsIssueNotification()
is true. | |
Method | getIssueNotificationSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.hold.IssueReceiver | issueReceiver | the notification callback |
osid.id.Id | oublietteId | the Id of the Oubliette | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.IssueNotificationSession | an IssueNotificationSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | issueReceiver, oublietteId or proxy
is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsIssueNotification()
and supportsVisibleFederation() are true | |
Method | getIssueOublietteSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.IssueOublietteSession | an IssueOublietteSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueOubliette() is false | ||
Compliance | optional | This method must be implemented if supportsIssueOubliette()
is true. | |
Method | getIssueOublietteAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.IssueOublietteAssignmentSession | an IssueOublietteAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueOublietteAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsIssueOublietteAssignment() is true. | |
Method | getIssueSmartOublietteSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.IssueSmartOublietteSession | an IssueSmartOublietteSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueSmartOubliette() is false | ||
Compliance | optional | This method must be implemented if supportsIssueSmartOubliette()
is true. | |
Method | getHoldLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.HoldLookupSession | a HoldLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldLookup() is false | ||
Compliance | optional | This method must be implemented if supportsHoldLookup() is
true. | |
Method | getHoldLookupSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.HoldLookupSession | a HoldLookupSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsHoldLookup() and
supportsVisibleFederation() are true | |
Method | getHoldQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.HoldQuerySession | a HoldQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldQuery() is false | ||
Compliance | optional | This method must be implemented if supportsHoldQuery() is
true. | |
Method | getHoldQuerySessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.HoldQuerySession | a HoldQuerySession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsHoldQuery() and
supportsVisibleFederation() are true | |
Method | getHoldSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.HoldSearchSession | a HoldSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldSearch() is false | ||
Compliance | optional | This method must be implemented if supportsHoldSearch() is
true. | |
Method | getHoldSearchSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.HoldSearchSession | a HoldSearchSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsHoldSearch() and
supportsVisibleFederation() are true | |
Method | getHoldAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.HoldAdminSession | a HoldAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsHoldAdmin() is
true. | |
Method | getHoldAdminSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.HoldAdminSession | a HoldAdminSession | |
Errors | NOT_FOUND | no Oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsHoldAdmin() and
supportsVisibleFederation() are true | |
Method | getHoldNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.hold.HoldReceiver | holdReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.HoldNotificationSession | a HoldNotificationSession | |
Errors | NULL_ARGUMENT | holdReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldNotification() is false | ||
Compliance | optional | This method must be implemented if supportsHoldNotification()
is true. | |
Method | getHoldNotificationSessionForOubliette | ||
Description |
Gets the | ||
Parameters | osid.hold.HoldReceiver | holdReceiver | the notification callback |
osid.id.Id | oublietteId | the Id of the Oubliette | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.HoldNotificationSession | a HoldNotificationSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | holdReceiver, oublietteId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsHoldNotification()
and supportsVisibleFederation() are true | |
Method | getHoldOublietteSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.HoldOublietteSession | a HoldOublietteSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldOubliette() is false | ||
Compliance | optional | This method must be implemented if supportsHoldOubliette()
is true. | |
Method | getHoldOublietteAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.HoldOublietteAssignmentSession | a HoldOublietteAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldOublietteAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsHoldOublietteAssignment()
is true. | |
Method | getHoldSmartOublietteSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.HoldSmartOublietteSession | a HoldSmartOublietteSession | |
Errors | NOT_FOUND | no oubliette found by the given Id | |
NULL_ARGUMENT | oublietteId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsHoldSmartOubliette() is false | ||
Compliance | optional | This method must be implemented if supportsHoldSmartOubliette()
is true. | |
Method | getOublietteLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.OublietteLookupSession | a OublietteLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOublietteLookup() is false | ||
Compliance | optional | This method must be implemented if supportsOublietteLookup()
is true. | |
Method | getOublietteQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.OublietteQuerySession | a OublietteQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOublietteQuery() is false | ||
Compliance | optional | This method must be implemented if supportsOublietteQuery()
is true. | |
Method | getOublietteSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.OublietteSearchSession | a OublietteSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOublietteSearch() is false | ||
Compliance | optional | This method must be implemented if supportsOublietteSearch()
is true. | |
Method | getOublietteAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.OublietteAdminSession | a OublietteAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOublietteAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsOublietteAdmin()
is true. | |
Method | getOublietteNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.hold.OublietteReceiver | oublietteReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.hold.OublietteNotificationSession | a OublietteNotificationSession | |
Errors | NULL_ARGUMENT | oublietteReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOublietteNotification() is false | ||
Compliance | optional | This method must be implemented if supportsOublietteNotification()
is true. | |
Method | getOublietteHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.OublietteHierarchySession | a OublietteHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOublietteHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsOublietteHierarchy()
is true. | |
Method | getOublietteHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.hold.OublietteHierarchyDesignSession | a HierarchyDesignSession for oubliettes | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOublietteHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsOublietteHierarchyDesign() is true. | |
Method | getHoldBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.hold.batch.HoldBatchProxyManager | a HoldBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsHoldBatch() is false | ||
Compliance | optional | This method must be implemented if supportsHoldBatch() is
true. | |
Method | getHoldRulesProxyManager | ||
Description |
Gets a | ||
Return | osid.hold.rules.HoldRulesProxyManager | a HoldRulesProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsHoldRules() is false | ||
Compliance | optional | This method must be implemented if supportsHoldRules() is
true. |