OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.HoldProxyManager
Implementsosid.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 Proxy for passing information from server environments. The sessions included in this manager are:

  • BlockSession: a session for checking for blocks
  • MyHoldSession: a session for looking up holds for the authenticated agent
  • BlockLookupSession: a session to retrieve blocks
  • BlockQuerySession: a session to query for blocks
  • BlockSearchSession: a session to search for blocks
  • BlockAdminSession: a session to create and delete blocks
  • BlockNotificationSession: a session to receive notifications pertaining to block changes
  • BlockOublietteSession: a session to looking mappings of blocks to oubliettes
  • BlockOublietteAssignmentSession: a session to manage block to oubliette mappings
  • BlockOublietteAssignmentSession: a session to manage dynamic oubliettes of blocks
  • IssueLookupSession: a session to retrieve issues
  • IssueQuerySession: a session to query for issues
  • IssueSearchSession: a session to search for issues
  • IssueAdminSession: a session to create and delete issues
  • IssueNotificationSession: a session to receive notifications pertaining to issue changes
  • IssueOublietteSession: a session to look up issue oubliette mappings
  • IssueOublietteAssignmentSession: a session to manage issue to oubliette mappings
  • IssueSmartOublietteSession: a session to manage dynamic oubliettes of issues
  • HoldLookupSession: a session to retrieve holds
  • HoldQuerySession: a session to query for holds
  • HoldSearchSession: a session to search for holds
  • HoldAdminSession: a session to create and delete holds
  • HoldNotificationSession: a session to receive notifications pertaining to hold changes
  • HoldOublietteSession: a session to look up hol oubliette mappings
  • HoldOublietteAssignmentSession: a session to manage hold to oubliette mappings
  • HoldSmartOublietteSession: a session to manage dynamic oubliettes of holds
  • OublietteLookupSession: a session to retrieve oubliettes
  • OublietteQuerySession: a session to search for oubliettes
  • OublietteSearchSession: a session to search for oubliettes
  • OublietteAdminSession: a session to create and delete oubliettes
  • OublietteNotificationSession: a session to receive notifications pertaining to oubliette changes
  • OublietteHierarchySession: a session to traverse a hierarchy of oubliette
  • OublietteHierarchyDesignSession: a session to manage an oubliette hierarchy
MethodgetBlockSession
Description

Gets the OsidSession associated with the block service to check for blocks.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockSession a BlockSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlock() is false
Complianceoptional This method must be implemented if supportsBlock() is true.
MethodgetBlockSessionForOubliette
Description

Gets the OsidSession associated with the block service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockSession a BlockSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsBlock() and supportsVisibleFederation() are true
MethodgetMyHoldSession
Description

Gets the OsidSession associated with the my hold service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.MyHoldSession a MyHoldSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsMyHold() is false
Complianceoptional This method must be implemented if supportsMyHold() is true.
MethodgetMyHoldSessionForOubliette
Description

Gets the OsidSession associated with the my hold service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.MyHoldSession a MyHoldSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsMyHold() and supportsVisibleFederation() are true
MethodgetBlockLookupSession
Description

Gets the OsidSession associated with the block lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockLookupSession a BlockLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlockLookup() is false
Complianceoptional This method must be implemented if supportsBlockLookup() is true.
MethodgetBlockLookupSessionForOubliette
Description

Gets the OsidSession associated with the block lookup service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockLookupSession a BlockLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsBlockLookup() and supportsVisibleFederation() are true
MethodgetBlockQuerySession
Description

Gets the OsidSession associated with the block query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockQuerySession a BlockQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlockQuery() is false
Complianceoptional This method must be implemented if supportsBlockQuery() is true.
MethodgetBlockQuerySessionForOubliette
Description

Gets the OsidSession associated with the block query service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockQuerySession a BlockQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsBlockQuery() and supportsVisibleFederation() are true
MethodgetBlockSearchSession
Description

Gets the OsidSession associated with the block search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockSearchSession a BlockSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlockSearch() is false
Complianceoptional This method must be implemented if supportsBlockSearch() is true.
MethodgetBlockSearchSessionForOubliette
Description

Gets the OsidSession associated with the block search service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockSearchSession a BlockSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsBlockSearch() and supportsVisibleFederation() are true
MethodgetBlockAdminSession
Description

Gets the OsidSession associated with the block administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockAdminSession a BlockAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlockAdmin() is false
Complianceoptional This method must be implemented if supportsBlockAdmin() is true.
MethodgetBlockAdminSessionForOubliette
Description

Gets the OsidSession associated with the block administration service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockAdminSession a BlockAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsBlockAdmin() and supportsVisibleFederation() are true
MethodgetBlockNotificationSession
Description

Gets the OsidSession associated with the block notification service.

