Interface TriggerEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TriggerEnablerLookupSession
extends OsidSession

This session provides methods for retrieving TriggerEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated system view: All trigger enabler methods in this session operate, retrieve and pertain to trigger enablers defined explicitly in the current system. Using an isolated view is useful for managing TriggerEnablers with the TriggerEnablerAdminSession .
• federated system view: All trigger enabler methods in this session operate, retrieve and pertain to all trigger enablers defined in this system and any other trigger enablers implicitly available in this system through system inheritence.
• activee trigger enabler view: All trigger enabler lookup methods return active trigger enablers.
• any status trigger enabler view: trigger enablers of any active or inactive status are returned from methods.

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
          throws OperationFailedException,
PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupTriggerEnablers

boolean canLookupTriggerEnablers()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeTriggerEnablerView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryTriggerEnablerView

void usePlenaryTriggerEnablerView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

useFederatedSystemView

void useFederatedSystemView()

Federates the view for methods in this session. A federated view will include trigger enablers in systems which are children of this system in the system hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedSystemView

void useIsolatedSystemView()

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

Compliance:

mandatory - This method is must be implemented.

useActiveTriggerEnablerView

void useActiveTriggerEnablerView()

Only active trigger enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusTriggerEnablerView

void useAnyStatusTriggerEnablerView()

All active and inactive trigger enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getTriggerEnabler

TriggerEnabler getTriggerEnabler(Id triggerEnablerId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the 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.

Parameters:

triggerEnablerId - Id of the TriggerEnabler

Returns:

the trigger enabler

Throws:

NotFoundException - triggerEnablerId not found

NullArgumentException - triggerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getTriggerEnablersByIds

TriggerEnablerList getTriggerEnablersByIds(IdList triggerEnablerIds)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a 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.

Parameters:

triggerEnablerIds - the list of Ids to retrieve

Returns:

the returned TriggerEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - triggerEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggerEnablersByGenusType

TriggerEnablerList getTriggerEnablersByGenusType(Type triggerEnablerGenusType)
                                          throws OperationFailedException,
PermissionDeniedException

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 . 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.

Parameters:

triggerEnablerGenusType - a trigger enabler genus type

Returns:

the returned TriggerEnabler list

Throws:

NullArgumentException - triggerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggerEnablersByParentGenusType

TriggerEnablerList getTriggerEnablersByParentGenusType(Type triggerEnablerGenusType)
                                                throws OperationFailedException,
PermissionDeniedException

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 . 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.

Parameters:

triggerEnablerGenusType - a trigger enabler genus type

Returns:

the returned TriggerEnabler list

Throws:

NullArgumentException - triggerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggerEnablersByRecordType

TriggerEnablerList getTriggerEnablersByRecordType(Type triggerEnablerRecordType)
                                           throws OperationFailedException,
PermissionDeniedException

Gets a 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.

Parameters:

triggerEnablerRecordType - a trigger enabler record type

Returns:

the returned TriggerEnabler list

Throws:

NullArgumentException - triggerEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggerEnablersOnDate

TriggerEnablerList getTriggerEnablersOnDate(DateTime from,
 DateTime to)
                                     throws OperationFailedException,
PermissionDeniedException

Gets a 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.

Parameters:

from - a start date

to - an end date

Returns:

the returned TriggerEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggerEnablersOnDateWithAgent

TriggerEnablerList getTriggerEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                              throws OperationFailedException,
PermissionDeniedException

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. 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.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned TriggerEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggerEnablers

TriggerEnablerList getTriggerEnablers()
                               throws OperationFailedException,
PermissionDeniedException

Gets all 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.

Returns:

the returned TriggerEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.