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

Interface	osid.inquiry.rules.InquiryEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `InquiryEnablers.` 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 inquiry enabler methods in this session operate, retrieve and pertain to inquiry enablers defined explicitly in the current inquest. Using an isolated view is useful for managing `InquiryEnablers` with the `InquiryEnablerAdminSession.` federated inquest view: All inquiry enabler methods in this session operate, retrieve and pertain to all inquiry enablers defined in this inquest and any other inquiry enablers implicitly available in this inquest through inquest inheritence. activee inquiry enabler view: All inquiry enabler lookup methods return active inquiry enablers. any status inquiry enabler view: inquiry 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	canLookupInquiryEnablers
Description	Tests if this user can perform `InquiryEnablers` 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	useComparativeInquiryEnablerView
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	usePlenaryInquiryEnablerView
Description	A complete view of the `InquiryEnabler` 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 inquiry 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	useActiveInquiryEnablerView
Description	Only active inquiry enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusInquiryEnablerView
Description	All active and inactive inquiry enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getInquiryEnabler
Description	Gets the `InquiryEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `InquiryEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `InquiryEnabler` and retained for compatibility. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.
Parameters	`osid.id.Id`	`inquiryEnablerId`	`Id` of the `InquiryEnabler`
Return	`osid.inquiry.rules.InquiryEnabler`		the inquiry enabler
Errors	NOT_FOUND		`inquiryEnablerId` not found
	NULL_ARGUMENT		`inquiryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getInquiryEnablersByIds
Description	Gets an `InquiryEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the inquiry 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 `InquiryEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.
Parameters	`osid.id.IdList`	`inquiryEnablerIds`	the list of `Ids` to retrieve
Return	`osid.inquiry.rules.InquiryEnablerList`		the returned `InquiryEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`inquiryEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryEnablersByGenusType
Description	Gets an `InquiryEnablerList` corresponding to the given inquiry enabler genus `Type` which does not include inquiry enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.
Parameters	`osid.type.Type`	`inquiryEnablerGenusType`	an inquiry enabler genus type
Return	`osid.inquiry.rules.InquiryEnablerList`		the returned `InquiryEnabler` list
Errors	NULL_ARGUMENT		`inquiryEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryEnablersByParentGenusType
Description	Gets an `InquiryEnablerList` corresponding to the given inquiry enabler genus `Type` and include any additional inquiry enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.
Parameters	`osid.type.Type`	`inquiryEnablerGenusType`	an inquiry enabler genus type
Return	`osid.inquiry.rules.InquiryEnablerList`		the returned `InquiryEnabler` list
Errors	NULL_ARGUMENT		`inquiryEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryEnablersByRecordType
Description	Gets an `InquiryEnablerList` containing the given inquiry enabler record `Type.` In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.
Parameters	`osid.type.Type`	`inquiryEnablerRecordType`	an inquiry enabler record type
Return	`osid.inquiry.rules.InquiryEnablerList`		the returned `InquiryEnabler` list
Errors	NULL_ARGUMENT		`inquiryEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryEnablersOnDate
Description	Gets an `InquiryEnablerList` 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 inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive inquiry enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.inquiry.rules.InquiryEnablerList`		the returned `InquiryEnabler` 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	getInquiryEnablersOnDateWithAgent
Description	Gets an `InquiryEnablerList` 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 inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive inquiry 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.InquiryEnablerList`		the returned `InquiryEnabler` 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	getInquiryEnablers
Description	Gets all `InquiryEnablers.` In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.
Return	`osid.inquiry.rules.InquiryEnablerList`		the returned `InquiryEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.