Parametersosid.hold.BlockReceiverblockReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockNotificationSession a BlockNotificationSession
ErrorsNULL_ARGUMENT blockReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlockNotification() is false
Complianceoptional This method must be implemented if supportsBlockNotification() is true.
MethodgetBlockNotificationSessionForOubliette
Description

Gets the OsidSession associated with the block notification service for the given oubliette.

Parametersosid.hold.BlockReceiverblockReceiver the notification callback
osid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockNotificationSession a BlockNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsBlockNotification() and supportsVisibleFederation() are true
MethodgetBlockOublietteSession
Description

Gets the OsidSession to lookup block/oubliette mappings.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockOublietteSession a BlockOublietteSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlockOubliette() is false
Complianceoptional This method must be implemented if supportsBlockOubliette() is true.
MethodgetBlockOublietteAssignmentSession
Description

Gets the OsidSession associated with assigning blocks to oubliettes.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockOublietteAssignmentSession a BlockOublietteAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBlockOublietteAssignment() is false
Complianceoptional This method must be implemented if supportsBlockOublietteAssignment() is true.
MethodgetBlockSmartOublietteSession
Description

Gets the OsidSession to manage block smart oubliettes.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.BlockSmartOublietteSession a BlockSmartOublietteSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsBlockSmartOubliette() is true.
MethodgetIssueLookupSession
Description

Gets the OsidSession associated with the issue lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueLookupSession an IssueLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueLookup() is false
Complianceoptional This method must be implemented if supportsIssueLookup() is true.
MethodgetIssueLookupSessionForOubliette
Description

Gets the OsidSession associated with the issue lookup service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueLookupSession an IssueLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsIssueLookup() and supportsVisibleFederation() are true
MethodgetIssueQuerySession
Description

Gets the OsidSession associated with the issue query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueQuerySession an IssueQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueQuery() is false
Complianceoptional This method must be implemented if supportsIssueQuery() is true.
MethodgetIssueQuerySessionForOubliette
Description

Gets the OsidSession associated with the issue query service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueQuerySession an IssueQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsIssueQuery() and supportsVisibleFederation() are true
MethodgetIssueSearchSession
Description

Gets the OsidSession associated with the issue search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueSearchSession an IssueSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueSearch() is false
Complianceoptional This method must be implemented if supportsIssueSearch() is true.
MethodgetIssueSearchSessionForOubliette
Description

Gets the OsidSession associated with the issue search service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueSearchSession an IssueSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsIssueSearch() and supportsVisibleFederation() are true
MethodgetIssueAdminSession
Description

Gets the OsidSession associated with the issue administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueAdminSession an IssueAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueAdmin() is false
Complianceoptional This method must be implemented if supportsIssueAdmin() is true.
MethodgetIssueAdminSessionForOubliette
Description

Gets the OsidSession associated with the issue administration service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueAdminSession an IssueAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsIssueAdmin() and supportsVisibleFederation() are true
MethodgetIssueNotificationSession
Description

Gets the OsidSession associated with the issue notification service.

Parametersosid.hold.IssueReceiverissueReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueNotificationSession an IssueNotificationSession
ErrorsNULL_ARGUMENT issueReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueNotification() is false
Complianceoptional This method must be implemented if supportsIssueNotification() is true.
MethodgetIssueNotificationSessionForOubliette
Description

Gets the OsidSession associated with the issue notification service for the given oubliette.

Parametersosid.hold.IssueReceiverissueReceiver the notification callback
osid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueNotificationSession an IssueNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsIssueNotification() and supportsVisibleFederation() are true
MethodgetIssueOublietteSession
Description

Gets the OsidSession to lookup issue/oubliette holds.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueOublietteSession an IssueOublietteSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueOubliette() is false
Complianceoptional This method must be implemented if supportsIssueOubliette() is true.
MethodgetIssueOublietteAssignmentSession
Description

Gets the OsidSession associated with assigning mappings to oubliettes.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueOublietteAssignmentSession an IssueOublietteAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueOublietteAssignment() is false
Complianceoptional This method must be implemented if supportsIssueOublietteAssignment() is true.
MethodgetIssueSmartOublietteSession
Description

Gets the OsidSession to manage locatin smart oubliettes.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.IssueSmartOublietteSession an IssueSmartOublietteSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsIssueSmartOubliette() is true.
MethodgetHoldLookupSession
Description

Gets the OsidSession associated with the hold lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldLookupSession a HoldLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldLookup() is false
Complianceoptional This method must be implemented if supportsHoldLookup() is true.
MethodgetHoldLookupSessionForOubliette
Description

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

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldLookupSession a HoldLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsHoldLookup() and supportsVisibleFederation() are true
MethodgetHoldQuerySession
Description

