public interface PoolConstrainerEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply PoolConstrainerEnablers
to PoolConstrainers.
A PoolConstrainer
with multiple PoolConstrainerEnablers
means any
positive rule evaluation across the enablers result in an effective
PoolConstrainer.
Modifier and Type | Method and Description |
---|---|
void |
assignPoolConstrainerEnablerToPoolConstrainer(Id poolConstrainerEnablerId,
Id poolConstrainerId)
Adds an existing
PoolConstrainerEnabler to a
PoolConstrainer. |
boolean |
canAssignPoolConstrainerEnablers()
Tests if this user can alter pool constrainer enabler/pool constrainer
mappings.
|
boolean |
canSequencePoolConstrainerEnablers()
Tests if this user can order
PoolConstrainerEnablers. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
movePoolConstrainerEnablerAhead(Id poolConstrainerEnablerId,
Id poolConstrainerId,
Id referenceId)
Reorders pool constrainer enablers for a pool constrainer by moving
the specified pool constrainer enabler in front of a reference pool
constrainer enabler.
|
void |
movePoolConstrainerEnablerBehind(Id poolConstrainerEnablerId,
Id poolConstrainerId,
Id referenceId)
Reorders pool constrainer enablers for a pool constrainer by moving
the specified pool constrainer enabler behind a reference pool
constrainer enabler.
|
void |
orderPoolConstrainerEnablers(Id[] poolConstrainerEnablerIds,
Id poolConstrainerId)
Reorders a set of pool constrainer enablers for a pool constrainer.
|
void |
unassignPoolConstrainerEnablerFromPoolConstrainer(Id poolConstrainerEnablerId,
Id poolConstrainerId)
Removes a
PoolConstrainerEnabler from a
PoolConstrainer. |
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 canAssignPoolConstrainerEnablers()
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 assignPoolConstrainerEnablerToPoolConstrainer(Id poolConstrainerEnablerId, Id poolConstrainerId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerEnabler
to a
PoolConstrainer.
poolConstrainerEnablerId
- the Id
of the
PoolConstrainerEnabler
poolConstrainerId
- the Id
of the
PoolConstrainer
AlreadyExistsException
-
poolConstrainerEnablerId
is already applied to
poolConstrainerId
NotFoundException
- poolConstrainerEnablerId
or poolConstrainerId
not foundNullArgumentException
- poolConstrainerEnablerId
or poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignPoolConstrainerEnablerFromPoolConstrainer(Id poolConstrainerEnablerId, Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerEnabler
from a
PoolConstrainer.
poolConstrainerEnablerId
- the Id
of the
PoolConstrainerEnabler
poolConstrainerId
- the Id
of the
PoolConstrainer
NotFoundException
- poolConstrainerEnablerId
or poolConstrainerId
not found or
poolConstrainerEnablerId
not applied to
poolConstrainerId
NullArgumentException
- poolConstrainerEnablerId
or poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequencePoolConstrainerEnablers()
PoolConstrainerEnablers.
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 PoolConstrainerEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void movePoolConstrainerEnablerAhead(Id poolConstrainerEnablerId, Id poolConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerEnablerId
- the Id
of a
PoolConstrainerEnabler
poolConstrainerId
- the Id
of a
PoolConstrainer
referenceId
- the reference pool constrainer enabler Id
NotFoundException
- poolConstrainerEnablerId,
poolConstrainerId,
or referenceId
not
found or, poolConstrainerEnablerId
or
referenceId
not related to poolConstrainerId
NullArgumentException
-
poolConstrainerEnablerId, poolConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void movePoolConstrainerEnablerBehind(Id poolConstrainerEnablerId, Id poolConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerEnablerId
- the Id
of a
PoolConstrainerEnabler
poolConstrainerId
- the Id
of a
PoolConstrainer
referenceId
- the reference pool constrainer enabler Id
NotFoundException
- poolConstrainerEnablerId,
poolConstrainerId,
or referenceId
not
found or, poolConstrainerEnablerId
or
referenceId
not related to poolConstrainerId
NullArgumentException
-
poolConstrainerEnablerId, poolConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderPoolConstrainerEnablers(Id[] poolConstrainerEnablerIds, Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerEnablerIds
- the Ids
for a set of
PoolConstrainerEnablers
poolConstrainerId
- the Id
of a
PoolConstrainer
NotFoundException
- poolConstrainerId
not found or, a poolConstrainerEnablerId
not
related to poolConstrainerId
NullArgumentException
-
poolConstrainerEnablerIds
or poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.