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

Interface	osid.rules.check.CheckLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Check` relationships. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated engine view: All check methods in this session operate, retrieve and pertain to checks defined explicitly in the current engine. Using an isolated view is useful for managing `Checks` with the `CheckAdminSession.` federated engine view: All check methods in this session operate, retrieve and pertain to all checks defined in this engine and any other checks implicitly available in this engine through engine inheritence. active check view: All check lookup methods return active checks. any status check view: Checks of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedEngineView()` and `useIsolatedEngineView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupChecks
Description	Tests if this user can perform `Check` 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 opt not to 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	useComparativeCheckView
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	usePlenaryCheckView
Description	A complete view of the `Check` 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 checks 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 lookups to this engine only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveCheckView
Description	Only active checks are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCheckView
Description	All active and inactive checks are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCheck
Description	Gets the `Check` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Check` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Check` and retained for compatibility. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
Parameters	`osid.id.Id`	`checkId`	`Id` of the `Check`
Return	`osid.rules.check.Check`		the hold
Errors	NOT_FOUND		`checkId` not found
	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getChecksByIds
Description	Gets a `CheckList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the checks 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 `Checks` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
Parameters	`osid.id.IdList`	`checkIds`	the list of `Ids` to retrieve
Return	`osid.rules.check.CheckList`		the returned `Check` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`checkIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChecksByGenusType
Description	Gets a `CheckList` corresponding to the given check genus `Type` which does not include checks of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
Parameters	`osid.type.Type`	`holdGenusType`	a check genus type
Return	`osid.rules.check.CheckList`		the returned `Check` list
Errors	NULL_ARGUMENT		`holdGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChecksByParentGenusType
Description	Gets a `CheckList` corresponding to the given check genus `Type` and include any additional checks with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
Parameters	`osid.type.Type`	`holdGenusType`	a check genus type
Return	`osid.rules.check.CheckList`		the returned `Check` list
Errors	NULL_ARGUMENT		`holdGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChecksByRecordType
Description	Gets a `CheckList` containing the given check record `Type.` In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
Parameters	`osid.type.Type`	`checkRecordType`	a check record type
Return	`osid.rules.check.CheckList`		the returned `Check` list
Errors	NULL_ARGUMENT		`checkRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChecks
Description	Gets all `Checks.` In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
Return	`osid.rules.check.CheckList`		a list of `Checks`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.