public interface ResponseLookupSession extends OsidSession
This session defines methods for retrieving responses.
This lookup session defines several views:
Responses
with the ResponseAdminSession.
The methods useFederatedInquestView()
and
useIsolatedInquestView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Responses may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the responses.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupResponses()
Tests if this user can perform
Response lookups. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
Response |
getResponse(Id responseId)
Gets the
Response specified by its Id. |
ResponseList |
getResponses()
Gets all responses.
|
ResponseList |
getResponsesByGenusType(Type responseGenusType)
Gets a
ResponseList corresponding to the given response
genus Type which does not include responses of types
derived from the specified Type. |
ResponseList |
getResponsesByIds(IdList responseIds)
Gets a
ResponseList corresponding to the given
IdList. |
ResponseList |
getResponsesByParentGenusType(Type responseGenusType)
Gets a
ResponseList corresponding to the given response
genus Type and include any additional responses with
genus types derived from the specified Type. |
ResponseList |
getResponsesByRecordType(Type responseRecordType)
Gets a
ResponseList containing the given response
record Type. |
ResponseList |
getResponsesForInquiry(Id inquiry)
Gets a list of responses for an inquiry.
|
ResponseList |
getResponsesForInquiryAndResponder(Id inquiryId,
Id resourceId)
Gets a list of responses for an inquiry and responder.
|
ResponseList |
getResponsesForInquiryAndResponderOnDate(Id inquiryId,
Id resourceId,
DateTime from,
DateTime to)
Gets a list of responses for an inquiry and responder and effective
during the entire given date range inclusive but not confined to the
date range.
|
ResponseList |
getResponsesForInquiryOnDate(Id inquiry,
DateTime from,
DateTime to)
Gets a list of responses for the given inquiry effective during the
entire given date range inclusive but not confined to the date range.
|
ResponseList |
getResponsesForResponder(Id resourceId)
Gets a list of responses for a resource.
|
ResponseList |
getResponsesForResponderOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of responses for a resource and effective during the
entire given date range inclusive but not confined to the date range.
|
ResponseList |
getResponsesOnDate(DateTime from,
DateTime to)
Gets a list of responses effective during the entire given date range
inclusive but not confined to the date range.
|
void |
useAnyEffectiveResponseView()
All responses of any effective dates are returned by methods in this
session.
|
void |
useComparativeResponseView()
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 |
useEffectiveResponseView()
Only responses whose effective dates are current are returned by
methods in this session.
|
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
void |
usePlenaryResponseView()
A complete view of the
Response 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 canLookupResponses()
Response
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeResponseView()
mandatory
- This method is must be implemented. void usePlenaryResponseView()
Response
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. void useEffectiveResponseView()
mandatory
- This method is must be implemented. void useAnyEffectiveResponseView()
mandatory
- This method is must be implemented. Response getResponse(Id responseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Response
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Response
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Response
and retained for compatibility.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.responseId
- the Id
of the Response
to retrieve Response
NotFoundException
- no Response
found
with the given Id
NullArgumentException
- responseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesByIds(IdList responseIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ResponseList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
responses specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Responses
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.responseIds
- the list of Ids
to retrieve Response
listNotFoundException
- an Id
was not foundNullArgumentException
- responseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesByGenusType(Type responseGenusType) throws OperationFailedException, PermissionDeniedException
ResponseList
corresponding to the given response
genus Type
which does not include responses of types
derived from the specified Type.
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.responseGenusType
- a response genus type Response
listNullArgumentException
- responseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesByParentGenusType(Type responseGenusType) throws OperationFailedException, PermissionDeniedException
ResponseList
corresponding to the given response
genus Type
and include any additional responses with
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.responseGenusType
- a response genus type Response
listNullArgumentException
- responseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesByRecordType(Type responseRecordType) throws OperationFailedException, PermissionDeniedException
ResponseList
containing the given response
record Type.
In plenary mode, the returned list contains all known responses or an
error results. Otherwise, the returned list may contain only those
responses that are accessible through this session.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.responseRecordType
- a response record type Response
listNullArgumentException
- responseRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective responses and those currently expired are
returned.from
- start of date rangeto
- end of date range Response
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesForInquiry(Id inquiry) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.inquiry
- an inquiry Id
Response
listNullArgumentException
- inquiry
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesForInquiryOnDate(Id inquiry, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective responses and those currently expired are
returned.inquiry
- an inquiry Id
from
- start of date rangeto
- end of date range Response
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- inquiryId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesForResponder(Id resourceId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.resourceId
- a resource Id
Response
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesForResponderOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective responses and those currently expired are
returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range Response
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesForInquiryAndResponder(Id inquiryId, Id resourceId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned.inquiryId
- an inquiry Id
resourceId
- a resource Id
Response
listNullArgumentException
- inquiryId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponsesForInquiryAndResponderOnDate(Id inquiryId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
responses or an error results. Otherwise, the returned list may
contain only those responses that are accessible through this session.
In effective mode, responses are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective responses and those currently expired are
returned.inquiryId
- an inquiry Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range Response
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- inquiryId, resourceId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseList getResponses() throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all of the
responses including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Responses
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, responses are returned that are currently
effective. In any effective mode, effective responses and those
currently expired are returned. Response
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.