public interface ActionEnablerQuerySession extends OsidSession
This session provides methods for searching among ActionEnabler
objects. The search query is constructed using the
ActionEnablerQuery.
This session defines views that offer differing behaviors for searching.
Action constrainer enablers may have a query record indicated by their
respective record types. The query record is accessed via the
ActionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchActionEnablers()
Tests if this user can perform
ActionEnabler lookups. |
ActionEnablerQuery |
getActionEnablerQuery()
Gets an action enabler query.
|
ActionEnablerList |
getActionEnablersByQuery(ActionEnablerQuery actionEnablerQuery)
Gets a list of
ActionEnablers 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 canSearchActionEnablers()
ActionEnabler
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. ActionEnablerQuery getActionEnablerQuery()
mandatory
- This method must be implemented. ActionEnablerList getActionEnablersByQuery(ActionEnablerQuery actionEnablerQuery) throws OperationFailedException, PermissionDeniedException
ActionEnablers
matching the given
search.actionEnablerQuery
- the action constraienr enabler query ActionEnablerList
NullArgumentException
- actionEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- actionEnablerQuery
is not of this servicemandatory
- This method must be implemented.