public interface ProvisionableDistributorSession extends OsidSession
This session provides methods to retrieve Provisionable
to Distributor
provisionables. A Provisionable
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProvisionableDistributorProvisionables()
Tests if this user can perform lookups of provisionable/distributor
mappings.
|
IdList |
getDistributorIdsByProvisionable(Id provisionableId)
Gets the
Distributor Ids mapped to a
Provisionable. |
DistributorList |
getDistributorsByProvisionable(Id provisionableId)
Gets the
Distributors mapped to a Provisionable. |
IdList |
getProvisionableIdsByDistributor(Id distributorId)
Gets the list of
Provisionable Ids associated with a
Distributor. |
IdList |
getProvisionableIdsByDistributors(IdList distributorIds)
Gets the list of
Provisionable Ids corresponding to a
list of Distributors. |
ProvisionableList |
getProvisionablesByDistributor(Id distributorId)
Gets the list of
Provisionables associated with a
Distributor. |
ProvisionableList |
getProvisionablesByDistributors(IdList distributorIds)
Gets the list of
Provisionables corresponding to a list
of Distributors. |
void |
useComparativeProvisionableDistributorView()
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 |
usePlenaryProvisionableDistributorView()
A complete view of the
Provisionable and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupProvisionableDistributorProvisionables()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up provisionables is not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeProvisionableDistributorView()
mandatory
- This method is must be implemented. void usePlenaryProvisionableDistributorView()
Provisionable
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.mandatory
- This method is must be implemented. IdList getProvisionableIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Provisionable Ids
associated with a
Distributor.
distributorId
- Id
of the Distributor
Ids
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Provisionables
associated with a
Distributor.
distributorId
- Id
of the Distributor
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getProvisionableIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Provisionable Ids
corresponding to a
list of Distributors.
distributorIds
- list of distributor Ids
Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getProvisionablesByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Provisionables
corresponding to a list
of Distributors.
distributorIds
- list of distributor Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDistributorIdsByProvisionable(Id provisionableId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
Provisionable.
provisionableId
- Id
of a Provisionable
NotFoundException
- provisionableId
is
not foundNullArgumentException
- provisionableId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByProvisionable(Id provisionableId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a Provisionable.
provisionableId
- Id
of a Provisionable
NotFoundException
- provisionableId
is
not foundNullArgumentException
- provisionableId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.