Gets the OsidSession associated with the hold query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldQuerySession a HoldQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldQuery() is false
Complianceoptional This method must be implemented if supportsHoldQuery() is true.
MethodgetHoldQuerySessionForOubliette
Description

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

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldQuerySession a HoldQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsHoldQuery() and supportsVisibleFederation() are true
MethodgetHoldSearchSession
Description

Gets the OsidSession associated with the hold search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldSearchSession a HoldSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldSearch() is false
Complianceoptional This method must be implemented if supportsHoldSearch() is true.
MethodgetHoldSearchSessionForOubliette
Description

Gets the OsidSession associated with the hold search service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldSearchSession a HoldSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsHoldSearch() and supportsVisibleFederation() are true
MethodgetHoldAdminSession
Description

Gets the OsidSession associated with the hold administrative service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldAdminSession a HoldAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldAdmin() is false
Complianceoptional This method must be implemented if supportsHoldAdmin() is true.
MethodgetHoldAdminSessionForOubliette
Description

Gets the OsidSession associated with the hold administrative service for the given oubliette.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldAdminSession a HoldAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsHoldAdmin() and supportsVisibleFederation() are true
MethodgetHoldNotificationSession
Description

Gets the OsidSession associated with the hold notification service.

Parametersosid.hold.HoldReceiverholdReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldNotificationSession a HoldNotificationSession
ErrorsNULL_ARGUMENT holdReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldNotification() is false
Complianceoptional This method must be implemented if supportsHoldNotification() is true.
MethodgetHoldNotificationSessionForOubliette
Description

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

Parametersosid.hold.HoldReceiverholdReceiver the notification callback
osid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldNotificationSession a HoldNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsHoldNotification() and supportsVisibleFederation() are true
MethodgetHoldOublietteSession
Description

Gets the OsidSession to lookup hold/oubliette mappings.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldOublietteSession a HoldOublietteSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldOubliette() is false
Complianceoptional This method must be implemented if supportsHoldOubliette() is true.
MethodgetHoldOublietteAssignmentSession
Description

Gets the OsidSession associated with assigning competencies to oubliettes.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldOublietteAssignmentSession a HoldOublietteAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldOublietteAssignment() is false
Complianceoptional This method must be implemented if supportsHoldOublietteAssignment() is true.
MethodgetHoldSmartOublietteSession
Description

Gets the OsidSession to manage hold smart oubliettes.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.proxy.Proxyproxy a proxy
Returnosid.hold.HoldSmartOublietteSession a HoldSmartOublietteSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsHoldSmartOubliette() is true.
MethodgetOublietteLookupSession
Description

Gets the OsidSession associated with the oubliette lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.OublietteLookupSession an OublietteLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOublietteLookup() is false
Complianceoptional This method must be implemented if supportsOublietteLookup() is true.
MethodgetOublietteQuerySession
Description

Gets the OsidSession associated with the oubliette query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.OublietteQuerySession an OublietteQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOublietteQuery() is false
Complianceoptional This method must be implemented if supportsOublietteQuery() is true.
MethodgetOublietteSearchSession
Description

Gets the OsidSession associated with the oubliette search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.OublietteSearchSession an OublietteSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOublietteSearch() is false
Complianceoptional This method must be implemented if supportsOublietteSearch() is true.
MethodgetOublietteAdminSession
Description

Gets the OsidSession associated with the oubliette administrative service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.OublietteAdminSession an OublietteAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOublietteAdmin() is false
Complianceoptional This method must be implemented if supportsOublietteAdmin() is true.
MethodgetOublietteNotificationSession
Description

Gets the OsidSession associated with the oubliette notification service.

Parametersosid.hold.OublietteReceiveroublietteReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.hold.OublietteNotificationSession an OublietteNotificationSession
ErrorsNULL_ARGUMENT oublietteReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOublietteNotification() is false
Complianceoptional This method must be implemented if supportsOublietteNotification() is true.
MethodgetOublietteHierarchySession
Description

Gets the OsidSession associated with the oubliette hierarchy service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.OublietteHierarchySession an OublietteHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOublietteHierarchy() is false
Complianceoptional This method must be implemented if supportsOublietteHierarchy() is true.
MethodgetOublietteHierarchyDesignSession
Description

Gets the OsidSession associated with the oubliette hierarchy design service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.hold.OublietteHierarchyDesignSession a HierarchyDesignSession for oubliettes
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOublietteHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsOublietteHierarchyDesign() is true.
MethodgetHoldBatchProxyManager
Description

Gets a HoldBatchProxyManager.

Returnosid.hold.batch.HoldBatchProxyManager a HoldBatchProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldBatch() is false
Complianceoptional This method must be implemented if supportsHoldBatch() is true.
MethodgetHoldRulesProxyManager
Description

Gets a HoldRulesProxyManager.

Returnosid.hold.rules.HoldRulesProxyManager a HoldRulesProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsHoldRules() is false
Complianceoptional This method must be implemented if supportsHoldRules() is true.