public interface TriggerLookupSession extends OsidSession
This session provides methods for retrieving Trigger
objects.
This session defines views that offer differing behaviors when retrieving multiple objects.
Triggers
with the TriggerAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedSystemView()
and
useIsolatedSystemView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupTriggers()
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. |
Trigger |
getTrigger(Id triggerId)
Gets the
Trigger specified by its Id. |
TriggerList |
getTriggers()
Gets all
Triggers. |
TriggerList |
getTriggersByGenusType(Type triggerGenusType)
Gets a
TriggerList corresponding to the given trigger
genus Type which does not include triggers of genus
types derived from the specified Type. |
TriggerList |
getTriggersByIds(IdList triggerIds)
Gets a
TriggerList corresponding to the given
IdList. |
TriggerList |
getTriggersByParentGenusType(Type triggerGenusType)
Gets a
TriggerList corresponding to the given trigger
genus Type and include any additional triggers with
genus types derived from the specified Type. |
TriggerList |
getTriggersByRecordType(Type triggerRecordType)
Gets a
TriggerList containing the given trigger record
Type. |
TriggerList |
getTriggersForController(Id controllerId)
Gets a list of triggers for the given controller.
|
void |
useActiveTriggerView()
Only active triggers are returned from methods in this session.
|
void |
useAnyStatusTriggerView()
Borth active and inactive triggers are returned from methods in this
session.
|
void |
useComparativeTriggerView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryTriggerView()
A complete view of the
Trigger returns is desired. |
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 canLookupTriggers()
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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeTriggerView()
mandatory
- This method is must be implemented. void usePlenaryTriggerView()
Trigger
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. void useActiveTriggerView()
mandatory
- This method is must be implemented. void useAnyStatusTriggerView()
mandatory
- This method is must be implemented. Trigger getTrigger(Id triggerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Trigger
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Trigger
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Trigger
and retained for compatibility.
In active mode, triggers are returned that are currently active. In
any status mode, active and inactive triggers are returned.triggerId
- Id
of the Trigger
NotFoundException
- triggerId
not foundNullArgumentException
- triggerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. TriggerList getTriggersByIds(IdList triggerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
triggers specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Triggers
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, triggers are returned that are currently active. In
any status mode, active and inactive triggers are returned.triggerIds
- the list of Ids
to retrieve Trigger
listNotFoundException
- an Id
was not foundNullArgumentException
- triggerIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerList getTriggersByGenusType(Type triggerGenusType) throws OperationFailedException, PermissionDeniedException
TriggerList
corresponding to the given trigger
genus Type
which does not include triggers of genus
types derived from the specified Type.
In plenary mode, the returned list contains all known
triggers or an error results. Otherwise, the returned list may contain
only those triggers that are accessible through this session.
In active mode, triggers are returned that are currently active. In
any status mode, active and inactive triggers are returned.triggerGenusType
- a trigger genus type Trigger
listNullArgumentException
- triggerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerList getTriggersByParentGenusType(Type triggerGenusType) throws OperationFailedException, PermissionDeniedException
TriggerList
corresponding to the given trigger
genus Type
and include any additional triggers with
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
triggers or an error results. Otherwise, the returned list may contain
only those triggers that are accessible through this session.
In active mode, triggers are returned that are currently active. In
any status mode, active and inactive triggers are returned.triggerGenusType
- a trigger genus type Trigger
listNullArgumentException
- triggerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerList getTriggersByRecordType(Type triggerRecordType) throws OperationFailedException, PermissionDeniedException
TriggerList
containing the given trigger record
Type.
In plenary mode, the returned list contains all known
triggers or an error results. Otherwise, the returned list may contain
only those triggers that are accessible through this session.
In active mode, triggers are returned that are currently active. In
any status mode, active and inactive triggers are returned.triggerRecordType
- a trigger record type Trigger
listNullArgumentException
- triggerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerList getTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
triggers or an error results. Otherwise, the returned list may contain
only those triggers that are accessible through this session.
In active mode, triggers are returned that are currently active. In
any status mode, active and inactive triggers are returned.controllerId
- a controller Id
Trigger
listNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerList getTriggers() throws OperationFailedException, PermissionDeniedException
Triggers.
In plenary mode, the returned list contains all known triggers or an
error results. Otherwise, the returned list may contain only those
triggers that are accessible through this session.
In active mode, triggers are returned that are currently active. In
any status mode, active and inactive triggers are returned. Triggers
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.