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

Interface	osid.inquiry.rules.AuditEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `AuditEnablers.` 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 enabler methods in this session operate, retrieve and pertain to audit enablers defined explicitly in the current inquest. Using an isolated view is useful for managing `AuditEnablers` with the `AuditEnablerAdminSession.` federated inquest view: All audit enabler methods in this session operate, retrieve and pertain to all audit enablers defined in this inquest and any other audit enablers implicitly available in this inquest through inquest inheritence. activee audit enabler view: All audit enabler lookup methods return active audit enablers. any status audit enabler view: audit enablers 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 `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupAuditEnablers
Description	Tests if this user can perform `AuditEnablers` 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	useComparativeAuditEnablerView
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	usePlenaryAuditEnablerView
Description	A complete view of the `AuditEnabler` 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 enablers 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	useActiveAuditEnablerView
Description	Only active audit enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusAuditEnablerView
Description	All active and inactive audit enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuditEnabler
Description	Gets the `AuditEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `AuditEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `AuditEnabler` and retained for compatibility. In active mode, audit enablers are returned that are currently active. In any status mode, active and inactive audit enablers are returned.
Parameters	`osid.id.Id`	`auditEnablerId`	`Id` of the `AuditEnabler`
Return	`osid.inquiry.rules.AuditEnabler`		the audit enabler
Errors	NOT_FOUND		`auditEnablerId` not found
	NULL_ARGUMENT		`auditEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAuditEnablersByIds
Description	Gets an `AuditEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the audit enablers 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 `AuditEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, audit enablers are returned that are currently active. In any status mode, active and inactive audit enablers are returned.
Parameters	`osid.id.IdList`	`auditEnablerIds`	the list of `Ids` to retrieve
Return	`osid.inquiry.rules.AuditEnablerList`		the returned `AuditEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`auditEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablersByGenusType
Description	Gets an `AuditEnablerList` corresponding to the given audit enabler genus `Type` which does not include audit enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known audit enablers or an error results. Otherwise, the returned list may contain only those audit enablers that are accessible through this session. In active mode, audit enablers are returned that are currently active. In any status mode, active and inactive audit enablers are returned.
Parameters	`osid.type.Type`	`auditEnablerGenusType`	an audit enabler genus type
Return	`osid.inquiry.rules.AuditEnablerList`		the returned `AuditEnabler` list
Errors	NULL_ARGUMENT		`auditEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablersByParentGenusType
Description	Gets an `AuditEnablerList` corresponding to the given audit enabler genus `Type` and include any additional audit enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known audit enablers or an error results. Otherwise, the returned list may contain only those audit enablers that are accessible through this session. In active mode, audit enablers are returned that are currently active. In any status mode, active and inactive audit enablers are returned.
Parameters	`osid.type.Type`	`auditEnablerGenusType`	an audit enabler genus type
Return	`osid.inquiry.rules.AuditEnablerList`		the returned `AuditEnabler` list
Errors	NULL_ARGUMENT		`auditEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablersByRecordType
Description	Gets an `AuditEnablerList` containing the given audit enabler record `Type.` In plenary mode, the returned list contains all known audit enablers or an error results. Otherwise, the returned list may contain only those audit enablers that are accessible through this session. In active mode, audit enablers are returned that are currently active. In any status mode, active and inactive audit enablers are returned.
Parameters	`osid.type.Type`	`auditEnablerRecordType`	an audit enabler record type
Return	`osid.inquiry.rules.AuditEnablerList`		the returned `AuditEnabler` list
Errors	NULL_ARGUMENT		`auditEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablersOnDate
Description	Gets an `AuditEnablerList` that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known audit enablers or an error results. Otherwise, the returned list may contain only those audit enablers that are accessible through this session. In active mode, audit enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive audit enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.inquiry.rules.AuditEnablerList`		the returned `AuditEnabler` 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	getAuditEnablersOnDateWithAgent
Description	Gets an `AuditEnablerList` that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known audit enablers or an error results. Otherwise, the returned list may contain only those audit enablers that are accessible through this session. In active mode, audit enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive audit enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.inquiry.rules.AuditEnablerList`		the returned `AuditEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablers
Description	Gets all `AuditEnablers.` In plenary mode, the returned list contains all known audit enablers or an error results. Otherwise, the returned list may contain only those audit enablers that are accessible through this session. In active mode, audit enablers are returned that are currently active. In any status mode, active and inactive audit enablers are returned.
Return	`osid.inquiry.rules.AuditEnablerList`		the returned `AuditEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.