public interface CheckEngineSession extends OsidSession
This session provides methods to retrieve Check
to
Engine
mappings. A Check
may appear in
multiple Engine
objects. Each engine 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 |
canLookupCheckEngineMappings()
Tests if this user can perform lookups of hold/engine mappings.
|
IdList |
getCheckIdsByEngine(Id engineId)
Gets the list of
Check Ids associated with a
Engine. |
IdList |
getCheckIdsByEngines(IdList engineIds)
Gets the list of
Check Ids corresponding to a list of
Engines. |
CheckList |
getChecksByEngine(Id engineId)
Gets the list of
Checks associated with a
Engine. |
CheckList |
getChecksByEngines(IdList engineIds)
Gets the list of
Check corresponding to a list of
Engines. |
IdList |
getEngineIdsByCheck(Id checkId)
Gets the
Engine Ids mapped to a
Check. |
EngineList |
getEnginesByCheck(Id checkId)
Gets the
Engines mapped to a Check. |
void |
useComparativeCheckEngineView()
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 |
usePlenaryCheckEngineView()
A complete view of the
Check and Engine
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCheckEngineMappings()
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 useComparativeCheckEngineView()
mandatory
- This method is must be implemented. void usePlenaryCheckEngineView()
Check
and Engine
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 getCheckIdsByEngine(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Check Ids
associated with a
Engine.
engineId
- Id
of the Engine
Ids
NotFoundException
- engineId
is not
foundNullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CheckList getChecksByEngine(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Checks
associated with a
Engine.
engineId
- Id
of the Engine
NotFoundException
- engineId
is not
foundNullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCheckIdsByEngines(IdList engineIds) throws OperationFailedException, PermissionDeniedException
Check Ids
corresponding to a list of
Engines.
engineIds
- list of engine Ids
Ids
NullArgumentException
- engineIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CheckList getChecksByEngines(IdList engineIds) throws OperationFailedException, PermissionDeniedException
Check
corresponding to a list of
Engines.
engineIds
- list of engine Ids
NullArgumentException
- engineIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getEngineIdsByCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Engine
Ids
mapped to a
Check.
checkId
- Id
of a Check
NotFoundException
- checkId
is not foundNullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EngineList getEnginesByCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Engines
mapped to a Check.
checkId
- Id
of a Check
NotFoundException
- checkId
is not foundNullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.