Interface ResourceBinSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.