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

Interface	osid.rules.check.InstructionLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving instructions. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated engine view: All instruction methods in this session operate, retrieve and pertain to instructions defined explicitly in the current engine. Using an isolated view is useful for managing `Instructions` with the `InstructionAdminSession.` federated engine view: All instruction lookup methods in this session operate, retrieve and pertain to all instructions defined in this engine and any other instructions implicitly available in this engine through engine inheritence. active instruction view: All instruction lookup methods return active instructions. any status instruction view: instructions of any active or inactive status are returned from methods. The methods `useFederatedEngineView()` and `useIsolatedEngineView()` behave as a radio group and one should be selected before invoking any lookup methods. Instructions may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Instructions.`
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	canLookupInstructions
Description	Tests if this user can perform `Instruction` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeInstructionView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryInstructionView
Description	A complete view of the `Instruction` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedEngineView
Description	Federates the view for methods in this session. A federated view will include instructions in engines which are children of this engine in the engine hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedEngineView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this engine only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveInstructionView
Description	Only active instructions are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusInstructionView
Description	All active and inactive instructions of are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getInstruction
Description	Gets the `Instruction` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Instruction` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Instruction` and retained for compatibility.
Parameters	`osid.id.Id`	`instructionId`	the `Id` of the `Instruction` to retrieve
Return	`osid.rules.check.Instruction`		the returned `Instruction`
Errors	NOT_FOUND		no `Instruction` found with the given `Id`
	NULL_ARGUMENT		`instructionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsByIds
Description	Gets an `InstructionList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the instructions specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Instructions` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.id.IdList`	`instructionIds`	the list of `Ids` to retrieve
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`instructionIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsByGenusType
Description	Gets an `InstructionList` corresponding to the given instruction genus `Type` which does not include instructions of types derived from the specified `Type.` In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.type.Type`	`instructionGenusType`	an instruction genus type
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	NULL_ARGUMENT		`instructionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsByParentGenusType
Description	Gets an `InstructionList` corresponding to the given instruction genus `Type` and include any additional instructions with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.type.Type`	`instructionGenusType`	an instruction genus type
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	NULL_ARGUMENT		`instructionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsByRecordType
Description	Gets an `InstructionList` containing the given instruction record `Type.` In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.type.Type`	`instructionRecordType`	an instruction record type
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	NULL_ARGUMENT		`instructionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsOnDate
Description	Gets an `InstructionList` effective for the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsForAgenda
Description	Gets an `InstructionList` for the given agenda. In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.id.Id`	`agendaId`	an agenda `Id`
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsForAgendaOnDate
Description	Gets an `InstructionList` for the given agenda and effective for the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.id.Id`	`agendaId`	an agenda `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agendaId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsForCheck
Description	Gets an `InstructionList` for the given check. In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.id.Id`	`checkId`	a check `Id`
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsForCheckOnDate
Description	Gets an `InstructionList` for the given check and effective for the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.id.Id`	`checkId`	a check `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`checkId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsForAgendaAndCheck
Description	Gets an `InstructionList` for the given agenda and check. In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.id.Id`	`agendaId`	an agenda `Id`
Parameters	`osid.id.Id`	`checkId`	a check `Id`
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	NULL_ARGUMENT		`agendaId` or `checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionsForAgendaAndCheckOnDate
Description	Gets an `InstructionList` for the given agenda and check and effective for the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known instructions or an error results. Otherwise, the returned list may contain only those instructions that are accessible through this session. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Parameters	`osid.id.Id`	`agendaId`	an agenda `Id`
	`osid.id.Id`	`checkId`	a check `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agendaId, checkId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstructions
Description	Gets all instructions. In plenary mode, the returned list contains all of the instructions, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Instructions` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, instructions are returned that are currently active. In any status mode, active and inactive instructions are returned.
Return	`osid.rules.check.InstructionList`		the returned `Instruction` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.