Interface PoolDistributorSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PoolDistributorSession
extends OsidSession

This session provides methods to retrieve Pool to Distributor mappings. A Pool may appear in multiple Distributor objects. Each distributor may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupPoolDistributorMappings()	Tests if this user can perform lookups of pool/distributor mappings.
IdList	getDistributorIdsByPool(Id poolId)	Gets the Distributor Ids mapped to a Pool .
DistributorList	getDistributorsByPool(Id poolId)	Gets the Distributors mapped to a Pool .
IdList	getPoolIdsByDistributor(Id distributorId)	Gets the list of Pool Ids associated with a Distributor .
IdList	getPoolIdsByDistributors(IdList distributorIds)	Gets the list of Pool Ids corresponding to a list of Distributors .
PoolList	getPoolsByDistributor(Id distributorId)	Gets the list of Pools associated with a Distributor .
PoolList	getPoolsByDistributors(IdList distributorIds)	Gets the list of Pool corresponding to a list of Distributors .
void	useComparativePoolDistributorView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryPoolDistributorView()	A complete view of the Pool and Distributor returns is desired.

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

canLookupPoolDistributorMappings

boolean canLookupPoolDistributorMappings()

Tests if this user can perform lookups of pool/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePoolDistributorView

void useComparativePoolDistributorView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryPoolDistributorView

void usePlenaryPoolDistributorView()

A complete view of the Pool and Distributor returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getPoolIdsByDistributor

IdList getPoolIdsByDistributor(Id distributorId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Pool Ids associated with a Distributor .

Parameters:

distributorId - Id of the Distributor

Returns:

list of related pool Ids

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolsByDistributor

PoolList getPoolsByDistributor(Id distributorId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Pools associated with a Distributor .

Parameters:

distributorId - Id of the Distributor

Returns:

list of related pools

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolIdsByDistributors

IdList getPoolIdsByDistributors(IdList distributorIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Pool Ids corresponding to a list of Distributors .

Parameters:

distributorIds - list of distributor Ids

Returns:

list of pool Ids

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolsByDistributors

PoolList getPoolsByDistributors(IdList distributorIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Pool corresponding to a list of Distributors .

Parameters:

distributorIds - list of distributor Ids

Returns:

list of pools

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorIdsByPool

IdList getDistributorIdsByPool(Id poolId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Distributor Ids mapped to a Pool .

Parameters:

poolId - Id of a Pool

Returns:

list of distributors

Throws:

NotFoundException - poolId is not found

NullArgumentException - poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByPool

DistributorList getDistributorsByPool(Id poolId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Distributors mapped to a Pool .

Parameters:

poolId - Id of a Pool

Returns:

list of distributors

Throws:

NotFoundException - poolId is not found

NullArgumentException - poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.