org.osid.hold

Interface HoldQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

HoldSearchSession

public interface HoldQuerySession
extends OsidSession

This session provides methods for searching among Hold objects. The search query is constructed using the HoldQuery.

This session defines views that offer differing behaviors for searching.

• federated oubliette view: searches include holds in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
• isolated oubliette view: searches are restricted to holds in this oubliette

Holds may have a query record indicated by their respective record types. The query record is accessed via the HoldQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchHolds() Tests if this user can perform Hold lookups.
HoldQuery	getHoldQuery() Gets a hold query.
HoldList	getHoldsByQuery(HoldQuery holdQuery) Gets a list of Holds matching the given hold query.
Oubliette	getOubliette() Gets the Oubliette associated with this session.
Id	getOublietteId() Gets the Oubliette Id associated with this session.
void	useFederatedOublietteView() Federates the view for methods in this session.
void	useIsolatedOublietteView() Isolates the view for methods in this session.

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.

canSearchHolds

boolean canSearchHolds()

Tests if this user can perform Hold lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedOublietteView

void useFederatedOublietteView()

Federates the view for methods in this session. A federated view will include holds in oubliettes which are children of this oubliette in the oubliette hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOublietteView

void useIsolatedOublietteView()

Isolates the view for methods in this session. An isolated view restricts searches to this oubliette only.

Compliance:

mandatory - This method is must be implemented.

getHoldQuery

HoldQuery getHoldQuery()

Gets a hold query.

Returns:

the hold query

Compliance:

mandatory - This method must be implemented.

getHoldsByQuery

HoldList getHoldsByQuery(HoldQuery holdQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Gets a list of Holds matching the given hold query.

Parameters:

holdQuery - the hold query

Returns:

the returned HoldList

Throws:

NullArgumentException - holdQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - holdQuery is not of this service

Compliance:

mandatory - This method must be implemented.