Interface ActionEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActionEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply ActionEnablers to Actions . An Action with multiple ActionEnablers means any positive rule evaluation across the enablers result in an active Action .

Method Summary

Modifier and Type	Method	Description
void	assignActionEnablerToAction(Id actionEnablerId, Id actionId)	Adds an existing ActionEnabler to an Action .
boolean	canAssignActionEnablers()	Tests if this user can alter action enabler/action mappings.
boolean	canSequenceActionEnablers()	Tests if this user can order ActionEnablers .
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	moveActionEnablerAhead(Id actionEnablerId, Id actionId, Id referenceId)	Reorders action enablers for an action by moving the specified action enabler in front of a reference action enabler.
void	moveActionEnablerBehind(Id actionEnablerId, Id actionId, Id referenceId)	Reorders action enablers for an action by moving the specified action enabler behind a reference action enabler.
void	orderActionEnablers(Id[] actionEnablerIds, Id actionId)	Reorders a set of action enablers for an action.
void	unassignActionEnablerFromAction(Id actionEnablerId, Id actionId)	Removes an ActionEnabler from an Action .

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.

canAssignActionEnablers

boolean canAssignActionEnablers()

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

assignActionEnablerToAction

void assignActionEnablerToAction(Id actionEnablerId,
 Id actionId)
                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ActionEnabler to an Action .

Parameters:

actionEnablerId - the Id of the ActionEnabler

actionId - the Id of the Action

Throws:

AlreadyExistsException - actionEnablerId already applied to actionId

NotFoundException - actionEnablerId or actionId not found

NullArgumentException - actionEnablerId or actionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignActionEnablerFromAction

void unassignActionEnablerFromAction(Id actionEnablerId,
 Id actionId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an ActionEnabler from an Action .

Parameters:

actionEnablerId - the Id of the ActionEnabler

actionId - the Id of the Action

Throws:

NotFoundException - actionEnablerId or actionId not found or actionEnablerId not applied to actionId

NullArgumentException - actionEnablerId or actionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceActionEnablers

boolean canSequenceActionEnablers()

Tests if this user can order ActionEnablers . 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 ActionEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveActionEnablerAhead

void moveActionEnablerAhead(Id actionEnablerId,
 Id actionId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerId - the Id of an ActionEnabler

actionId - the Id of an Action

referenceId - the reference action enabler Id

Throws:

NotFoundException - actionEnablerId, actionId , or referenceId not found or, actionEnablerId or referenceId not related to actionId

NullArgumentException - actionEnablerId, actionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveActionEnablerBehind

void moveActionEnablerBehind(Id actionEnablerId,
 Id actionId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders action enablers for an action by moving the specified action enabler behind a reference action enabler.

Parameters:

actionEnablerId - the Id of an ActionEnabler

actionId - the Id of an Action

referenceId - the reference action enabler Id

Throws:

NotFoundException - actionEnablerId, actionId , or referenceId not found or, actionEnablerId or referenceId not related to actionId

NullArgumentException - actionEnablerId, actionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderActionEnablers

void orderActionEnablers(Id[] actionEnablerIds,
 Id actionId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of action enablers for an action.

Parameters:

actionEnablerIds - the Ids for a set of ActionEnablers

actionId - the Id of an Action

Throws:

NotFoundException - actionEnablerId not found or, an actionEnablerId not related to actionId

NullArgumentException - actionEnablerIds or actionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.