org.osid.hold

Interface HoldSmartOublietteSession

All Superinterfaces:

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

public interface HoldSmartOublietteSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A HoldQuery can be retrieved from this session and oublietteped to this Oubliette to create a virtual collection of Holds. The holds may be sequenced using the HoldSearchOrder from this session.

This Oubliette has a default query that matches any hold and a default search order that specifies no sequencing. The queries may be examined using a HoldQueryInspector. The query may be modified by converting the inspector back to a HoldQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyHoldQuery(HoldQuery holdQuery) Applies a hold query to this oubliette.
void	applyHoldSequencing(HoldSearchOrder holdSearchOrder) Applies a hold search order to this oubliette.
boolean	canManageSmartOubliettes() Tests if this user can manage smart oubliettes.
HoldQuery	getHoldQuery() Gets a hold query.
HoldQuery	getHoldQueryFromInspector(HoldQueryInspector holdQueryInspector) Gets a hold query from an inspector.
HoldSearchOrder	getHoldSearchOrder() Gets a hold search order.
Oubliette	getOubliette() Gets the Oubliette associated with this session.
Id	getOublietteId() Gets the Oubliette Id associated with this session.
HoldQueryInspector	inspectHoldQuery() Gets a hold query inspector for this oubliette.

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

getOublietteId

Id getOublietteId()

Gets the Oubliette Id associated with this session.

Returns:

the Oubliette Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOubliette

Oubliette getOubliette()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Oubliette associated with this session.

Returns:

the oubliette

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartOubliettes

boolean canManageSmartOubliettes()

Tests if this user can manage smart oubliettes. 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 oubliette management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getHoldQuery

HoldQuery getHoldQuery()

Gets a hold query.

Returns:

the hold query

Compliance:

mandatory - This method must be implemented.

getHoldSearchOrder

HoldSearchOrder getHoldSearchOrder()

Gets a hold search order.

Returns:

the hold search order

Compliance:

mandatory - This method must be implemented.

applyHoldQuery

void applyHoldQuery(HoldQuery holdQuery)
                    throws OperationFailedException,
                           PermissionDeniedException

Applies a hold query to this oubliette.

Parameters:

holdQuery - the hold query

Throws:

NullArgumentException - holdQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - holdQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectHoldQuery

HoldQueryInspector inspectHoldQuery()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a hold query inspector for this oubliette.

Returns:

the hold query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyHoldSequencing

void applyHoldSequencing(HoldSearchOrder holdSearchOrder)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a hold search order to this oubliette.

Parameters:

holdSearchOrder - the hold search order

Throws:

NullArgumentException - holdSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - holdSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getHoldQueryFromInspector

HoldQuery getHoldQueryFromInspector(HoldQueryInspector holdQueryInspector)

Gets a hold query from an inspector.

Parameters:

holdQueryInspector - a hold query inspector

Returns:

the hold query

Throws:

NullArgumentException - holdQueryInspector is null

UnsupportedException - holdQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.