public interface TriggerEnablerSystemAssignmentSession extends OsidSession
This session provides methods to re-assign TriggerEnabler
to System
mappings. A TriggerEnabler
may appear in multiple System
objects and removing the last
reference to a TriggerEnabler
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 TriggerEnabler
to another
System
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignTriggerEnablerToSystem(Id triggerEnablerId,
Id systemId)
Adds an existing
TriggerEnabler to a System. |
boolean |
canAssignTriggerEnablers()
Tests if this user can alter trigger enabler/system mappings.
|
boolean |
canAssignTriggerEnablersToSystem(Id systemId)
Tests if this user can alter trigger enabler/system mappings.
|
IdList |
getAssignableSystemIds(Id systemId)
Gets a list of systems including and under the given system node in
which any trigger enabler can be assigned.
|
IdList |
getAssignableSystemIdsForTriggerEnabler(Id systemId,
Id triggerEnablerId)
Gets a list of systems including and under the given system node in
which a specific trigger enabler can be assigned.
|
void |
reassignTriggerEnablerToSystem(Id triggerEnablerId,
Id fromSystemId,
Id toSystemId)
Moves a
TriggerEnabler from one System
to another. |
void |
unassignTriggerEnablerFromSystem(Id triggerEnablerId,
Id systemId)
Removes a
TriggerEnabler from a System. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignTriggerEnablers()
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 canAssignTriggerEnablersToSystem(Id systemId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup 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
- systemIds
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableSystemIdsForTriggerEnabler(Id systemId, Id triggerEnablerId) throws OperationFailedException
systemId
- the Id
of the System
triggerEnablerId
- the Id
of the
TriggerEnabler
Ids
NullArgumentException
- systemId
or
triggerEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignTriggerEnablerToSystem(Id triggerEnablerId, Id systemId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnabler
to a System.
triggerEnablerId
- the Id
of the
TriggerEnabler
systemId
- the Id
of the System
AlreadyExistsException
- triggerEnablerId
already assigned to systemId
NotFoundException
- triggerEnablerId
or
systemId
not foundNullArgumentException
- triggerEnablerId
or systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignTriggerEnablerFromSystem(Id triggerEnablerId, Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnabler
from a System.
triggerEnablerId
- the Id
of the
TriggerEnabler
systemId
- the Id
of the System
NotFoundException
- triggerEnablerId
or
systemId
not found or triggerEnablerId
already assigned to systemId
NullArgumentException
- triggerEnablerId
or systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignTriggerEnablerToSystem(Id triggerEnablerId, Id fromSystemId, Id toSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnabler
from one System
to another. Mappings to other Systems
are unaffected.triggerEnablerId
- the Id
of the
TriggerEnabler
fromSystemId
- the Id
of the current
System
toSystemId
- the Id
of the destination
System
NotFoundException
- triggerEnablerId,
fromSystemId,
or toSystemId
not found
or triggerEnablerId
not mapped to
fromSystemId
NullArgumentException
- triggerEnablerId,
fromSystemId,
or toSystemrId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.