org.osid.provisioning

Interface RequestDistributorSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupRequestDistributorMappings

boolean canLookupRequestDistributorMappings()

Tests if this user can perform lookups of request/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRequestDistributorView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRequestDistributorView

void usePlenaryRequestDistributorView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getRequestIdsByDistributor

IdList getRequestIdsByDistributor(Id distributorId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the list of Request Ids associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related request Ids

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsByDistributor

RequestList getRequestsByDistributor(Id distributorId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the list of Requests associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related requests

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestIdsByDistributors

IdList getRequestIdsByDistributors(IdList distributorIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the list of Request Ids corresponding to a list of Distributors.

Parameters:

distributorIds - list of distributor Ids

Returns:

list of request Ids

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsByDistributors

RequestList getRequestsByDistributors(IdList distributorIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets the list of Request corresponding to a list of Distributors.

Parameters:

distributorIds - list of distributor Ids

Returns:

list of requests

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorIdsByRequest

IdList getDistributorIdsByRequest(Id requestId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Distributor Ids mapped to a Request.

Parameters:

requestId - Id of a Request

Returns:

list of distributors

Throws:

NotFoundException - requestId is not found

NullArgumentException - requestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByRequest

DistributorList getDistributorsByRequest(Id requestId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the Distributors mapped to a Request.

Parameters:

requestId - Id of a Request

Returns:

list of distributors

Throws:

NotFoundException - requestId is not found

NullArgumentException - requestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.