Interface | osid.rules.check.InstructionAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getEngineId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Engine Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngine | ||
Description |
Gets the | ||
Return | osid.rules.Engine | the engine | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInstructions | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Instruction creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInstructionWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | instructionRecordTypes | array of instruction record types |
Return | boolean | true if Instruction creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | instructionRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionFormForCreate | ||
Description |
Gets the instruction form for creating new instructions. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | agendaId | an agenda Id |
osid.id.Id | checkId | a check Id | |
osid.type.Type[] | instructionRecordTypes | array of instruction record types | |
Return | osid.rules.check.InstructionForm | the instruction form | |
Errors | NOT_FOUND | agendaId or checkId is not found | |
NULL_ARGUMENT | agendaId, checkId, or instructionRecordTypes
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createInstruction | ||
Description |
Creates a new | ||
Parameters | osid.rules.check.InstructionForm | instructionForm | the form for this Instruction |
Return | osid.rules.check.Instruction | the new Instruction | |
Errors | ILLEGAL_STATE | instructionForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | i nstructionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | instructionForm did not orginate from
getInstructionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateInstructions | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Instruction modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionFormForUpdate | ||
Description |
Gets the instruction form for updating an existing instruction. A new instruction form should be requested for each update transaction. | ||
Parameters | osid.id.Id | instructionId | the Id of the Instruction |
Return | osid.rules.check.InstructionForm | the instruction form | |
Errors | NOT_FOUND | instructionId is not found | |
NULL_ARGUMENT | instructionId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateInstruction | ||
Description |
Updates an existing instruction. | ||
Parameters | osid.rules.check.InstructionForm | instructionForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | instructionForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | instructionId or instructionForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | instructionForm did not orginate from
getInstructionFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteInstructions | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Instruction deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteInstruction | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | instructionId | the Id of the Instruction to remove |
Errors | NOT_FOUND | instructionId not found | |
NULL_ARGUMENT | instructionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageInstructionAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Instruction aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasInstruction | ||
Description |
Adds an | ||
Parameters | osid.id.Id | instructionId | the Id of an Instruction |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | instructionId not found | ||
NULL_ARGUMENT | instructionId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceInstructions | ||
Description |
Tests if this user can order | ||
Return | boolean | false if Instruction ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveInstructionAhead | ||
Description |
Reorders instructions in an agenda by moving the specified instruction in front of a reference instruction. | ||
Parameters | osid.id.Id | instructionId | the Id of an Instruction |
osid.id.Id | agendaId | the Id of an Agenda | |
osid.id.Id | referenceId | the reference instruction Id | |
Errors | NOT_FOUND | instructionId, agendaId, or referenceId not
found or, instructionId or referenceId not
related to agendaId | |
NULL_ARGUMENT | instructionId, agendaId or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveInstructionBehind | ||
Description |
Reorders instructions in an agenda by moving the specified instruction behind a reference instruction. | ||
Parameters | osid.id.Id | instructionId | the Id of an Instruction |
osid.id.Id | agendaId | the Id of an Agenda | |
osid.id.Id | referenceId | the reference instruction Id | |
Errors | NOT_FOUND | instructionId, agendaId, or referenceId not
found or, instructionId or referenceId not
related to agendaId | |
NULL_ARGUMENT | instructionId, agendaId or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderInstructions | ||
Description |
Reorders a set of instructions in an agenda. | ||
Parameters | osid.id.Id[] | instructionIds | the Ids for a set of Instructions |
osid.id.Id | agendaId | the Id of an Agenda | |
Errors | NOT_FOUND | agendaId not found or, an instructionId not
related to agendaId | |
NULL_ARGUMENT | instructionIds or agendaId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |