OSID - osid.inquiry.rules.AuditProcessorLookupSession Service Interface Definition

Interface	osid.inquiry.rules.AuditProcessorLookupSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session provides methods for retrieving `AuditProcessors`. 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 inquest view: All audit processor methods in this session operate, retrieve and pertain to audit processors defined explicitly in the current inquest Using an isolated view is useful for managing `AuditProcessors` with the `AuditProcessorAdminSession`. federated inquest view: All audit processor methods in this session operate, retrieve and pertain to all audit processors defined in this inquest and any other audit processors implicitly available in this inquest through inquest inheritence. 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 `useFederatedInquestView()` and `useIsolatedInquestView() behave` as a radio group and one should be selected before invoking any lookup methods.
Method	getInquestId
Description	Gets the `Inquest` `Id` associated with this session.
Return	`osid.id.Id`		the `Inquest Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getInquest
Description	Gets the `Inquest` associated with this session.
Return	`osid.inquiry.Inquest`		the inquest
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupAuditProcessors
Description	Tests if this user can perform `AuditProcessor` 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	useComparativeAuditProcessorView
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	usePlenaryAuditProcessorView
Description	A complete view of the `AuditProcessor` 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	useFederatedInquestView
Description	Federates the view for methods in this session. A federated view will include audit processors in inquests which are children of this inquest in the inquest hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedInquestView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuditProcessor
Description	Gets the `AuditProcessor` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `AuditProcessor` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `AuditProcessor and reta` ined for compatibility.
Parameters	`osid.id.Id`	`auditProcessorId`	`Id` of the `AuditProcessor`
Return	`osid.inquiry.rules.AuditProcessor`		the audit processor
Errors	NOT_FOUND		`auditProcessorId` not found
	NULL_ARGUMENT		`auditProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAuditProcessorsByIds
Description	Gets an `AuditProcessorList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the audit processors 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 `AuditProcessors may be om` itted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`auditProcessorIds`	the list of `Ids` to retrieve
Return	`osid.inquiry.rules.AuditProcessorList`		the returned `AuditProcessor` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`auditProcessorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorsByGenusType
Description	Gets an `AuditProcessorList` corresponding to the given audit processor genus `Type` which does not include audit processors of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known audit processors or an error results. Otherwise, the returned list may contain only those audit processors that are accessible through this session.
Parameters	`osid.type.Type`	`auditProcessorGenusType`	an audit processor genus type
Return	`osid.inquiry.rules.AuditProcessorList`		the returned `AuditProcessor` list
Errors	NULL_ARGUMENT		`auditProcessorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorsByParentGenusType
Description	Gets an `AuditProcessorList` corresponding to the given audit processor genus `Type` and include any additional audit processors with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known audit processors or an error results. Otherwise, the returned list may contain only those audit processors that are accessible through this session.
Parameters	`osid.type.Type`	`auditProcessorGenusType`	an audit processor genus type
Return	`osid.inquiry.rules.AuditProcessorList`		the returned `AuditProcessor` list
Errors	NULL_ARGUMENT		`auditProcessorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorsByRecordType
Description	Gets an `AuditProcessorList` containing the given audit processor record `Type`. In plenary mode, the returned list contains all known audit processors or an error results. Otherwise, the returned list may contain only those audit processors that are accessible through this session.
Parameters	`osid.type.Type`	`auditProcessorRecordType`	an audit processor record type
Return	`osid.inquiry.rules.AuditProcessorList`		the returned `AuditProcessor` list
Errors	NULL_ARGUMENT		`auditProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessors
Description	Gets all `AuditProcessors`. In plenary mode, the returned list contains all known audit processors or an error results. Otherwise, the returned list may contain only those audit processors that are accessible through this session.
Return	`osid.inquiry.rules.AuditProcessorList`		a list of `AuditProcessors`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.