public interface InquestLookupSession extends OsidSession
This session provides methods for retrieving Inquest
objects.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the
Inquests
it can access, without breaking execution. However, an
assessment may only be useful if all Inquests
referenced by
it are available, and a test-taking application may sacrifice some
interoperability for the sake of precision.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInquests()
Tests if this user can perform
Inquest lookups. |
Inquest |
getInquest(Id inquestId)
Gets the
Inquest specified by its Id. |
InquestList |
getInquests()
Gets all
Inquests. |
InquestList |
getInquestsByGenusType(Type inquestGenusType)
Gets an
InquestList corresponding to the given inquest
genus Type which does not include inquests of types
derived from the specified Type. |
InquestList |
getInquestsByIds(IdList inquestIds)
Gets an
InquestList corresponding to the given
IdList. |
InquestList |
getInquestsByParentGenusType(Type inquestGenusType)
Gets an
InquestList corresponding to the given inquest
genus Type and include any additional inquests with
genus types derived from the specified Type. |
InquestList |
getInquestsByProvider(Id resourceId)
Gets an
InquestList for the given provider. |
InquestList |
getInquestsByRecordType(Type inquestRecordType)
Gets an
InquestList containing the given inquest record
Type. |
void |
useComparativeInquestView()
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 |
usePlenaryInquestView()
A complete view of the
Inquest returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupInquests()
Inquest
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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeInquestView()
mandatory
- This method is must be implemented. void usePlenaryInquestView()
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. Inquest getInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquest
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Inquest
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to an
Inquest
and retained for compatibility.inquestId
- Id
of the Inquest
NotFoundException
- inquestId
not foundNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. InquestList getInquestsByIds(IdList inquestIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
InquestList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
inquests 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 Inquests
may be omitted from the list and
may present the elements in any order including returning a unique
set.inquestIds
- the list of Ids
to retrieve Inquest
listNotFoundException
- an Id
was not foundNullArgumentException
- inquestIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestList getInquestsByGenusType(Type inquestGenusType) throws OperationFailedException, PermissionDeniedException
InquestList
corresponding to the given inquest
genus Type
which does not include inquests of types
derived from the specified Type.
In plenary mode, the
returned list contains all known inquests or an error results.
Otherwise, the returned list may contain only those inquests that are
accessible through this session.inquestGenusType
- an inquest genus type Inquest
listNullArgumentException
- inquestGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestList getInquestsByParentGenusType(Type inquestGenusType) throws OperationFailedException, PermissionDeniedException
InquestList
corresponding to the given inquest
genus Type
and include any additional inquests with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known inquests or an error
results. Otherwise, the returned list may contain only those inquests
that are accessible through this session.inquestGenusType
- an inquest genus type Inquest
listNullArgumentException
- inquestGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestList getInquestsByRecordType(Type inquestRecordType) throws OperationFailedException, PermissionDeniedException
InquestList
containing the given inquest record
Type.
In plenary mode, the returned list contains all
known inquests or an error results. Otherwise, the returned list may
contain only those inquests that are accessible through this session.inquestRecordType
- an inquest record type Inquest
listNullArgumentException
- inquestRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestList getInquestsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
InquestList
for the given provider. In plenary
mode, the returned list contains all known inquests or an error
results. Otherwise, the returned list may contain only those inquests
that are accessible through this session.resourceId
- a resource Id Inquest
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquestList getInquests() throws OperationFailedException, PermissionDeniedException
Inquests.
In plenary mode, the returned list
contains all known inquests or an error results. Otherwise, the
returned list may contain only those inquests that are accessible
through this session. Inquests
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.