public interface BrokerConstrainerEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply BrokerConstrainerEnablers
to BrokerConstrainers.
A BrokerConstrainer
with multiple BrokerConstrainerEnablers
means any
positive rule evaluation across the enablers result in an effective
BrokerConstrainer.
Modifier and Type | Method and Description |
---|---|
void |
assignBrokerConstrainerEnablerToBrokerConstrainer(Id brokerConstrainerEnablerId,
Id brokerConstrainerId)
Adds an existing
BrokerConstrainerEnabler to a
BrokerConstrainer. |
boolean |
canAssignBrokerConstrainerEnablers()
Tests if this user can alter broker constrainer enabler/broker
constrainer mappings.
|
boolean |
canSequenceBrokerConstrainerEnablers()
Tests if this user can order
BrokerConstrainerEnablers. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
moveBrokerConstrainerEnablerAhead(Id brokerConstrainerEnablerId,
Id brokerConstrainerId,
Id referenceId)
Reorders broker constrainer enablers for a broker constrainer by
moving the specified broker constrainer enabler in front of a
reference broker constrainer.
|
void |
moveBrokerConstrainerEnablerBehind(Id brokerConstrainerEnablerId,
Id brokerConstrainerId,
Id referenceId)
Reorders broker constrainer enablers for a broker constrainer by
moving the specified broker constrainer enabler behind a reference
broker constrainer.
|
void |
orderBrokerConstrainerEnablers(Id[] brokerConstrainerEnablerIds,
Id brokerConstrainerId)
Reorders a set of broker constrainer enablers for a broker
constrainer.
|
void |
unassignBrokerConstrainerEnablerFromBrokerConstrainer(Id brokerConstrainerEnablerId,
Id brokerConstrainerId)
Removes a
BrokerConstrainerEnabler from a
BrokerConstrainer. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignBrokerConstrainerEnablers()
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 assignBrokerConstrainerEnablerToBrokerConstrainer(Id brokerConstrainerEnablerId, Id brokerConstrainerId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerEnabler
to a
BrokerConstrainer.
brokerConstrainerEnablerId
- the Id
of the
BrokerConstrainerEnabler
brokerConstrainerId
- the Id
of the
BrokerConstrainer
AlreadyExistsException
-
brokerConstrainerEnablerId
is already applied to
brokerConstrainerId
NotFoundException
- brokerConstrainerEnablerId
or brokerConstrainerId
not foundNullArgumentException
-
brokerConstrainerEnablerId
or
brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignBrokerConstrainerEnablerFromBrokerConstrainer(Id brokerConstrainerEnablerId, Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerEnabler
from a
BrokerConstrainer.
brokerConstrainerEnablerId
- the Id
of the
BrokerConstrainerEnabler
brokerConstrainerId
- the Id
of the
BrokerConstrainer
NotFoundException
- brokerConstrainerEnablerId
or brokerConstrainerId
not found or
brokerConstrainerEnablerId
not applied to
brokerConstrainerId
NullArgumentException
-
brokerConstrainerEnablerId
or
brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceBrokerConstrainerEnablers()
BrokerConstrainerEnablers.
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 BrokerConstrainerEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveBrokerConstrainerEnablerAhead(Id brokerConstrainerEnablerId, Id brokerConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
brokerConstrainerEnablerId
- the Id
of a
BrokerConstrainerEnabler
brokerConstrainerId
- the Id
of a
BrokerConstrainer
referenceId
- the reference broker constrainer enabler Id
NotFoundException
- brokerConstrainerEnablerId,
brokerConstrainerId,
or referenceId
not
found or, brokerConstrainerEnablerId
or
referenceId
not related to brokerConstrainerId
NullArgumentException
-
brokerConstrainerEnablerId, brokerConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveBrokerConstrainerEnablerBehind(Id brokerConstrainerEnablerId, Id brokerConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
brokerConstrainerEnablerId
- the Id
of a
BrokerConstrainerEnabler
brokerConstrainerId
- the Id
of a
BrokerConstrainer
referenceId
- the reference broker constrainer enabler Id
NotFoundException
- brokerConstrainerEnablerId,
brokerConstrainerId,
or referenceId
not
found or, brokerConstrainerEnablerId
or
referenceId
not related to brokerConstrainerId
NullArgumentException
-
brokerConstrainerEnablerId, brokerConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderBrokerConstrainerEnablers(Id[] brokerConstrainerEnablerIds, Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
brokerConstrainerEnablerIds
- the Ids
for a set
of BrokerConstrainerEnablers
brokerConstrainerId
- the Id
of a
BrokerConstrainer
NotFoundException
- brokerConstrainerId
not found or, a brokerConstrainerEnablerId
not
related to brokerConstrainerId
NullArgumentException
-
brokerConstrainerEnablerIds
or
brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.