org.osid.resource

Interface ResourceSmartBinSession

All Superinterfaces:

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

public interface ResourceSmartBinSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ResourceQuery can be retrieved from this session and mapped to this Bin to create a virtual collection of Resources. The resources may be sequenced using the ResourceSearchOrder from this session.

This Bin has a default query that matches any resource and a default search order that specifies no sequencing. The queries may be examined using a ResourceQueryInspector. The query may be modified by converting the inspector back to a ResourceQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyResourceQuery(ResourceQuery resourceQuery) Applies a resource query to this bin.
void	applyResourceSequencing(ResourceSearchOrder resourceSearchOrder) Applies a resource search order to this bin.
boolean	canManageSmartBins() Tests if this user can manage smart bins.
Bin	getBin() Gets the Bin associated with this session.
Id	getBinId() Gets the Bin Id associated with this session.
ResourceQuery	getResourceQuery() Gets a resource query.
ResourceQuery	getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector) Gets a resource query from an inspector.
ResourceSearchOrder	getResourceSearchOrder() Gets a resource search order.
ResourceQueryInspector	inspectResourceQuery() Gets a resource query inspector for this bin.

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

getBinId

Id getBinId()

Gets the Bin Id associated with this session.

Returns:

the Bin Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBin

Bin getBin()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Bin associated with this session.

Returns:

the Bin associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartBins

boolean canManageSmartBins()

Tests if this user can manage smart bins. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart bin management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

Gets a resource query.

Returns:

the resource query

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets a resource search order.

Returns:

the resource search order

Compliance:

mandatory - This method must be implemented.

applyResourceQuery

void applyResourceQuery(ResourceQuery resourceQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a resource query to this bin.

Parameters:

resourceQuery - the resource query

Throws:

NullArgumentException - resourceQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resourceQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectResourceQuery

ResourceQueryInspector inspectResourceQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a resource query inspector for this bin.

Returns:

the resource query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyResourceSequencing

void applyResourceSequencing(ResourceSearchOrder resourceSearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a resource search order to this bin.

Parameters:

resourceSearchOrder - the resource search order

Throws:

NullArgumentException - resourceSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resourceSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getResourceQueryFromInspector

ResourceQuery getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector)

Gets a resource query from an inspector.

Parameters:

resourceQueryInspector - a resource query inspector

Returns:

the resource query

Throws:

NullArgumentException - resourceQueryInspector is null

UnsupportedException - resourceQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.