| Interface | osid.hold.HoldManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.hold.HoldProfile | |||
| Description | 
                 The hold manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: 
 
 
 
  | ||
| Method | getBlockSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.hold.BlockSession | a  BlockSession   | |
| Errors | 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  | 
| Return | osid.hold.BlockSession | a  BlockSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.MyHoldSession | a  MyHoldSession   | |
| Errors | 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  | 
| Return | osid.hold.MyHoldSession | a  MyHoldSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.BlockLookupSession | a  BlockLookupSession   | |
| Errors | 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   | 
| Return | osid.hold.BlockLookupSession | a  BlockLookupSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.BlockQuerySession | a  BlockQuerySession   | |
| Errors | 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   | 
| Return | osid.hold.BlockQuerySession | a  BlockQuerySession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.BlockSearchSession | a  BlockSearchSession   | |
| Errors | 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   | 
| Return | osid.hold.BlockSearchSession | a  BlockSearchSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.BlockAdminSession | a  BlockAdminSession   | |
| Errors | 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   | 
| Return | osid.hold.BlockAdminSession | a  BlockAdminSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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 | 
| Return | osid.hold.BlockNotificationSession | a  BlockNotificationSession   | |
| Errors | NULL_ARGUMENT |  blockReceiver  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   | |
| Return | osid.hold.BlockNotificationSession | a  BlockNotificationSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  blockReceiver  or  oublietteId  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   | ||
| Return | osid.hold.BlockOublietteSession | a  BlockOublietteSession   | |
| Errors | 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   | ||
| Return | osid.hold.BlockOublietteAssignmentSession | a  BlockOublietteAssignmentSession   | |
| Errors | 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   | 
| Return | osid.hold.BlockSmartOublietteSession | a  BlockSmartOublietteSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.IssueLookupSession | an  IssueLookupSession   | |
| Errors | 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  | 
| Return | osid.hold.IssueLookupSession | an  IssueLookupSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.IssueQuerySession | an  IssueQuerySession   | |
| Errors | 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   | 
| Return | osid.hold.IssueQuerySession | an  IssueQuerySession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.IssueSearchSession | an  IssueSearchSession   | |
| Errors | 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   | 
| Return | osid.hold.IssueSearchSession | an  IssueSearchSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.IssueAdminSession | an  IssueAdminSession   | |
| Errors | 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   | 
| Return | osid.hold.IssueAdminSession | an  IssueAdminSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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 | 
| Return | osid.hold.IssueNotificationSession | an  IssueNotificationSession   | |
| Errors | NULL_ARGUMENT |  issueReceiver  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   | |
| Return | osid.hold.IssueNotificationSession | an  IssueNotificationSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  issueReceiver  or  oublietteId  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   | ||
| Return | osid.hold.IssueOublietteSession | an  IssueOublietteSession   | |
| Errors | 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   | ||
| Return | osid.hold.IssueOublietteAssignmentSession | an  IssueOublietteAssignmentSession   | |
| Errors | 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   | 
| Return | osid.hold.IssueSmartOublietteSession | an  IssueSmartOublietteSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.HoldLookupSession | a  HoldLookupSession   | |
| Errors | 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   | 
| Return | osid.hold.HoldLookupSession | a  HoldLookupSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.HoldQuerySession | a  HoldQuerySession   | |
| Errors | 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   | 
| Return | osid.hold.HoldQuerySession | a  CHoldQuerySession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.HoldSearchSession | a  HoldSearchSession   | |
| Errors | 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   | 
| Return | osid.hold.HoldSearchSession | a  HoldSearchSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.HoldAdminSession | a  HoldAdminSession   | |
| Errors | 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   | 
| Return | osid.hold.HoldAdminSession | a  HoldAdminSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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 | 
| Return | osid.hold.HoldNotificationSession | a  HoldNotificationSession   | |
| Errors | NULL_ARGUMENT |  holdReceiver  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   | |
| Return | osid.hold.HoldNotificationSession | a  HoldNotificationSession   | |
| Errors | NOT_FOUND | no oubliette found by the given  Id   |                 |
| NULL_ARGUMENT |  holdReceiver  or  oublietteId  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   | ||
| Return | osid.hold.HoldOublietteSession | a  HoldOublietteSession   | |
| Errors | 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   | ||
| Return | osid.hold.HoldOublietteAssignmentSession | a  HoldOublietteAssignmentSession   | |
| Errors | 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   | 
| Return | osid.hold.HoldSmartOublietteSession | a  HoldSmartOublietteSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  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   | ||
| Return | osid.hold.OublietteLookupSession | a  OublietteLookupSession   | |
| Errors | 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   | ||
| Return | osid.hold.OublietteQuerySession | a  OublietteQuerySession   | |
| Errors | 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   | ||
| Return | osid.hold.OublietteSearchSession | a  OublietteSearchSession   | |
| Errors | 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   | ||
| Return | osid.hold.OublietteAdminSession | a  OublietteAdminSession   | |
| Errors | 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 | 
| Return | osid.hold.OublietteNotificationSession | a  OublietteNotificationSession   | |
| Errors | NULL_ARGUMENT |  oublietteReceiver  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   | ||
| Return | osid.hold.OublietteHierarchySession | a  OublietteHierarchySession   | |
| Errors | 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   | ||
| Return | osid.hold.OublietteHierarchyDesignSession | a  HierarchyDesignSession  for oubliettes  | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsOublietteHierarchyDesign()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsOublietteHierarchyDesign()  is  true.   | |
| Method | getHoldBatchManager | ||
| Description | 
                     Gets a   | ||
| Return | osid.hold.batch.HoldBatchManager | a  HoldBatchManager   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsHoldBatch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsHoldBatch()  is 
 true.   | |
| Method | getHoldRulesManager | ||
| Description | 
                     Gets a   | ||
| Return | osid.hold.rules.HoldRulesManager | a  HoldRulesManager   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsHoldRules()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsHoldRules()  is 
 true.   | |