public interface SequenceRuleEnablerBankAssignmentSession extends OsidSession
This session provides methods to re-assign SequenceRuleEnabler
to Bank
mappings. a SequenceRuleEnabler
may appear in multiple Bank
objects and removing
the last reference to a SequenceRuleEnabler
is the
equivalent of deleting it. Each Bank
may have its own
authorizations governing who is allowed to operate on it.
Adding a reference of a SequenceRuleEnabler
to another
Bank
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSequenceRuleEnablerToBank(Id sequenceRuleEnablerId,
Id bankId)
Adds an existing
SequenceRuleEnabler to a Bank. |
boolean |
canAssignSequenceRuleEnablers()
Tests if this user can alter sequence rule enabler/bank mappings.
|
boolean |
canAssignSequenceRuleEnablersToBank(Id bankId)
Tests if this user can alter sequence rule enabler/bank mappings.
|
IdList |
getAssignableBankIds(Id bankId)
Gets a list of bank including and under the given bank node in which
any sequence rule enabler can be assigned.
|
IdList |
getAssignableBankIdsForSequenceRuleEnabler(Id bankId,
Id sequenceRuleEnablerId)
Gets a list of bank including and under the given bank node in which a
specific sequence rule enabler can be assigned.
|
void |
unassignSequenceRuleEnablerFromBank(Id sequenceRuleEnablerId,
Id bankId)
Removes a
SequenceRuleEnabler from a Bank. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignSequenceRuleEnablersToBank(Id bankId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.bankId
- the Id
of the Bank
false
if mapping is not authorized, true
otherwiseNullArgumentException
- bankId
is
null
mandatory
- This method must be implemented. IdList getAssignableBankIds(Id bankId) throws OperationFailedException
bankId
- the Id
of the Bank
Ids
NullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableBankIdsForSequenceRuleEnabler(Id bankId, Id sequenceRuleEnablerId) throws OperationFailedException
bankId
- the Id
of the Bank
sequenceRuleEnablerId
- the Id
of the
SequenceRuleEnabler
Ids
NullArgumentException
- bankId
or
sequenceRuleEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSequenceRuleEnablerToBank(Id sequenceRuleEnablerId, Id bankId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleEnabler
to a Bank.
sequenceRuleEnablerId
- the Id
of the
SequenceRuleEnabler
bankId
- the Id
of the Bank
AlreadyExistsException
- sequenceRuleEnablerId
is already assigned to bankId
NotFoundException
- sequenceRuleEnablerId
or bankId
not foundNullArgumentException
- sequenceRuleEnablerId
or bankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSequenceRuleEnablerFromBank(Id sequenceRuleEnablerId, Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleEnabler
from a Bank.
sequenceRuleEnablerId
- the Id
of the
SequenceRuleEnabler
bankId
- the Id
of the Bank
NotFoundException
- sequenceRuleEnablerId
or bankId
not found or
sequenceRuleEnablerId
not assigned to bankId
NullArgumentException
- sequenceRuleEnablerId
or bankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.