public interface ResponseInquestSession extends OsidSession
This session provides methods to retrieve Response
to
Inquest
responses. A Response
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 |
canLookupResponseInquestResponses()
Tests if this user can perform lookups of response/inquest mappings.
|
IdList |
getInquestIdsByResponse(Id responseId)
Gets the
Inquest Ids mapped to a
Response. |
InquestList |
getInquestsByResponse(Id responseId)
Gets the
Inquests mapped to a Response. |
IdList |
getResponseIdsByInquest(Id inquestId)
Gets the list of
Response Ids associated with a
Inquest. |
IdList |
getResponseIdsByInquests(IdList inquestIds)
Gets the list of
Response Ids corresponding to a list
of Inquests. |
ResponseList |
getResponsesByInquest(Id inquestId)
Gets the list of
Responses associated with a
Inquest. |
ResponseList |
getResponsesByInquests(IdList inquestIds)
Gets the list of
Responses corresponding to a list of
Inquests. |
void |
useComparativeResponseInquestView()
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 |
usePlenaryResponseInquestView()
A complete view of the
Response and Inquest
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupResponseInquestResponses()
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 responses is not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeResponseInquestView()
mandatory
- This method is must be implemented. void usePlenaryResponseInquestView()
Response
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 getResponseIdsByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Response Ids
associated with a
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. ResponseList getResponsesByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Responses
associated with a
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 getResponseIdsByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
Response 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. ResponseList getResponsesByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
Responses
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 getInquestIdsByResponse(Id responseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquest
Ids
mapped to a
Response.
responseId
- Id
of a Response
NotFoundException
- responseId
is not
foundNullArgumentException
- responseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestList getInquestsByResponse(Id responseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquests
mapped to a Response.
responseId
- Id
of a Response
NotFoundException
- responseId
is not
foundNullArgumentException
- responseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.