public interface InquiryInquestSession extends OsidSession
This session provides methods to retrieve Inquiry
to
Inquest
mappings. An Inquiry
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 |
canLookupInquiryInquestMappings()
Tests if this user can perform lookups of inquiry/inquest mappings.
|
IdList |
getInquestIdsByInquiry(Id inquiryId)
Gets the
Inquest Ids mapped to an
Inquiry. |
InquestList |
getInquestsByInquiry(Id inquiryId)
Gets the
Inquests mapped to an Inquiry. |
InquiryList |
getInquiriesByInquest(Id inquestId)
Gets the list of
Inquiries associated with an
Inquest. |
InquiryList |
getInquiriesByInquests(IdList inquestIds)
Gets the list of
Inquiry corresponding to a list of
Inquests. |
IdList |
getInquiryIdsByInquest(Id inquestId)
Gets the list of
Inquiry Ids associated with an
Inquest. |
IdList |
getInquiryIdsByInquests(IdList inquestIds)
Gets the list of
Inquiry Ids corresponding to a list of
Inquests. |
void |
useComparativeInquiryInquestView()
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 |
usePlenaryInquiryInquestView()
A complete view of the
Inquiry and Inquest
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupInquiryInquestMappings()
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 useComparativeInquiryInquestView()
mandatory
- This method is must be implemented. void usePlenaryInquiryInquestView()
Inquiry
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 getInquiryIdsByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquiry Ids
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. InquiryList getInquiriesByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquiries
associated with an
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 getInquiryIdsByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
Inquiry 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. InquiryList getInquiriesByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
Inquiry
corresponding to a list of
Inquests.
inquestIds
- list of inquest Ids
NullArgumentException
- inquestIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getInquestIdsByInquiry(Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquest
Ids
mapped to an
Inquiry.
inquiryId
- Id
of an Inquiry
NotFoundException
- inquiryId
is not
foundNullArgumentException
- inquiryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestList getInquestsByInquiry(Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquests
mapped to an Inquiry.
inquiryId
- Id
of an Inquiry
NotFoundException
- inquiryId
is not
foundNullArgumentException
- inquiryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.