OSID - osid.rules.check.InstructionAdminSession Service Interface Definition

Interface	osid.rules.check.InstructionAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Instructions.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create an `Instruction,` an `InstructionForm` is requested using `getInstructionFormForCreate()` specifying the desired agenda, check, and record `Types` or none if no record `Types` are needed. The returned `InstructionForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `InstructionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `InstructionForm` corresponds to an attempted transaction. For updates, `InstructionForms` are requested to the `Instruction` `Id` that is to be updated using `getInstructionFormForUpdate().` Similarly, the `InstructionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `InstructionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Instructions.` To unmap an `Instruction` from the current `Engine,` the `InstructionEngineAssignmentSession` should be used. These delete operations attempt to remove the `Instruction` itself thus removing it from all known `Engine` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateInstructions
Description	Tests if this user can create `Instructions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Instruction` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
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 `Instruction` using the desired record types. While `RulesCheckManager.getInstructionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Instruction.` Providing an empty array tests if an `Instruction` can be created with no records.
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 `Instruction.`
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 `Instructions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Instruction` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
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 `Instructions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Instruction` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Instruction` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteInstruction
Description	Deletes an `Instruction.`
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 `Id` aliases for `Instructions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Instruction` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasInstruction
Description	Adds an `Id` to an `Instruction` for the purpose of creating compatibility. The primary `Id` of the `Instruction` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another instruction, it is reassigned to the given instruction `Id.`
Parameters	`osid.id.Id`	`instructionId`	the `Id` of an `Instruction`
Parameters	`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 `Instructions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
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`
Parameters	`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.