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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartOubliettes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart oubliette management is not
authorized, true
otherwisemandatory
- This method must be implemented. HoldQuery getHoldQuery()
mandatory
- This method must be implemented. HoldSearchOrder getHoldSearchOrder()
mandatory
- This method must be implemented. void applyHoldQuery(HoldQuery holdQuery) throws OperationFailedException, PermissionDeniedException
holdQuery
- the hold queryNullArgumentException
- holdQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- holdQuery
not of
this servicemandatory
- This method must be implemented. HoldQueryInspector inspectHoldQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyHoldSequencing(HoldSearchOrder holdSearchOrder) throws OperationFailedException, PermissionDeniedException
holdSearchOrder
- the hold search orderNullArgumentException
- holdSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- holdSearchOrder
not of this servicemandatory
- This method must be implemented. HoldQuery getHoldQueryFromInspector(HoldQueryInspector holdQueryInspector)
holdQueryInspector
- a hold query inspectorNullArgumentException
- holdQueryInspector
is null
UnsupportedException
- holdQueryInspector
is not of this servicemandatory
- This method must be implemented.