public interface InquiryEnablerRuleLookupSession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInquiryEnablerRules()
Tests if this user can perform lookups of inquiry enabler/inquiry
mappings.
|
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
InquiryList |
getInquiriesForInquiryEnabler(Id inquiryEnablerId)
Gets the
Inquiries mapped to an InquiryEnabler. |
IdList |
getInquiryEnablerIdsForInquiry(Id inquiryId)
Gets the
InquiryEnabler Id associated with an
Inquiry. |
InquiryEnablerList |
getInquiryEnablersForInquiry(Id inquiryId)
Gets the
InquiryEnablers associated with an
Inquiry. |
IdList |
getInquiryIdsForInquiryEnabler(Id inquiryEnablerId)
Gets the
Inquiry Ids mapped to an
InquiryEnabler. |
void |
useComparativeInquiryEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
void |
usePlenaryInquiryEnablerRuleView()
A complete view of the
InquiryEnabler and
Inquiry returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupInquiryEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeInquiryEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryInquiryEnablerRuleView()
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.mandatory
- This method is must be implemented. void useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. IdList getInquiryEnablerIdsForInquiry(Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InquiryEnabler Id
associated with an
Inquiry.
inquiryId
- Id
of the Inquiry
Ids
NotFoundException
- inquiryId
is not
foundNullArgumentException
- inquiry
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryEnablerList getInquiryEnablersForInquiry(Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InquiryEnablers
associated with an
Inquiry.
inquiryId
- Id
of the Inquiry
NotFoundException
- inquiryId
is not
foundNullArgumentException
- inquiryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getInquiryIdsForInquiryEnabler(Id inquiryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquiry
Ids
mapped to an
InquiryEnabler.
inquiryEnablerId
- Id
of an InquiryEnabler
Ids
NotFoundException
- inquiryEnablerId
is
not foundNullArgumentException
- inquiryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryList getInquiriesForInquiryEnabler(Id inquiryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquiries
mapped to an InquiryEnabler.
inquiryEnablerId
- Id
of an InquiryEnabler
NotFoundException
- inquiryEnablerId
is
not foundNullArgumentException
- inquiryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.