public interface CheckEngineAssignmentSession extends OsidSession
This session provides methods to re-assign Checks
to
Engine
mappings. A Check
may appear in
multiple Engine
objects and removing the last reference to
a Check
is the equivalent of deleting it. Each
Engine
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of a Check
to another Engine
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignCheckToEngine(Id checkId,
Id engineId)
Adds an existing
Check to a Engine. |
boolean |
canAssignChecks()
Tests if this user can alter hold/engine mappings.
|
boolean |
canAssignChecksToEngine(Id engineId)
Tests if this user can alter hold/engine mappings.
|
IdList |
getAssignableEngineIds(Id engineId)
Gets a list of engines including and under the given engine node in
which any check can be assigned.
|
IdList |
getAssignableEngineIdsForCheck(Id engineId,
Id checkId)
Gets a list of engines including and under the given engine node in
which a specific check can be assigned.
|
void |
unassignCheckFromEngine(Id checkId,
Id engineId)
Removes a
Check from a Engine. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignChecks()
PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignChecksToEngine(Id engineId)
PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer lookup operations to
unauthorized users.engineId
- the Id
of the Engine
false
if mapping is not authorized, true
otherwiseNullArgumentException
- engineId
is
null
mandatory
- This method must be implemented. IdList getAssignableEngineIds(Id engineId) throws OperationFailedException
engineId
- the Id
of the Engine
Ids
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableEngineIdsForCheck(Id engineId, Id checkId) throws OperationFailedException
engineId
- the Id
of the Engine
checkId
- the Id
of the Check
Ids
NullArgumentException
- engineId
or
checkId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignCheckToEngine(Id checkId, Id engineId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Check
to a Engine.
checkId
- the Id
of the Check
engineId
- the Id
of the Engine
AlreadyExistsException
- checkId
is
already assigned to engineId
NotFoundException
- checkId
or
engineId
not foundNullArgumentException
- checkId
or
engineId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCheckFromEngine(Id checkId, Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Check
from a Engine.
checkId
- the Id
of the Check
engineId
- the Id
of the Engine
NotFoundException
- checkId
or
engineId
not found or checkId
not
assigned to engineId
NullArgumentException
- checkId
or
engineId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.