public interface SequenceRuleEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply SequenceRuleEnablers
to SequenceRules.
a SequenceRule
with multiple SequenceRuleEnablers
means any positive rule
evaluation across the enablers result in an effective SequenceRule.
Modifier and Type | Method and Description |
---|---|
void |
assignSequenceRuleEnablerToSequenceRule(Id sequenceRuleEnablerId,
Id sequenceRuleId)
Adds an existing
SequenceRuleEnabler to a
SequenceRule. |
boolean |
canAssignSequenceRuleEnablers()
Tests if this user can alter sequence rule enabler/sequence rule
mappings.
|
boolean |
canSequenceSequenceRuleEnablers()
Tests if this user can order
SequenceRuleEnablers. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
moveSequenceRuleEnablerAhead(Id sequenceRuleEnablerId,
Id sequenceRuleId,
Id referenceId)
Reorders sequence rule enablers for a sequence rule by moving the
specified sequence rule enabler in front of a reference sequence rule
enabler.
|
void |
moveSequenceRuleEnablerBehind(Id sequenceRuleEnablerId,
Id sequenceRuleId,
Id referenceId)
Reorders sequence rule enablers for a sequence rule by moving the
specified sequence rule enabler behind a reference sequence rule
enabler.
|
void |
orderSequenceRuleEnablers(Id[] sequenceRuleEnablerIds,
Id sequenceRuleId)
Reorders a set of sequence rule enablers for a sequence rule.
|
void |
unassignSequenceRuleEnablerFromSequenceRule(Id sequenceRuleEnablerId,
Id sequenceRuleId)
Removes a
SequenceRuleEnabler from a
SequenceRule. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignSequenceRuleEnablers()
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 assignSequenceRuleEnablerToSequenceRule(Id sequenceRuleEnablerId, Id sequenceRuleId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleEnabler
to a
SequenceRule.
sequenceRuleEnablerId
- the Id
of the
SequenceRuleEnabler
sequenceRuleId
- the Id
of the
SequenceRule
AlreadyExistsException
- sequenceRuleEnablerId
is already applied to sequenceRuleId
NotFoundException
- sequenceRuleEnablerId
or sequenceRuleId
not foundNullArgumentException
- sequenceRuleEnablerId
or sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSequenceRuleEnablerFromSequenceRule(Id sequenceRuleEnablerId, Id sequenceRuleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleEnabler
from a
SequenceRule.
sequenceRuleEnablerId
- the Id
of the
SequenceRuleEnabler
sequenceRuleId
- the Id
of the
SequenceRule
NotFoundException
- sequenceRuleEnablerId
or sequenceRuleId
not found or
sequenceRuleEnablerId
not applied to
sequenceRuleId
NullArgumentException
- sequenceRuleEnablerId
or sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceSequenceRuleEnablers()
SequenceRuleEnablers.
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 SequenceRuleEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveSequenceRuleEnablerAhead(Id sequenceRuleEnablerId, Id sequenceRuleId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
sequenceRuleEnablerId
- the Id
of a
SequenceRuleEnabler
sequenceRuleId
- the Id
of a SequenceRule
referenceId
- the reference sequence rule enabler Id
NotFoundException
- sequenceRuleEnablerId,
sequenceRuleId,
or referenceId
not
found or, sequenceRuleEnablerId
or
referenceId
not related to sequenceRuleId
NullArgumentException
- sequenceRuleEnablerId,
sequenceRuleId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveSequenceRuleEnablerBehind(Id sequenceRuleEnablerId, Id sequenceRuleId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
sequenceRuleEnablerId
- the Id
of a
SequenceRuleEnabler
sequenceRuleId
- the Id
of a SequenceRule
referenceId
- the reference sequence rule enabler Id
NotFoundException
- sequenceRuleEnablerId,
sequenceRuleId,
or referenceId
not
found or, sequenceRuleEnablerId
or
referenceId
not related to sequenceRuleId
NullArgumentException
- sequenceRuleEnablerId,
sequenceRuleId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderSequenceRuleEnablers(Id[] sequenceRuleEnablerIds, Id sequenceRuleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
sequenceRuleEnablerIds
- the Ids
for a set of
SequenceRuleEnablers
sequenceRuleId
- the Id
of a SequenceRule
NotFoundException
- sequenceRuleId
not
found or, an sequenceRuleEnablerId
not related
to sequenceRuleId
NullArgumentException
- sequenceRuleEnablerIds
or sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.