| Interface | osid.rules.check.InstructionEngineAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of an   | ||
| Method | canAssignInstructions | ||
| Description | 
                     Tests if this user can alter instruction/engine 
                    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 instruction is not authorized,  true  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignInstructionsToEngine | ||
| Description | 
                     Tests if this user can alter instruction/engine 
                    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 | engineId | the  Id  of the  Engine   | 
| Return | boolean |  false  if mapping is not authorized,  true  
otherwise  | |
| Errors | NULL_ARGUMENT |  engineId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableEngineIds | ||
| Description | 
                     Gets a list of engines including and under the given engine node in which any instruction can be assigned.  | ||
| Parameters | osid.id.Id | engineId | the  Id  of the  Engine   | 
| Return | osid.id.IdList | list of assignable engine  Ids   | |
| Errors | NULL_ARGUMENT |  engineId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableEngineIdsForInstruction | ||
| Description | 
                     Gets a list of engines including and under the given engine node in which a specific instruction can be assigned.  | ||
| Parameters | osid.id.Id | engineId | the  Id  of the  Engine   | 
osid.id.Id | instructionId | the  Id  of the  Instruction   | |
| Return | osid.id.IdList | list of assignable engine  Ids   | |
| Errors | NULL_ARGUMENT |  engineId  or  instructionId  is  null 
  |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignInstructionToEngine | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | instructionId | the  Id  of the  Instruction   | 
osid.id.Id | engineId | the  Id  of the  Engine   | |
| Errors | ALREADY_EXISTS |  instructionId  is already assigned to  engineId   |                 |
| NOT_FOUND |  instructionId  or  engineId  not found  |                 ||
| NULL_ARGUMENT |  instructionId  or  engineId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignInstructionFromEngine | ||
| Description | 
                     Removes an   | ||
| Parameters | osid.id.Id | instructionId | the  Id  of the  Instruction   | 
osid.id.Id | engineId | the  Id  of the  Engine   | |
| Errors | NOT_FOUND |  instructionId  or  engineId  not found or  
instructionId  not assigned to  engineId   |                 |
| NULL_ARGUMENT |  instructionId  or  engineId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |