org.osid.resource

Interface ResourceRelationshipSmartBinSession

All Superinterfaces:

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

public interface ResourceRelationshipSmartBinSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ResourceRelationshipQuery can be retrieved from this session and mapped to this Bin to create a virtual collection of ResourceRelationships. The resource relationships may be sequenced using the ResourceRelationshipSearchOrder 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 ResourceRelationshipQueryInspector. The query may be modified by converting the inspector back to a ResourceRelationshipQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyResourceRelationshipQuery(ResourceRelationshipQuery resourceQuery) Applies a resource relationship query to this bin.
void	applyResourceRelationshipSequencing(ResourceRelationshipSearchOrder resourceRelationshipSearchOrder) Applies a resource relationship 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.
ResourceRelationshipQuery	getResourceRelationshipQuery() Gets a resource relationship query.
ResourceQuery	getResourceRelationshipQueryFromInspector(ResourceRelationshipQueryInspector resourceRelationshipQueryInspector) Gets a resource relationship query from an inspector.
ResourceRelationshipSearchOrder	getResourceRelationshipSearchOrder() Gets a resource relationship search order.
ResourceRelationshipQueryInspector	inspectResourceRelationshipQuery() Gets a resource relationship 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.

getResourceRelationshipQuery

ResourceRelationshipQuery getResourceRelationshipQuery()

Gets a resource relationship query.

Returns:

the resource relationship query

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipSearchOrder

ResourceRelationshipSearchOrder getResourceRelationshipSearchOrder()

Gets a resource relationship search order.

Returns:

the resource relationship search order

Compliance:

mandatory - This method must be implemented.

applyResourceRelationshipQuery

void applyResourceRelationshipQuery(ResourceRelationshipQuery resourceQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a resource relationship query to this bin.

Parameters:

resourceQuery - the resource relationship query

Throws:

NullArgumentException - resourceRelationshipQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resourceRelationshipQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectResourceRelationshipQuery

ResourceRelationshipQueryInspector inspectResourceRelationshipQuery()
                                                                    throws OperationFailedException,
                                                                           PermissionDeniedException

Gets a resource relationship query inspector for this bin.

Returns:

the resource relationship query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyResourceRelationshipSequencing

void applyResourceRelationshipSequencing(ResourceRelationshipSearchOrder resourceRelationshipSearchOrder)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Applies a resource relationship search order to this bin.

Parameters:

resourceRelationshipSearchOrder - the resource relationship search order

Throws:

NullArgumentException - resourceRelationshipSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resourceRelationshipSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipQueryFromInspector

ResourceQuery getResourceRelationshipQueryFromInspector(ResourceRelationshipQueryInspector resourceRelationshipQueryInspector)

Gets a resource relationship query from an inspector.

Parameters:

resourceRelationshipQueryInspector - a resource relationship query inspector

Returns:

the resource relationship query

Throws:

NullArgumentException - resourceRelationshipQueryInspector is null

UnsupportedException - resourceRelationshipQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.