org.osid.resource

Interface ResourceBinSession

All Superinterfaces:

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

public interface ResourceBinSession
extends OsidSession

This session provides methods to retrieve Resource to Bin mappings. A Resource may appear in multiple Bins. Each Bin 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	canLookupResourceBinMappings() Tests if this user can perform lookups of resource/bin mappings.
IdList	getBinIdsByResource(Id resourceId) Gets the list of Bin Ids mapped to a Resource.
BinList	getBinsByResource(Id resourceId) Gets the list of Bin objects mapped to a Resource.
IdList	getResourceIdsByBin(Id binId) Gets the list of Resource Ids associated with a Bin.
IdList	getResourceIdsByBins(IdList binIds) Gets the list of Resource Ids corresponding to a list of Bin objects.
ResourceList	getResourcesByBin(Id binId) Gets the list of Resources associated with a Bin.
ResourceList	getResourcesByBins(IdList binIds) Gets the list of Resources corresponding to a list of Bins.
void	useComparativeBinView() 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	usePlenaryBinView() A complete view of the Resource and Bin 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

useComparativeBinView

void useComparativeBinView()

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.

usePlenaryBinView

void usePlenaryBinView()

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

canLookupResourceBinMappings

boolean canLookupResourceBinMappings()

Tests if this user can perform lookups of resource/bin 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.

getResourceIdsByBin

IdList getResourceIdsByBin(Id binId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the list of Resource Ids associated with a Bin.

Parameters:

binId - Id of a Bin

Returns:

list of related resource Ids

Throws:

NotFoundException - binId is not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResourcesByBin

ResourceList getResourcesByBin(Id binId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the list of Resources associated with a Bin.

Parameters:

binId - Id of a Bin

Returns:

list of related resources

Throws:

NotFoundException - binId is not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResourceIdsByBins

IdList getResourceIdsByBins(IdList binIds)
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets the list of Resource Ids corresponding to a list of Bin objects.

Parameters:

binIds - list of bin Ids

Returns:

list of resource Ids

Throws:

NullArgumentException - binIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResourcesByBins

ResourceList getResourcesByBins(IdList binIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets the list of Resources corresponding to a list of Bins.

Parameters:

binIds - list of bin Ids

Returns:

list of resources

Throws:

NullArgumentException - binIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBinIdsByResource

IdList getBinIdsByResource(Id resourceId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the list of Bin Ids mapped to a Resource.

Parameters:

resourceId - Id of a Resource

Returns:

list of bin Ids

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBinsByResource

BinList getBinsByResource(Id resourceId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Gets the list of Bin objects mapped to a Resource.

Parameters:

resourceId - Id of a Resource

Returns:

list of bins

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.