| Interface | osid.hold.BlockOublietteAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of a   | ||
| Method | canAssignBlocks | ||
| Description | 
                     Tests if this user can alter block/oubliette mappings. 
                    A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                      | ||
| Return | boolean |  false  if hold is not authorized,  true  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignBlocksToOubliette | ||
| Description | 
                     Tests if this user can alter block/oubliette mappings. 
                    A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                      | ||
| Parameters | osid.id.Id | oublietteId | the  Id  of the  Oubliette   | 
| Return | boolean |  false  if mapping is not authorized,  true  
otherwise  | |
| Errors | NULL_ARGUMENT |  oublietteId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableOublietteIds | ||
| Description | 
                     Gets a list of oubliettes including and under the given oubliette node in which any block can be assigned.  | ||
| Parameters | osid.id.Id | oublietteId | the  Id  of the  Oubliette   | 
| Return | osid.id.IdList | list of assignable oubliette  Ids   | |
| Errors | NULL_ARGUMENT |  oublietteId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableOublietteIdsForBlock | ||
| Description | 
                     Gets a list of oubliettes including and under the given oubliette node in which a specific block can be assigned.  | ||
| Parameters | osid.id.Id | oublietteId | the  Id  of the  Oubliette   | 
osid.id.Id | blockId | the  Id  of the  Block   | |
| Return | osid.id.IdList | list of assignable oubliette  Ids   | |
| Errors | NULL_ARGUMENT |  oublietteId  or  blockId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignBlockToOubliette | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | blockId | the  Id  of the  Block   | 
osid.id.Id | oublietteId | the  Id  of the  Oubliette   | |
| Errors | ALREADY_EXISTS |  blockId  is already assigned to  oublietteId   |                 |
| NOT_FOUND |  blockId  or  oublietteId  not found  |                 ||
| NULL_ARGUMENT |  blockId  or  oublietteId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignBlockFromOubliette | ||
| Description | 
                     Removes a   | ||
| Parameters | osid.id.Id | blockId | the  Id  of the  Block   | 
osid.id.Id | oublietteId | the  Id  of the  Oubliette   | |
| Errors | NOT_FOUND |  blockId  or  oublietteId  not found or  
blockId  is not assigned to  oublietteId   |                 |
| NULL_ARGUMENT |  blockId  or  oublietteId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignBlockToOubliette | ||
| Description | 
                     Moves a   | ||
| Parameters | osid.id.Id | blockId | the  Id  of the  Block   | 
osid.id.Id | fromOublietteId | the  Id  of the current  Oubliette   | |
osid.id.Id | toOublietteId | the  Id  of the destination  Oubliette   | |
| Errors | NOT_FOUND |  blockId, fromOublietteId,  or  toOublietteId  
not found or  blockId  not mapped to  fromOublietteId 
  |                 |
| NULL_ARGUMENT |  blockId, fromOublietteId,  or  toOublietteId  is 
 null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |