public interface PoolConstrainerLookupSession extends OsidSession
This session provides methods for retrieving PoolConstrainers.
This session defines views that offer differing behaviors when retrieving multiple objects.
PoolConstrainers
with the
PoolConstrainerAdminSession.
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 the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPoolConstrainers()
Tests if this user can perform
PoolConstrainers
lookups. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolConstrainer |
getPoolConstrainer(Id poolConstrainerId)
Gets the
PoolConstrainer specified by its Id. |
PoolConstrainerList |
getPoolConstrainers()
Gets all
PoolConstrainers. |
PoolConstrainerList |
getPoolConstrainersByGenusType(Type poolConstrainerGenusType)
Gets a
PoolConstrainerList corresponding to the given
pool constrainer genus Type which does not include pool
constrainer of genus types derived from the specified Type. |
PoolConstrainerList |
getPoolConstrainersByIds(IdList poolConstrainerIds)
Gets a
PoolConstrainerList corresponding to the given
IdList. |
PoolConstrainerList |
getPoolConstrainersByParentGenusType(Type poolConstrainerGenusType)
Gets a
PoolConstrainerList corresponding to the given
pool constrainer genus Type and include any additional
pool constrainer with genus types derived from the specified
Type. |
PoolConstrainerList |
getPoolConstrainersByRecordType(Type poolConstrainerRecordType)
Gets a
PoolConstrainerList containing the given pool
constrainer record Type. |
void |
useActivePoolConstrainerView()
Only active pool constrainers are returned by methods in this session.
|
void |
useAnyStatusPoolConstrainerView()
All active and inactive pool constrainers are returned by methods in
this session.
|
void |
useComparativePoolConstrainerView()
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 |
usePlenaryPoolConstrainerView()
A complete view of the
PoolConstrainer 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 canLookupPoolConstrainers()
PoolConstrainers
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 useComparativePoolConstrainerView()
mandatory
- This method is must be implemented. void usePlenaryPoolConstrainerView()
PoolConstrainer
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 useActivePoolConstrainerView()
mandatory
- This method is must be implemented. void useAnyStatusPoolConstrainerView()
mandatory
- This method is must be implemented. PoolConstrainer getPoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainer
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
PoolConstrainer
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a PoolConstrainer
and retained for
compatibility.
In active mode, pool constrainers are returned that are currently
active. In any status mode, active and inactive pool constrainers are
returned.poolConstrainerId
- Id
of the
PoolConstrainer
NotFoundException
- poolConstrainerId
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. PoolConstrainerList getPoolConstrainersByIds(IdList poolConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
pool constrainer 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 PoolConstrainers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, pool constrainers are returned that are currently
active. In any status mode, active and inactive pool constrainers are
returned.poolConstrainerIds
- the list of Ids
to retrieve PoolConstrainer
listNotFoundException
- an Id
was not foundNullArgumentException
- poolConstrainerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolConstrainerList getPoolConstrainersByGenusType(Type poolConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
PoolConstrainerList
corresponding to the given
pool constrainer genus Type
which does not include pool
constrainer of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
pool constrainer or an error results. Otherwise, the returned list may
contain only those pool constrainer that are accessible through this
session.
In active mode, pool constrainers are returned that are currently
active. In any status mode, active and inactive pool constrainers are
returned.poolConstrainerGenusType
- a pool constrainer genus type PoolConstrainer
listNullArgumentException
- poolConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolConstrainerList getPoolConstrainersByParentGenusType(Type poolConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
PoolConstrainerList
corresponding to the given
pool constrainer genus Type
and include any additional
pool constrainer with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
pool constrainer or an error results. Otherwise, the returned list may
contain only those pool constrainer that are accessible through this
session.
In active mode, pool constrainers are returned that are currently
active. In any status mode, active and inactive pool constrainers are
returned.poolConstrainerGenusType
- a pool constrainer genus type PoolConstrainer
listNullArgumentException
- poolConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolConstrainerList getPoolConstrainersByRecordType(Type poolConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
PoolConstrainerList
containing the given pool
constrainer record Type.
In plenary mode, the returned list contains all known
pool constrainer or an error results. Otherwise, the returned list may
contain only those pool constrainer that are accessible through this
session.
In active mode, pool constrainers are returned that are currently
active. In any status mode, active and inactive pool constrainers are
returned.poolConstrainerRecordType
- a pool constrainer record type PoolConstrainer
listNullArgumentException
-
poolConstrainerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolConstrainerList getPoolConstrainers() throws OperationFailedException, PermissionDeniedException
PoolConstrainers.
In plenary mode, the returned list contains all known pool constrainer
or an error results. Otherwise, the returned list may contain only
those pool constrainer that are accessible through this session.
In active mode, pool constrainers are returned that are currently
active. In any status mode, active and inactive pool constrainers are
returned. PoolConstrainer
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.