Interface ValueEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ValueEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply ValueEnablers to Values . A Value with multiple ValueEnablers means any positive rule evaluation across the enablers result in a visible Value .

Method Summary

Modifier and Type	Method	Description
void	assignValueEnablerToValue(Id valueEnablerId, Id valueId)	Adds an existing ValueEnabler to a Value .
boolean	canAssignValueEnablers()	Tests if this user can alter value enabler/value mappings.
boolean	canSequenceValueEnablers()	Tests if this user can order ValueEnablers .
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
void	moveValueEnablerAhead(Id valueEnablerId, Id valueId, Id referenceId)	Reorders value enablers for a value by moving the specified value enabler in front of a reference value enabler.
void	moveValueEnablerBehind(Id valueEnablerId, Id valueId, Id referenceId)	Reorders value enablers for a value by moving the specified value enabler behind a reference value enabler.
void	orderValueEnablers(Id[] valueEnablerIds, Id valueId)	Reorders a set of value enablers for a value.
void	unassignValueEnablerFromValue(Id valueEnablerId, Id valueId)	Removes a ValueEnabler from a Value .

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

getConfigurationId

Id getConfigurationId()

Gets the Configuration Id associated with this session.

Returns:

the Configuration Id associated with this session

Compliance:

mandatory - This method must be implemented.

getConfiguration

Configuration getConfiguration()
                        throws OperationFailedException,
PermissionDeniedException

Gets the Configuration associated with this session.

Returns:

the configuration

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignValueEnablers

boolean canAssignValueEnablers()

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

assignValueEnablerToValue

void assignValueEnablerToValue(Id valueEnablerId,
 Id valueId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ValueEnabler to a Value .

Parameters:

valueEnablerId - the Id of the ValueEnabler

valueId - the Id of the Value

Throws:

AlreadyExistsException - valueEnablerId is already applied to valueId

NotFoundException - valueEnablerId or valueId not found

NullArgumentException - valueEnablerId or valueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignValueEnablerFromValue

void unassignValueEnablerFromValue(Id valueEnablerId,
 Id valueId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a ValueEnabler from a Value .

Parameters:

valueEnablerId - the Id of the ValueEnabler

valueId - the Id of the Value

Throws:

NotFoundException - valueEnablerId or valueId not found or valueEnablerId is not applied to valueId

NullArgumentException - valueEnablerId or valueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceValueEnablers

boolean canSequenceValueEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveValueEnablerAhead

void moveValueEnablerAhead(Id valueEnablerId,
 Id valueId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

valueEnablerId - the Id of a ValueEnabler

valueId - the Id of a Value

referenceId - the reference value enabler Id

Throws:

NotFoundException - valueEnabelrId, valueId , or referenceId not found or, valueEnablerId , or referenceId not related to valueId

NullArgumentException - valueEnablerId, valueId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveValueEnablerBehind

void moveValueEnablerBehind(Id valueEnablerId,
 Id valueId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

valueEnablerId - the Id of a ValueEnabler

valueId - the Id of a Value

referenceId - the reference value enabler Id

Throws:

NotFoundException - valueEnabelrId, valueId , or referenceId not found or, valueEnablerId , or referenceId not related to valueId

NullArgumentException - valueEnablerId, valueId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderValueEnablers

void orderValueEnablers(Id[] valueEnablerIds,
 Id valueId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of value enablers for a value.

Parameters:

valueEnablerIds - the Ids for a set of ValueEnablers

valueId - the Id of a Value

Throws:

NotFoundException - valueId not found or, a valueEnablerId not related to valueId

NullArgumentException - valueEnablerIds or valueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.