public interface HoldEnablerSmartOublietteSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
oubliettes. A HoldEnablerQuery
can be retrieved from this
session and mapped to this Oubliette
to create a virtual
collection of hold enablers. The hold enablers may be sequenced using the
HoldEnablerSearchOrder
from this session.
This Oubliette
has a default query that matches any
hold enabler and a default search order that specifies no sequencing. The
queries may be examined using a HoldEnablerQueryInspector.
The query may be modified by converting the inspector back to a
HoldEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyHoldEnablerQuery(HoldEnablerQuery holdEnablerQuery)
Applies a hold enabler query to this oubliette.
|
void |
applyHoldEnablerSequencing(HoldEnablerSearchOrder holdEnablerSearchOrder)
Applies a hold enabler search order to this oubliette.
|
boolean |
canManageSmartOubliettes()
Tests if this user can manage smart oubliettes.
|
HoldEnablerQuery |
getHoldEnablerQuery()
Gets a hold enabler query.
|
HoldEnablerQuery |
getHoldEnablerQueryFromInspector(HoldEnablerQueryInspector holdEnablerQueryInspector)
Gets a hold enabler query from an inspector.
|
HoldEnablerSearchOrder |
getHoldEnablerSearchOrder()
Gets a hold enabler search order.
|
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
HoldEnablerQueryInspector |
inspectHoldEnablerQuery()
Gets a hold enabler 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. HoldEnablerQuery getHoldEnablerQuery()
mandatory
- This method must be implemented. HoldEnablerSearchOrder getHoldEnablerSearchOrder()
mandatory
- This method must be implemented. void applyHoldEnablerQuery(HoldEnablerQuery holdEnablerQuery) throws OperationFailedException, PermissionDeniedException
holdEnablerQuery
- the hold enabler queryNullArgumentException
- holdEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- holdEnablerQuery
not of this servicemandatory
- This method must be implemented. HoldEnablerQueryInspector inspectHoldEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyHoldEnablerSequencing(HoldEnablerSearchOrder holdEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
holdEnablerSearchOrder
- the hold enabler search orderNullArgumentException
- holdEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- holdEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. HoldEnablerQuery getHoldEnablerQueryFromInspector(HoldEnablerQueryInspector holdEnablerQueryInspector)
holdEnablerQueryInspector
- a hold enabler query inspectorNullArgumentException
-
holdEnablerQueryInspector
is null
UnsupportedException
- holdEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.