public interface HoldEnablerQuerySession extends OsidSession
This session provides methods for searching among HoldEnabler
objects. The search query is constructed using the
HoldEnablerQuery.
This session defines views that offer differing behaviors for searching.
Hold enablers may have a query record indicated by their respective
record types. The query record is accessed via the
HoldEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchHoldEnablers()
Tests if this user can perform
HoldEnabler lookups. |
HoldEnablerQuery |
getHoldEnablerQuery()
Gets a hold enabler query.
|
HoldEnablerList |
getHoldEnablersByQuery(HoldEnablerQuery holdEnablerQuery)
Gets a list of
HoldEnablers matching the given hold
enabler 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.
|
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 canSearchHoldEnablers()
HoldEnabler
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedOublietteView()
mandatory
- This method is must be implemented. void useIsolatedOublietteView()
mandatory
- This method is must be implemented. HoldEnablerQuery getHoldEnablerQuery()
mandatory
- This method must be implemented. HoldEnablerList getHoldEnablersByQuery(HoldEnablerQuery holdEnablerQuery) throws OperationFailedException, PermissionDeniedException
HoldEnablers
matching the given hold
enabler query.holdEnablerQuery
- the hold enabler query HoldEnablerList
NullArgumentException
- holdEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- holdEnablerQuery
is not of this servicemandatory
- This method must be implemented.