public interface InputEnablerQuerySession extends OsidSession
This session provides methods for searching among InputEnabler
objects. The search query is constructed using the
InputEnablerQuery.
This session defines views that offer differing behaviors for searching.
input enablers may have a query record indicated by their respective
record types. The query record is accessed via the
InputEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchInputEnablers()
Tests if this user can perform
InputEnabler lookups. |
InputEnablerQuery |
getInputEnablerQuery()
Gets an input enabler query.
|
InputEnablerList |
getInputEnablersByQuery(InputEnablerQuery inputEnablerQuery)
Gets a list of
InputEnablers matching the given search. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchInputEnablers()
InputEnabler
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 useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. InputEnablerQuery getInputEnablerQuery()
mandatory
- This method must be implemented. InputEnablerList getInputEnablersByQuery(InputEnablerQuery inputEnablerQuery) throws OperationFailedException, PermissionDeniedException
InputEnablers
matching the given search.inputEnablerQuery
- the input enabler query InputEnablerList
NullArgumentException
- inputEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inputEnablerQuery
is not of this servicemandatory
- This method must be implemented.