public interface ProvisionableLookupSession extends OsidSession
This session defines methods for retrieving provisionables.
This lookup session defines several views:
Provisionables
with the
ProvisionableAdminSession.
The methods useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Provisionables may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the provisionables.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProvisionables()
Tests if this user can perform
Provisionable lookups. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
Provisionable |
getProvisionable(Id provisionableId)
Gets the
Provisionable specified by its Id. |
ProvisionableList |
getProvisionables()
Gets all provisionables.
|
ProvisionableList |
getProvisionablesByGenusType(Type provisionableGenusType)
Gets a
ProvisionableList corresponding to the given
provisionable genus Type which does not include
provisionables of types derived from the specified Type. |
ProvisionableList |
getProvisionablesByIds(IdList provisionableIds)
Gets a
ProvisionableList corresponding to the given
IdList. |
ProvisionableList |
getProvisionablesByParentGenusType(Type provisionableGenusType)
Gets a
ProvisionableList corresponding to the given
provisionable genus Type and include any additional
provisionables with genus types derived from the specified
Type. |
ProvisionableList |
getProvisionablesByRecordType(Type provisionableRecordType)
Gets a
ProvisionableList containing the given
provisionable record Type. |
ProvisionableList |
getProvisionablesForPool(Id poolId)
Gets a list of provisionables for a pool.
|
ProvisionableList |
getProvisionablesForPoolOnDate(Id poolId,
DateTime from,
DateTime to)
Gets a list of provisionables effective during the entire given date
range inclusive but not confined to the date range.
|
ProvisionableList |
getProvisionablesForResource(Id resourceId)
Gets a list of provisionables for a resource.
|
ProvisionableList |
getProvisionablesForResourceAndPool(Id resourceId,
Id poolId)
Gets a list of provisionables for a resource and pool.
|
ProvisionableList |
getProvisionablesForResourceAndPoolOnDate(Id resourceId,
Id poolId,
DateTime from,
DateTime to)
Gets a list of provisionables effective during the entire given date
range inclusive but not confined to the date range.
|
ProvisionableList |
getProvisionablesForResourceOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of provisionables for a resource and effective during the
entire given date range inclusive but not confined to the date range.
|
ProvisionableList |
getProvisionablesOnDate(DateTime from,
DateTime to)
Gets a list of provisionables effective during the entire given date
range inclusive but not confined to the date range.
|
void |
useAnyEffectiveProvisionableView()
All provisionables of any effective dates are returned by methods in
this session.
|
void |
useComparativeProvisionableView()
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 |
useEffectiveProvisionableView()
Only provisionables whose effective dates are current are returned by
methods in this session.
|
void |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
void |
usePlenaryProvisionableView()
A complete view of the
Provisionable 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 canLookupProvisionables()
Provisionable
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 not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeProvisionableView()
mandatory
- This method is must be implemented. void usePlenaryProvisionableView()
Provisionable
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 useEffectiveProvisionableView()
mandatory
- This method is must be implemented. void useAnyEffectiveProvisionableView()
mandatory
- This method is must be implemented. Provisionable getProvisionable(Id provisionableId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Provisionable
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Provisionable
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Provisionable
and retained for
compatibility.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.provisionableId
- the Id
of the
Provisionable
to retrieve Provisionable
NotFoundException
- no Provisionable
found with the given Id
NullArgumentException
- provisionableId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesByIds(IdList provisionableIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProvisionableList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
provisionables 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 Provisionables
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.provisionableIds
- the list of Ids
to retrieve Provisionable
listNotFoundException
- an Id
was not foundNullArgumentException
- provisionableIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesByGenusType(Type provisionableGenusType) throws OperationFailedException, PermissionDeniedException
ProvisionableList
corresponding to the given
provisionable genus Type
which does not include
provisionables of types derived from the specified Type.
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.provisionableGenusType
- a provisionable genus type Provisionable
listNullArgumentException
- provisionableGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesByParentGenusType(Type provisionableGenusType) throws OperationFailedException, PermissionDeniedException
ProvisionableList
corresponding to the given
provisionable genus Type
and include any additional
provisionables with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.provisionableGenusType
- a provisionable genus type Provisionable
listNullArgumentException
- provisionableGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesByRecordType(Type provisionableRecordType) throws OperationFailedException, PermissionDeniedException
ProvisionableList
containing the given
provisionable record Type.
In plenary mode, the returned list contains all known provisionables
or an error results. Otherwise, the returned list may contain only
those provisionables that are accessible through this session.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.provisionableRecordType
- a provisionable record type Provisionable
listNullArgumentException
- provisionableRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective in addition to being effective in the given date range. In
any effective mode, effective provisionables and those currently
expired are returned.from
- start of date rangeto
- end of date range Provisionable
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.resourceId
- a resource Id
Provisionable
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective in addition to being effective in the given date range. In
any effective mode, effective provisionables and those currently
expired are returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range Provisionable
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesForPool(Id poolId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.poolId
- a pool Id
Provisionable
listNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesForPoolOnDate(Id poolId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective in addition to being effective in the given date range. In
any effective mode, effective provisionables and those currently
expired are returned.poolId
- a pool Id
from
- start of date rangeto
- end of date range Provisionable
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- poolId, from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesForResourceAndPool(Id resourceId, Id poolId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned.resourceId
- a resource Id
poolId
- a pool Id
Provisionable
listNullArgumentException
- resourceId
or
poolId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesForResourceAndPoolOnDate(Id resourceId, Id poolId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
provisionables or an error results. Otherwise, the returned list may
contain only those provisionables that are accessible through this
session.
In effective mode, provisionables are returned that are currently
effective in addition to being effective in the given date range. In
any effective mode, effective provisionables and those currently
expired are returned.resourceId
- a resource Id
poolId
- a pool Id
from
- start of date rangeto
- end of date range Provisionable
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, poolId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionables() throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all of the
provisionables including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible Provisionables
may be omitted
from the list and may present the elements in any order including
returning a unique set.
In effective mode, provisionables are returned that are currently
effective. In any effective mode, effective provisionables and those
currently expired are returned. Provisionable
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.