public interface InquiryEnablerInquestSession extends OsidSession
This session provides methods to retrieve InquiryEnabler
to Inquest
mappings. An InquiryEnabler
may
appear in multiple Inquest
objects. Each inquest may have
its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInquiryEnablerInquestMappings()
Tests if this user can perform lookups of inquiry enabler/inquest
mappings.
|
IdList |
getInquestIdsByInquiryEnabler(Id inquiryEnablerId)
Gets the
Inquest Ids mapped to an
InquiryEnabler. |
InquestList |
getInquestsByInquiryEnabler(Id inquiryEnablerId)
Gets the
Inquests mapped to an InquiryEnabler. |
IdList |
getInquiryEnablerIdsByInquest(Id inquestId)
Gets the list of
InquiryEnablerIds associated with an
Inquest. |
IdList |
getInquiryEnablerIdsByInquests(IdList inquestIds)
Gets the list of
InquiryEnabler Ids corresponding to a
list of Inquests. |
InquiryEnablerList |
getInquiryEnablersByInquest(Id inquestId)
Gets the list of inquiry enablers associated with an
Inquest. |
InquiryEnablerList |
getInquiryEnablersByInquests(IdList inquestIds)
Gets the list of inquiry enablers corresponding to a list of
Inquests. |
void |
useComparativeInquiryEnablerInquestView()
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 |
usePlenaryInquiryEnablerInquestView()
A complete view of the
InquiryEnabler and
Inquest returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupInquiryEnablerInquestMappings()
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 useComparativeInquiryEnablerInquestView()
mandatory
- This method is must be implemented. void usePlenaryInquiryEnablerInquestView()
InquiryEnabler
and
Inquest
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. IdList getInquiryEnablerIdsByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InquiryEnablerIds
associated with an
Inquest.
inquestId
- Id
of the Inquest
Ids
NotFoundException
- inquestId
is not
foundNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryEnablerList getInquiryEnablersByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquest.
inquestId
- Id
of the Inquest
NotFoundException
- inquestId
is not
foundNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getInquiryEnablerIdsByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
InquiryEnabler Ids
corresponding to a
list of Inquests.
inquestIds
- list of inquest Ids
Ids
NullArgumentException
- inquestIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryEnablerList getInquiryEnablersByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
Inquests.
inquestIds
- list of inquest Ids
NullArgumentException
- inquestIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getInquestIdsByInquiryEnabler(Id inquiryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquest
Ids
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. InquestList getInquestsByInquiryEnabler(Id inquiryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquests
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.