public interface ActionGroupQuerySession extends OsidSession
This session provides methods for searching among ActionGroup
objects. The search query is constructed using the
ActionGroupQuery.
This session defines views that offer differing behaviors for searching.
ActionGroups may have a query record indicated by their respective
record types. The query record is accessed via the
ActionGroupQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchActionGroups()
Tests if this user can perform
ActionGroup lookups. |
ActionGroupQuery |
getActionGroupQuery()
Gets an action group query.
|
ActionGroupList |
getActionGroupsByQuery(ActionGroupQuery actuionGroupQuery)
Gets a list of
ActionGroups matching the given action
group query. |
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 canSearchActionGroups()
ActionGroup
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. ActionGroupQuery getActionGroupQuery()
mandatory
- This method must be implemented. ActionGroupList getActionGroupsByQuery(ActionGroupQuery actuionGroupQuery) throws OperationFailedException, PermissionDeniedException
ActionGroups
matching the given action
group query.actuionGroupQuery
- the action group query ActionGroupList
NullArgumentException
- actuionGroupQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- actuionGroupQuery
is not of this servicemandatory
- This method must be implemented.