public interface TriggerQuerySession extends OsidSession
This session provides methods for searching among Trigger
objects. The search query is constructed using the
TriggerQuery.
This session defines views that offer differing behaviors for searching.
Triggers may have a query record indicated by their respective record
types. The query record is accessed via the TriggerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchTriggers()
Tests if this user can perform
Trigger lookups. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
TriggerQuery |
getTriggerQuery()
Gets a trigger query.
|
TriggerList |
getTriggersByQuery(TriggerQuery triggerQuery)
Gets a list of
Triggers matching the given trigger
query. |
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 canSearchTriggers()
Trigger
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. TriggerQuery getTriggerQuery()
mandatory
- This method must be implemented. TriggerList getTriggersByQuery(TriggerQuery triggerQuery) throws OperationFailedException, PermissionDeniedException
Triggers
matching the given trigger
query.triggerQuery
- the trigger query TriggerList
NullArgumentException
- triggerQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- triggerQuery
is
not of this servicemandatory
- This method must be implemented.