public interface RequestDistributorSession extends OsidSession
This session provides methods to retrieve Request
to
Distributor
mappings. A Request
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 |
canLookupRequestDistributorMappings()
Tests if this user can perform lookups of request/distributor
mappings.
|
IdList |
getDistributorIdsByRequest(Id requestId)
Gets the
Distributor Ids mapped to a
Request. |
DistributorList |
getDistributorsByRequest(Id requestId)
Gets the
Distributors mapped to a Request. |
IdList |
getRequestIdsByDistributor(Id distributorId)
Gets the list of
Request Ids associated with a
Distributor. |
IdList |
getRequestIdsByDistributors(IdList distributorIds)
Gets the list of
Request Ids corresponding to a list of
Distributors. |
RequestList |
getRequestsByDistributor(Id distributorId)
Gets the list of
Requests associated with a
Distributor. |
RequestList |
getRequestsByDistributors(IdList distributorIds)
Gets the list of
Request corresponding to a list of
Distributors. |
void |
useComparativeRequestDistributorView()
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 |
usePlenaryRequestDistributorView()
A complete view of the
Request and Distributor
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRequestDistributorMappings()
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 useComparativeRequestDistributorView()
mandatory
- This method is must be implemented. void usePlenaryRequestDistributorView()
Request
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 getRequestIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Request 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. RequestList getRequestsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Requests
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 getRequestIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Request 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. RequestList getRequestsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Request
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 getDistributorIdsByRequest(Id requestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
Request.
requestId
- Id
of a Request
NotFoundException
- requestId
is not
foundNullArgumentException
- requestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByRequest(Id requestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a Request.
requestId
- Id
of a Request
NotFoundException
- requestId
is not
foundNullArgumentException
- requestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.