org.osid.provisioning

Interface DistributorLookupSession

All Superinterfaces:

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

public interface DistributorLookupSession
extends OsidSession

This session provides methods for retrieving Distributor objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Distributors it can access, without breaking execution. However, an assessment may only be useful if all Distributors referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupDistributors() Tests if this user can perform Distributor lookups.
Distributor	getDistributor(Id distributorId) Gets the Distributor specified by its Id.
DistributorList	getDistributors() Gets all Distributors.
DistributorList	getDistributorsByGenusType(Type distributorGenusType) Gets a DistributorList corresponding to the given distributor genus Type which does not include distributors of types derived from the specified Type.
DistributorList	getDistributorsByIds(IdList distributorIds) Gets a DistributorList corresponding to the given IdList.
DistributorList	getDistributorsByParentGenusType(Type distributorGenusType) Gets a DistributorList corresponding to the given distributor genus Type and include any additional distributors with genus types derived from the specified Type.
DistributorList	getDistributorsByProvider(Id resourceId) Gets a DistributorList for the given provider.
DistributorList	getDistributorsByRecordType(Type distributorRecordType) Gets a DistributorList containing the given distributor record Type.
void	useComparativeDistributorView() 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	usePlenaryDistributorView() A complete view of the 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

canLookupDistributors

boolean canLookupDistributors()

Tests if this user can perform Distributor 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 opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeDistributorView

void useComparativeDistributorView()

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.

usePlenaryDistributorView

void usePlenaryDistributorView()

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

getDistributor

Distributor getDistributor(Id distributorId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Distributor may have a different Id than requested, such as the case where a duplicate Id was assigned to a Distributor and retained for compatibility.

Parameters:

distributorId - Id of the Distributor

Returns:

the distributor

Throws:

NotFoundException - distributorId not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getDistributorsByIds

DistributorList getDistributorsByIds(IdList distributorIds)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets a DistributorList corresponding to the given IdList. In plenary mode, the returned list contains all of the distributors 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 Distributors may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

distributorIds - the list of Ids to retrieve

Returns:

the returned Distributor list

Throws:

NotFoundException - an Id was not found

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByGenusType

DistributorList getDistributorsByGenusType(Type distributorGenusType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a DistributorList corresponding to the given distributor genus Type which does not include distributors of types derived from the specified Type. In plenary mode, the returned list contains all known distributors or an error results. Otherwise, the returned list may contain only those distributors that are accessible through this session.

Parameters:

distributorGenusType - a distributor genus type

Returns:

the returned Distributor list

Throws:

NullArgumentException - distributorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByParentGenusType

DistributorList getDistributorsByParentGenusType(Type distributorGenusType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a DistributorList corresponding to the given distributor genus Type and include any additional distributors with genus types derived from the specified Type. In plenary mode, the returned list contains all known distributors or an error results. Otherwise, the returned list may contain only those distributors that are accessible through this session.

Parameters:

distributorGenusType - a distributor genus type

Returns:

the returned Distributor list

Throws:

NullArgumentException - distributorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByRecordType

DistributorList getDistributorsByRecordType(Type distributorRecordType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a DistributorList containing the given distributor record Type. In plenary mode, the returned list contains all known distributors or an error results. Otherwise, the returned list may contain only those distributors that are accessible through this session.

Parameters:

distributorRecordType - a distributor record type

Returns:

the returned Distributor list

Throws:

NullArgumentException - distributorRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByProvider

DistributorList getDistributorsByProvider(Id resourceId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a DistributorList for the given provider. In plenary mode, the returned list contains all known distributors or an error results. Otherwise, the returned list may contain only those distributors that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Distributor list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributors

DistributorList getDistributors()
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets all Distributors. In plenary mode, the returned list contains all known distributors or an error results. Otherwise, the returned list may contain only those distributors that are accessible through this session.

Returns:

a list of Distributors

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.