public interface PoolLookupSession extends OsidSession
This session provides methods for retrieving Pool
objects. The Pool
represents a fixed connection between two
Provisionables.
This session defines views that offer differing behaviors when retrieving multiple objects.
Pools
with the PoolAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPools()
Tests if this user can perform
Pool lookups. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
Pool |
getPool(Id poolId)
Gets the
Pool specified by its Id. |
PoolList |
getPools()
Gets all
Pools. |
PoolList |
getPoolsByGenusType(Type poolGenusType)
Gets a
PoolList corresponding to the given pool genus
Type which does not include pools of genus types
derived from the specified Type. |
PoolList |
getPoolsByIds(IdList poolIds)
Gets a
PoolList corresponding to the given
IdList. |
PoolList |
getPoolsByParentGenusType(Type poolGenusType)
Gets a
PoolList corresponding to the given pool genus
Type and include any additional pools with genus types
derived from the specified Type. |
PoolList |
getPoolsByProvider(Id resourceId)
Gets a
PoolList by provider. |
PoolList |
getPoolsByRecordType(Type poolRecordType)
Gets a
PoolList containing the given pool record
Type. |
PoolList |
getPoolsForBroker(Id brokerId)
Gets a
PoolList by broker . |
void |
useActivePoolView()
Only active pools are returned from methods in this session.
|
void |
useAnyStatusPoolView()
Borth active and inactive pools are returned from methods in this
session.
|
void |
useComparativePoolView()
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 |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
void |
usePlenaryPoolView()
A complete view of the
Pool returns is desired. |
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 canLookupPools()
Pool
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all 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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativePoolView()
mandatory
- This method is must be implemented. void usePlenaryPoolView()
Pool
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.mandatory
- This method is must be implemented. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. void useActivePoolView()
mandatory
- This method is must be implemented. void useAnyStatusPoolView()
mandatory
- This method is must be implemented. Pool getPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Pool
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Pool
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Pool
and retained for compatibility.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned.poolId
- Id
of the Pool
NotFoundException
- poolId
not foundNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. PoolList getPoolsByIds(IdList poolIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
pools specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Pools
may be omitted from the list and may
present the elements in any order including returning a unique set.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned.poolIds
- the list of Ids
to retrieve Pool
listNotFoundException
- an Id
was not foundNullArgumentException
- poolIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPoolsByGenusType(Type poolGenusType) throws OperationFailedException, PermissionDeniedException
PoolList
corresponding to the given pool genus
Type
which does not include pools of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
pools or an error results. Otherwise, the returned list may contain
only those pools that are accessible through this session.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned.poolGenusType
- a pool genus type Pool
listNullArgumentException
- poolGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPoolsByParentGenusType(Type poolGenusType) throws OperationFailedException, PermissionDeniedException
PoolList
corresponding to the given pool genus
Type
and include any additional pools with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
pools or an error results. Otherwise, the returned list may contain
only those pools that are accessible through this session.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned.poolGenusType
- a pool genus type Pool
listNullArgumentException
- poolGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPoolsByRecordType(Type poolRecordType) throws OperationFailedException, PermissionDeniedException
PoolList
containing the given pool record
Type.
In plenary mode, the returned list contains all known
pools or an error results. Otherwise, the returned list may contain
only those pools that are accessible through this session.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned.poolRecordType
- a pool record type Pool
listNullArgumentException
- poolRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPoolsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
PoolList
by broker .
In plenary mode, the returned list contains all known
pools or an error results. Otherwise, the returned list may contain
only those pools that are accessible through this session.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned.brokerId
- a broker Id
Pool
listNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPoolsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
PoolList
by provider.
In plenary mode, the returned list contains all known
pools or an error results. Otherwise, the returned list may contain
only those pools that are accessible through this session.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned.resourceId
- a resource Id
Pool
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPools() throws OperationFailedException, PermissionDeniedException
Pools.
In plenary mode, the returned list contains all known pools or an
error results. Otherwise, the returned list may contain only those
pools that are accessible through this session.
In active mode, pools are returned that are currently active. In any
status mode, active and inactive pool are returned. Pools
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.