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

Interface	osid.inquiry.rules.InquiryEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session provides methods to retrieve `InquiryEnabler` to `Inquiry` mappings. An `Inquiry` with multiple `InquiryEnablers` means any positive rule evaluation across the enablers result in an effective `Inquiry`. 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 inquest view: All methods in this session operate, retrieve and pertain inquiry enablers defined explicitly in the current inquest federated inquest view: All 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.
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	canLookupInquiryEnablerRules
Description	Tests if this user can perform lookups of inquiry enabler/inquiry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeInquiryEnablerRuleView
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	usePlenaryInquiryEnablerRuleView
Description	A complete view of the `InquiryEnabler` and `Inquiry` 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	getInquiryEnablerIdsForInquiry
Description	Gets the `InquiryEnabler Id` associated with an `Inquiry`.
Parameters	`osid.id.Id`	`inquiryId`	`Id` of the `Inquiry`
Return	`osid.id.IdList`		the inquiry enabler `Ids`
Errors	NOT_FOUND		`inquiryId` is not found
	NULL_ARGUMENT		`inquiry` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryEnablersForInquiry
Description	Gets the `InquiryEnablers` associated with an `Inquiry`.
Parameters	`osid.id.Id`	`inquiryId`	`Id` of the `Inquiry`
Return	`osid.inquiry.rules.InquiryEnablerList`		the inquiry enablers
Errors	NOT_FOUND		`inquiryId` is not found
	NULL_ARGUMENT		`inquiryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryIdsForInquiryEnabler
Description	Gets the `Inquiry` `Ids` mapped to an `InquiryEnabler`.
Parameters	`osid.id.Id`	`inquiryEnablerId`	`Id` of an `InquiryEnabler`
Return	`osid.id.IdList`		list of inquiry `Ids`
Errors	NOT_FOUND		`inquiryEnablerId` is not found
	NULL_ARGUMENT		`inquiryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInquiriesForInquiryEnabler
Description	Gets the `Inquiries` mapped to an `InquiryEnabler`.
Parameters	`osid.id.Id`	`inquiryEnablerId`	`Id` of an `InquiryEnabler`
Return	`osid.inquiry.InquiryList`		list of inquiries
Errors	NOT_FOUND		`inquiryEnablerId` is not found
	NULL_ARGUMENT		`inquiryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.