public interface TriggerSystemAssignmentSession extends OsidSession
This session provides methods to re-assign Triggers
to
System
mappings. A Trigger
may appear in
multiple System
objects and removing the last reference to
a Trigger
is the equivalent of deleting it. Each
System
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of a Trigger
to another
System
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignTriggerToSystem(Id triggerId,
Id systemId)
Adds an existing
Trigger to a System. |
boolean |
canAssignTriggers()
Tests if this user can alter trigger/system mappings.
|
boolean |
canAssignTriggersToSystem(Id systemId)
Tests if this user can alter trigger/system mappings.
|
IdList |
getAssignableSystemIds(Id systemId)
Gets a list of systems including and under the given system node in
which any trigger can be assigned.
|
IdList |
getAssignableSystemIdsForTrigger(Id systemId,
Id triggerId)
Gets a list of systems including and under the given system node in
which a specific trigger can be assigned.
|
void |
reassignTriggerToSystem(Id triggerId,
Id fromSystemId,
Id toSystemId)
Moves a
Trigger from one System to
another. |
void |
unassignTriggerFromSystem(Id triggerId,
Id systemId)
Removes a
Trigger from a System. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignTriggers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignTriggersToSystem(Id systemId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.systemId
- the Id
of the System
false
if mapping is not authorized, true
otherwiseNullArgumentException
- systemId
is
null
mandatory
- This method must be implemented. IdList getAssignableSystemIds(Id systemId) throws OperationFailedException
systemId
- the Id
of the System
Ids
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableSystemIdsForTrigger(Id systemId, Id triggerId) throws OperationFailedException
systemId
- the Id
of the System
triggerId
- the Id
of the Trigger
Ids
NullArgumentException
- systemId
or
triggerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignTriggerToSystem(Id triggerId, Id systemId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Trigger
to a System.
triggerId
- the Id
of the Trigger
systemId
- the Id
of the System
AlreadyExistsException
- triggerId
is
already assigned to systemId
NotFoundException
- triggerId
or
systemId
not foundNullArgumentException
- triggerId
or
systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignTriggerFromSystem(Id triggerId, Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Trigger
from a System.
triggerId
- the Id
of the Trigger
systemId
- the Id
of the System
NotFoundException
- triggerId
or
systemId
not found or triggerId
not
assigned to systemId
NullArgumentException
- triggerId
or
systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignTriggerToSystem(Id triggerId, Id fromSystemId, Id toSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Trigger
from one System
to
another. Mappings to other Systems
are unaffected.triggerId
- the Id
of the Trigger
fromSystemId
- the Id
of the current
System
toSystemId
- the Id
of the destination
System
NotFoundException
- triggerId, fromSystemId,
or toSystemId
not found or
triggerId
not mapped to fromSystemId
NullArgumentException
- triggerId, fromSystemId,
or toSystemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.