Interface TriggerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TriggerEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply TriggerEnablers to Triggers . A Trigger with multiple TriggerEnablers means any positive rule evaluation across the enablers result in an effective Trigger .

Method Summary

Modifier and Type	Method	Description
void	assignTriggerEnablerToTrigger(Id triggerEnablerId, Id triggerId)	Adds an existing TriggerEnabler to a Trigger .
boolean	canAssignTriggerEnablers()	Tests if this user can alter trigger enabler/trigger mappings.
boolean	canSequenceTriggerEnablers()	Tests if this user can order TriggerEnablers .
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	moveTriggerEnablerAhead(Id triggerEnablerId, Id triggerId, Id referenceId)	Reorders trigger enablers for a trigger by moving the specified trigger enabler in front of a reference trigger enabler.
void	moveTriggerEnablerBehind(Id triggerEnablerId, Id triggerId, Id referenceId)	Reorders trigger enablers for a device by moving the specified trigger enabler behind a reference trigger enabler.
void	orderTriggerEnablers(Id[] triggerEnablerIds, Id triggerId)	Reorders a set of trigger enablers for a trigger.
void	unassignTriggerEnablerFromTrigger(Id triggerEnablerId, Id triggerId)	Removes a TriggerEnabler from a Trigger .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
          throws OperationFailedException,
PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignTriggerEnablers

boolean canAssignTriggerEnablers()

Tests if this user can alter trigger enabler/trigger 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.

assignTriggerEnablerToTrigger

void assignTriggerEnablerToTrigger(Id triggerEnablerId,
 Id triggerId)
                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing TriggerEnabler to a Trigger .

Parameters:

triggerEnablerId - the Id of the TriggerEnabler

triggerId - the Id of the Trigger

Throws:

AlreadyExistsException - triggerEnablerId already applied to triggerId

NotFoundException - triggerEnablerId or triggerId not found

NullArgumentException - triggerEnablerId or triggerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignTriggerEnablerFromTrigger

void unassignTriggerEnablerFromTrigger(Id triggerEnablerId,
 Id triggerId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a TriggerEnabler from a Trigger .

Parameters:

triggerEnablerId - the Id of the TriggerEnabler

triggerId - the Id of the Trigger

Throws:

NotFoundException - triggerEnablerId or triggerId not found or triggerEnablerId not applied to triggerId

NullArgumentException - triggerEnablerId or triggerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceTriggerEnablers

boolean canSequenceTriggerEnablers()

Tests if this user can order TriggerEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if TriggerEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveTriggerEnablerAhead

void moveTriggerEnablerAhead(Id triggerEnablerId,
 Id triggerId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders trigger enablers for a trigger by moving the specified trigger enabler in front of a reference trigger enabler.

Parameters:

triggerEnablerId - the Id of a TriggerEnabler

triggerId - the Id of a Trigger

referenceId - the reference trigger enabler Id

Throws:

NotFoundException - triggerEnablerId, triggerId , or referenceId not found or, triggerEnablerId or referenceId not related to triggerId

NullArgumentException - triggerEnablerId, triggerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveTriggerEnablerBehind

void moveTriggerEnablerBehind(Id triggerEnablerId,
 Id triggerId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders trigger enablers for a device by moving the specified trigger enabler behind a reference trigger enabler.

Parameters:

triggerEnablerId - the Id of a TriggerEnabler

triggerId - the Id of a Trigger

referenceId - the reference trigger enabler Id

Throws:

NotFoundException - triggerEnablerId, triggerId , or referenceId not found or, triggerEnablerId or referenceId not related to triggerId

NullArgumentException - triggerEnablerId, triggerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderTriggerEnablers

void orderTriggerEnablers(Id[] triggerEnablerIds,
 Id triggerId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of trigger enablers for a trigger.

Parameters:

triggerEnablerIds - the Ids for a set of TriggerEnablers

triggerId - the Id of a Trigger

Throws:

NotFoundException - triggerId not found or, a triggerEnablerId not related to triggerId

NullArgumentException - triggerEnablerIds or triggerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.