Interface PoolEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PoolEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply PoolEnablers to Pools. Multiple PoolEnablers applied to an Pool may be sequenced such that the first positive evaluation results in the PoolEnablers used.

Method Summary

Modifier and Type	Method	Description
void	assignPoolEnablerToPool(Id poolEnablerId, Id poolId)	Adds an existing PoolEnabler to a Pool.
boolean	canAssignPoolEnablers()	Tests if this user can alter pool enabler/pool mappings.
boolean	canSequencePoolEnablers()	Tests if this user can order PoolEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	movePoolEnablerAhead(Id poolEnablerId, Id poolId, Id referenceId)	Reorders pool enablers for a pool by moving the specified pool enabler in front of a reference pool enabler.
void	movePoolEnablerBehind(Id poolEnablerId, Id poolId, Id referenceId)	Reorders pool enablers for a pool by moving the specified pool enabler behind a reference pool enabler.
void	orderPoolEnablers(Id[] poolEnablerIds, Id poolId)	Reorders a set of pool enablers for a pool.
void	unassignPoolEnablerFromPool(Id poolEnablerId, Id poolId)	Removes an existing PoolEnabler from a Pool.

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.

canAssignPoolEnablers

boolean canAssignPoolEnablers()

Tests if this user can alter pool enabler/pool 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.

assignPoolEnablerToPool

void assignPoolEnablerToPool(Id poolEnablerId,
 Id poolId)
                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing PoolEnabler to a Pool.

Parameters:

poolEnablerId - the Id of the PoolEnabler

poolId - the Id of the Pool

Throws:

AlreadyExistsException - poolEnablerId already applied to poolId

NotFoundException - poolEnablerId or poolId not found

NullArgumentException - poolEnablerId or poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPoolEnablerFromPool

void unassignPoolEnablerFromPool(Id poolEnablerId,
 Id poolId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing PoolEnabler from a Pool.

Parameters:

poolEnablerId - the Id of the PoolEnabler

poolId - the Id of the Pool

Throws:

NotFoundException - poolEnablerId or poolId not found or poolEnablerId already applied to poolId

NullArgumentException - poolEnablerId or poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequencePoolEnablers

boolean canSequencePoolEnablers()

Tests if this user can order PoolEnablers. 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 PoolEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

movePoolEnablerAhead

void movePoolEnablerAhead(Id poolEnablerId,
 Id poolId,
 Id referenceId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

poolEnablerId - the Id of the PoolEnabler

poolId - the Id of the Pool

referenceId - the reference pool enabler Id

Throws:

NotFoundException - poolEnablerId, poolId, or referenceId not found or, poolEnablerId or referenceId not related to poolId

NullArgumentException - poolEnablerId, poolId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

movePoolEnablerBehind

void movePoolEnablerBehind(Id poolEnablerId,
 Id poolId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

poolEnablerId - the Id of the PoolEnabler

poolId - the Id of the Pool

referenceId - the reference pool enabler Id

Throws:

NotFoundException - poolEnablerId, poolId, or referenceId not found or, poolEnablerId or referenceId not related to poolId

NullArgumentException - poolEnablerId, poolId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderPoolEnablers

void orderPoolEnablers(Id[] poolEnablerIds,
 Id poolId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of pool enablers for a pool.

Parameters:

poolEnablerIds - the Ids for a set of PoolEnablers

poolId - the Id of the Pool

Throws:

NotFoundException - poolEnablerId, poolId, or referenceId not found or, poolEnablerId or referenceId not related to poolId

NullArgumentException - poolEnablerIds, poolId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.