Interface TriggerSystemSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TriggerSystemSession
extends OsidSession

This session provides methods to retrieve Trigger to System mappings. A Trigger may appear in multiple Systems . Each system may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupTriggerSystemMappings()	Tests if this user can perform lookups of trigger/system mappings.
IdList	getSystemIdsByTrigger(Id triggerId)	Gets the System Ids mapped to a Trigger .
SystemList	getSystemsByTrigger(Id triggerId)	Gets the Systems mapped to a Trigger .
IdList	getTriggerIdsBySystem(Id systemId)	Gets the list of Trigger Ids associated with a System .
IdList	getTriggerIdsBySystems(IdList systemIds)	Gets the list of Trigger Ids corresponding to a list of Systems .
TriggerList	getTriggersBySystem(Id systemId)	Gets the list of Triggers associated with a System .
TriggerList	getTriggersBySystems(IdList systemIds)	Gets the list of Trigger corresponding to a list of Systems .
void	useComparativeTriggerSystemView()	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	usePlenaryTriggerSystemView()	A complete view of the Trigger and System 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

canLookupTriggerSystemMappings

boolean canLookupTriggerSystemMappings()

Tests if this user can perform lookups of trigger/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeTriggerSystemView

void useComparativeTriggerSystemView()

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.

usePlenaryTriggerSystemView

void usePlenaryTriggerSystemView()

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

getTriggerIdsBySystem

IdList getTriggerIdsBySystem(Id systemId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Trigger Ids associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related trigger Ids

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggersBySystem

TriggerList getTriggersBySystem(Id systemId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Triggers associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related triggers

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggerIdsBySystems

IdList getTriggerIdsBySystems(IdList systemIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Trigger Ids corresponding to a list of Systems .

Parameters:

systemIds - list of system Ids

Returns:

list of trigger Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggersBySystems

TriggerList getTriggersBySystems(IdList systemIds)
                          throws OperationFailedException,
PermissionDeniedException

Gets the list of Trigger corresponding to a list of Systems .

Parameters:

systemIds - list of system Ids

Returns:

list of triggers

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByTrigger

IdList getSystemIdsByTrigger(Id triggerId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the System Ids mapped to a Trigger .

Parameters:

triggerId - Id of a Trigger

Returns:

list of systems

Throws:

NotFoundException - triggerId is not found

NullArgumentException - triggerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByTrigger

SystemList getSystemsByTrigger(Id triggerId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Systems mapped to a Trigger .

Parameters:

triggerId - Id of a Trigger

Returns:

list of systems

Throws:

NotFoundException - triggerId is not found

NullArgumentException - triggerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.