public interface TriggerEnablerLookupSession extends OsidSession
This session provides methods for retrieving TriggerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
TriggerEnablers
with the
TriggerEnablerAdminSession.
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 useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupTriggerEnablers()
Tests if this user can perform
TriggerEnablers lookups. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
TriggerEnabler |
getTriggerEnabler(Id triggerEnablerId)
Gets the
TriggerEnabler specified by its Id. |
TriggerEnablerList |
getTriggerEnablers()
Gets all
TriggerEnablers. |
TriggerEnablerList |
getTriggerEnablersByGenusType(Type triggerEnablerGenusType)
Gets a
TriggerEnablerList corresponding to the given
trigger enabler genus Type which does not include
trigger enablers of genus types derived from the specified
Type. |
TriggerEnablerList |
getTriggerEnablersByIds(IdList triggerEnablerIds)
Gets a
TriggerEnablerList corresponding to the given
IdList. |
TriggerEnablerList |
getTriggerEnablersByParentGenusType(Type triggerEnablerGenusType)
Gets a
TriggerEnablerList corresponding to the given
trigger enabler genus Type and include any additional
trigger enablers with genus types derived from the specified
Type. |
TriggerEnablerList |
getTriggerEnablersByRecordType(Type triggerEnablerRecordType)
Gets a
TriggerEnablerList containing the given trigger
enabler record Type. |
TriggerEnablerList |
getTriggerEnablersOnDate(DateTime from,
DateTime to)
Gets a
TriggerEnablerList that are effective for the
entire given date range but not confined to the date range. |
TriggerEnablerList |
getTriggerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
TriggerEnablerList that are effective for the
entire given date range but not confined to the date range and
evaluated against the given agent. |
void |
useActiveTriggerEnablerView()
Only active trigger enablers are returned by methods in this session.
|
void |
useAnyStatusTriggerEnablerView()
All active and inactive trigger enablers are returned by methods in
this session.
|
void |
useComparativeTriggerEnablerView()
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 |
usePlenaryTriggerEnablerView()
A complete view of the
TriggerEnabler 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 canLookupTriggerEnablers()
TriggerEnablers
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 useComparativeTriggerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryTriggerEnablerView()
TriggerEnabler
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 useActiveTriggerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusTriggerEnablerView()
mandatory
- This method is must be implemented. TriggerEnabler getTriggerEnabler(Id triggerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
TriggerEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a TriggerEnabler
and retained for
compatibility.
In active mode, trigger enablers are returned that are currently
active. In any status mode, active and inactive trigger enablers are
returned.triggerEnablerId
- Id
of the
TriggerEnabler
NotFoundException
- triggerEnablerId
not
foundNullArgumentException
- triggerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. TriggerEnablerList getTriggerEnablersByIds(IdList triggerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
trigger enablers 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 TriggerEnablers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, trigger enablers are returned that are currently
active. In any status mode, active and inactive trigger enablers are
returned.triggerEnablerIds
- the list of Ids
to retrieve TriggerEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- triggerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersByGenusType(Type triggerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
TriggerEnablerList
corresponding to the given
trigger enabler genus Type
which does not include
trigger enablers of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
trigger enablers or an error results. Otherwise, the returned list may
contain only those trigger enablers that are accessible through this
session.
In active mode, trigger enablers are returned that are currently
active. In any status mode, active and inactive trigger enablers are
returned.triggerEnablerGenusType
- a trigger enabler genus type TriggerEnabler
listNullArgumentException
- triggerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersByParentGenusType(Type triggerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
TriggerEnablerList
corresponding to the given
trigger enabler genus Type
and include any additional
trigger enablers with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
trigger enablers or an error results. Otherwise, the returned list may
contain only those trigger enablers that are accessible through this
session.
In active mode, trigger enablers are returned that are currently
active. In any status mode, active and inactive trigger enablers are
returned.triggerEnablerGenusType
- a trigger enabler genus type TriggerEnabler
listNullArgumentException
- triggerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersByRecordType(Type triggerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
TriggerEnablerList
containing the given trigger
enabler record Type.
In plenary mode, the returned list contains all known
trigger enablers or an error results. Otherwise, the returned list may
contain only those trigger enablers that are accessible through this
session.
In active mode, trigger enablers are returned that are currently
active. In any status mode, active and inactive trigger enablers are
returned.triggerEnablerRecordType
- a trigger enabler record type TriggerEnabler
listNullArgumentException
- triggerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
TriggerEnablerList
that are effective for the
entire given date range but not confined to the date range.
In plenary mode, the returned list contains all known
trigger enablers or an error results. Otherwise, the returned list may
contain only those trigger enablers that are accessible through this
session.
In active mode, trigger enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive trigger enablers are returned.from
- a start dateto
- an end date TriggerEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
TriggerEnablerList
that are effective for the
entire given date range but not confined to the date range and
evaluated against the given agent.
In plenary mode, the returned list contains all known
trigger enablers or an error results. Otherwise, the returned list may
contain only those trigger enablers that are accessible through this
session.
In active mode, trigger enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive trigger enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date TriggerEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablers() throws OperationFailedException, PermissionDeniedException
TriggerEnablers.
In plenary mode, the returned list contains all known trigger enablers
or an error results. Otherwise, the returned list may contain only
those trigger enablers that are accessible through this session.
In active mode, trigger enablers are returned that are currently
active. In any status mode, active and inactive trigger enablers are
returned. TriggerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.