public interface ProvisionDistributorSession extends OsidSession
This session provides methods to retrieve Provision
to
Distributor
mappings. A Provision
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 |
canLookupProvisionDistributorMappings()
Tests if this user can perform lookups of provision/distributor
mappings.
|
IdList |
getDistributorIdsByProvision(Id provisionId)
Gets the
Distributor Ids mapped to a
Provision. |
DistributorList |
getDistributorsByProvision(Id provisionId)
Gets the
Distributors mapped to a Provision. |
IdList |
getProvisionIdsByDistributor(Id distributorId)
Gets the list of
Provision Ids associated with a
Distributor. |
IdList |
getProvisionIdsByDistributors(IdList distributorIds)
Gets the list of
Provision Ids corresponding to a list
of Distributors. |
ProvisionList |
getProvisionsByDistributor(Id distributorId)
Gets the list of
Provisions associated with a
Distributor. |
ProvisionList |
getProvisionsByDistributors(IdList distributorIds)
Gets the list of
Provision corresponding to a list of
Distributors. |
void |
useComparativeProvisionDistributorView()
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 |
usePlenaryProvisionDistributorView()
A complete view of the
Provision and Distributor
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupProvisionDistributorMappings()
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 mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeProvisionDistributorView()
mandatory
- This method is must be implemented. void usePlenaryProvisionDistributorView()
Provision
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 getProvisionIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Provision 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. ProvisionList getProvisionsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Provisions
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 getProvisionIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Provision 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. ProvisionList getProvisionsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Provision
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 getDistributorIdsByProvision(Id provisionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
Provision.
provisionId
- Id
of a Provision
NotFoundException
- provisionId
is not
foundNullArgumentException
- provisionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByProvision(Id provisionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a Provision.
provisionId
- Id
of a Provision
NotFoundException
- provisionId
is not
foundNullArgumentException
- provisionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.