org.osid.control.rules

Interface TriggerEnablerSystemAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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 ).

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignTriggerEnablers

boolean canAssignTriggerEnablers()

Tests if this user can alter trigger enabler/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignTriggerEnablersToSystem

boolean canAssignTriggerEnablersToSystem(Id systemId)

Tests if this user can alter trigger enabler/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parameters:

systemId - the Id of the System

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - systemId is null

Compliance:

mandatory - This method must be implemented.

getAssignableSystemIds

IdList getAssignableSystemIds(Id systemId)
                              throws OperationFailedException

Gets a list of systems including and under the given system node in which any trigger enabler can be assigned.

Parameters:

systemId - the Id of the System

Returns:

list of assignable system Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableSystemIdsForTriggerEnabler

IdList getAssignableSystemIdsForTriggerEnabler(Id systemId,
                                             Id triggerEnablerId)
                                               throws OperationFailedException

Gets a list of systems including and under the given system node in which a specific trigger enabler can be assigned.

Parameters:

systemId - the Id of the System

triggerEnablerId - the Id of the TriggerEnabler

Returns:

list of assignable system Ids

Throws:

NullArgumentException - systemId or triggerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignTriggerEnablerToSystem

void assignTriggerEnablerToSystem(Id triggerEnablerId,
                                Id systemId)
                                  throws AlreadyExistsException,
                                         NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Adds an existing TriggerEnabler to a System.

Parameters:

triggerEnablerId - the Id of the TriggerEnabler

systemId - the Id of the System

Throws:

AlreadyExistsException - triggerEnablerId already assigned to systemId

NotFoundException - triggerEnablerId or systemId not found

NullArgumentException - triggerEnablerId or systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignTriggerEnablerFromSystem

void unassignTriggerEnablerFromSystem(Id triggerEnablerId,
                                    Id systemId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Removes a TriggerEnabler from a System.

Parameters:

triggerEnablerId - the Id of the TriggerEnabler

systemId - the Id of the System

Throws:

NotFoundException - triggerEnablerId or systemId not found or triggerEnablerId already assigned to systemId

NullArgumentException - triggerEnablerId or systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignTriggerEnablerToSystem

void reassignTriggerEnablerToSystem(Id triggerEnablerId,
                                  Id fromSystemId,
                                  Id toSystemId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Moves a TriggerEnabler from one System to another. Mappings to other Systems are unaffected.

Parameters:

triggerEnablerId - the Id of the TriggerEnabler

fromSystemId - the Id of the current System

toSystemId - the Id of the destination System

Throws:

NotFoundException - triggerEnablerId, fromSystemId, or toSystemId not found or triggerEnablerId not mapped to fromSystemId

NullArgumentException - triggerEnablerId, fromSystemId, or toSystemrId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.