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 a visible Value.
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignValueEnablers()
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. void assignValueEnablerToValue(Id valueEnablerId, Id valueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnabler
to a Value.
valueEnablerId
- the Id
of the
ValueEnabler
valueId
- the Id
of the Value
AlreadyExistsException
- valueEnablerId
is already applied to valueId
NotFoundException
- valueEnablerId
or
valueId
not foundNullArgumentException
- valueEnablerId
or valueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignValueEnablerFromValue(Id valueEnablerId, Id valueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnabler
from a Value.
valueEnablerId
- the Id
of the
ValueEnabler
valueId
- the Id
of the Value
NotFoundException
- valueEnablerId
or
valueId
not found or valueEnablerId
is not applied to valueId
NullArgumentException
- valueEnablerId
or valueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceValueEnablers()
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. false
if ValueEnabler
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveValueEnablerAhead(Id valueEnablerId, Id valueId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
valueEnablerId
- the Id
of a ValueEnabler
valueId
- the Id
of a Value
referenceId
- the reference value enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveValueEnablerBehind(Id valueEnablerId, Id valueId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
valueEnablerId
- the Id
of a ValueEnabler
valueId
- the Id
of a Value
referenceId
- the reference value enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderValueEnablers(Id[] valueEnablerIds, Id valueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
valueEnablerIds
- the Ids
for a set of
ValueEnablers
valueId
- the Id
of a Value
NotFoundException
- valueId
not found
or, a valueEnablerId
not related to
valueId
NullArgumentException
- valueEnablerIds
or valueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.