Interface PoolConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PoolConstrainerEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply PoolConstrainerEnablers to PoolConstrainers. Multiple PoolConstrainerEnablers applied to an PoolConstrainer may be sequenced such that the first positive evaluation results in the PoolConstrainerEnabler used.

Method Summary

Modifier and Type	Method	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 an existing PoolConstrainerEnabler from a PoolConstrainer.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                    throws OperationFailedException,
PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignPoolConstrainerEnablers

boolean canAssignPoolConstrainerEnablers()

Tests if this user can alter pool constrainer enabler/pool constrainer mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignPoolConstrainerEnablerToPoolConstrainer

void assignPoolConstrainerEnablerToPoolConstrainer(Id poolConstrainerEnablerId,
 Id poolConstrainerId)
                                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing PoolConstrainerEnabler to a PoolConstrainer.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler

poolConstrainerId - the Id of the PoolConstrainer

Throws:

AlreadyExistsException - poolConstrainerEnablerId already applied to poolConstrainerId

NotFoundException - poolConstrainerEnablerId or poolConstrainerId not found

NullArgumentException - poolConstrainerEnablerId or poolConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPoolConstrainerEnablerFromPoolConstrainer

void unassignPoolConstrainerEnablerFromPoolConstrainer(Id poolConstrainerEnablerId,
 Id poolConstrainerId)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing PoolConstrainerEnabler from a PoolConstrainer.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler

poolConstrainerId - the Id of the PoolConstrainer

Throws:

NotFoundException - poolConstrainerEnablerId or poolConstrainerId not found or poolConstrainerEnablerId already applied to poolConstrainerId

NullArgumentException - poolConstrainerEnablerId or poolConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequencePoolConstrainerEnablers

boolean canSequencePoolConstrainerEnablers()

Tests if this user can order 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.

Returns:

false if PoolConstrainerEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

movePoolConstrainerEnablerAhead

void movePoolConstrainerEnablerAhead(Id poolConstrainerEnablerId,
 Id poolConstrainerId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders pool constrainer enablers for a pool constrainer by moving the specified pool constrainer enabler in front of a reference pool constrainer enabler.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler

poolConstrainerId - the Id of the PoolConstrainer

referenceId - the reference pool constrainer enabler Id

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

movePoolConstrainerEnablerBehind

void movePoolConstrainerEnablerBehind(Id poolConstrainerEnablerId,
 Id poolConstrainerId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders pool constrainer enablers for a pool constrainer by moving the specified pool constrainer enabler behind a reference pool constrainer enabler.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler

poolConstrainerId - the Id of the PoolConstrainer

referenceId - the reference pool constrainer Id

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderPoolConstrainerEnablers

void orderPoolConstrainerEnablers(Id[] poolConstrainerEnablerIds,
 Id poolConstrainerId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of pool constrainer enablers for a pool constrainer.

Parameters:

poolConstrainerEnablerIds - the Ids for a set of PoolConstrainerEnablers

poolConstrainerId - the Id of the PoolConstrainer

Throws:

NotFoundException - poolConstrainerId not found or, a poolConstrainerEnablerId not related to poolConstrainerId

NullArgumentException - poolConstrainerEnablerIds or poolConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.