public interface CheckLookupSession extends OsidSession
This session provides methods for retrieving Check
relationships.
This session defines views that offer differing behaviors when retrieving multiple objects.
Checks
with the CheckAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedEngineView()
and
useIsolatedEngineView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupChecks()
Tests if this user can perform
Check lookups. |
Check |
getCheck(Id checkId)
Gets the
Check specified by its Id. |
CheckList |
getChecks()
Gets all
Checks. |
CheckList |
getChecksByGenusType(Type holdGenusType)
Gets a
CheckList corresponding to the given check genus
Type which does not include checks of genus types
derived from the specified Type. |
CheckList |
getChecksByIds(IdList checkIds)
Gets a
CheckList corresponding to the given
IdList. |
CheckList |
getChecksByParentGenusType(Type holdGenusType)
Gets a
CheckList corresponding to the given check genus
Type and include any additional checks with genus types
derived from the specified Type. |
CheckList |
getChecksByRecordType(Type checkRecordType)
Gets a
CheckList containing the given check record
Type. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
void |
useActiveCheckView()
Only active checks are returned by methods in this session.
|
void |
useAnyStatusCheckView()
All active and inactive checks are returned by methods in this
session.
|
void |
useComparativeCheckView()
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 |
useFederatedEngineView()
Federates the view for methods in this session.
|
void |
useIsolatedEngineView()
Isolates the view for methods in this session.
|
void |
usePlenaryCheckView()
A complete view of the
Check returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupChecks()
Check
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 useComparativeCheckView()
mandatory
- This method is must be implemented. void usePlenaryCheckView()
Check
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 useFederatedEngineView()
mandatory
- This method is must be implemented. void useIsolatedEngineView()
mandatory
- This method is must be implemented. void useActiveCheckView()
mandatory
- This method is must be implemented. void useAnyStatusCheckView()
mandatory
- This method is must be implemented. Check getCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Check
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Check
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Check
and retained for compatibility.
In active mode, checks are returned that are currently active. In any
status mode, active and inactive checks are returned.checkId
- Id
of the Check
NotFoundException
- checkId
not foundNullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CheckList getChecksByIds(IdList checkIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CheckList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
checks 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 Checks
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, checks are returned that are currently active. In any
status mode, active and inactive checks are returned.checkIds
- the list of Ids
to retrieve Check
listNotFoundException
- an Id was
not foundNullArgumentException
- checkIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CheckList getChecksByGenusType(Type holdGenusType) throws OperationFailedException, PermissionDeniedException
CheckList
corresponding to the given check genus
Type
which does not include checks of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
checks or an error results. Otherwise, the returned list may contain
only those checks that are accessible through this session.
In active mode, checks are returned that are currently active. In any
status mode, active and inactive checks are returned.holdGenusType
- a check genus type Check
listNullArgumentException
- holdGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CheckList getChecksByParentGenusType(Type holdGenusType) throws OperationFailedException, PermissionDeniedException
CheckList
corresponding to the given check genus
Type
and include any additional checks with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
checks or an error results. Otherwise, the returned list may contain
only those checks that are accessible through this session.
In active mode, checks are returned that are currently active. In any
status mode, active and inactive checks are returned.holdGenusType
- a check genus type Check
listNullArgumentException
- holdGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CheckList getChecksByRecordType(Type checkRecordType) throws OperationFailedException, PermissionDeniedException
CheckList
containing the given check record
Type.
In plenary mode, the returned list contains all known
checks or an error results. Otherwise, the returned list may contain
only those checks that are accessible through this session.
In active mode, checks are returned that are currently active. In any
status mode, active and inactive checks are returned.checkRecordType
- a check record type Check
listNullArgumentException
- checkRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CheckList getChecks() throws OperationFailedException, PermissionDeniedException
Checks.
In plenary mode, the returned list contains all known checks or an
error results. Otherwise, the returned list may contain only those
checks that are accessible through this session.
In active mode, checks are returned that are currently active. In any
status mode, active and inactive checks are returned. Checks
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.