org.osid.control.rules

Interface TriggerEnablerRuleLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface TriggerEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve TriggerEnabler to Trigger mappings. A Device with multiple TriggerEnablers means any positive rule evaluation across the enablers result in an effective Device.

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
• isolated system view: All methods in this session operate, retrieve and pertain trigger enablers defined explicitly in the current system
• federated system view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupTriggerEnablerRules() Tests if this user can perform lookups of trigger enabler/trigger mappings.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
IdList	getTriggerEnablerIdsForTrigger(Id triggerId) Gets the TriggerEnabler Id associated with a Trigger.
TriggerEnablerList	getTriggerEnablersForTrigger(Id triggerId) Gets the TriggerEnablers associated with a Trigger.
IdList	getTriggerIdsForTriggerEnabler(Id triggerEnablerId) Gets the Trigger Ids mapped to a TriggerEnabler.
TriggerList	getTriggersForTriggerEnabler(Id triggerEnablerId) Gets the Triggers mapped to a TriggerEnabler.
void	useComparativeTriggerEnablerRuleView() 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	usePlenaryTriggerEnablerRuleView() A complete view of the TriggerEnabler and Trigger returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canLookupTriggerEnablerRules

boolean canLookupTriggerEnablerRules()

Tests if this user can perform lookups of trigger enabler/trigger 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.

useComparativeTriggerEnablerRuleView

void useComparativeTriggerEnablerRuleView()

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.

usePlenaryTriggerEnablerRuleView

void usePlenaryTriggerEnablerRuleView()

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

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.

getTriggerEnablerIdsForTrigger

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

Gets the TriggerEnabler Id associated with a Trigger.

Parameters:

triggerId - Id of the Trigger

Returns:

the trigger enabler Ids

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.

getTriggerEnablersForTrigger

TriggerEnablerList getTriggerEnablersForTrigger(Id triggerId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the TriggerEnablers associated with a Trigger.

Parameters:

triggerId - Id of the Trigger

Returns:

the trigger enablers

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.

getTriggerIdsForTriggerEnabler

IdList getTriggerIdsForTriggerEnabler(Id triggerEnablerId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the Trigger Ids mapped to a TriggerEnabler.

Parameters:

triggerEnablerId - Id of a TriggerEnabler

Returns:

list of trigger Ids

Throws:

NotFoundException - triggerEnablerId is not found

NullArgumentException - triggerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTriggersForTriggerEnabler

TriggerList getTriggersForTriggerEnabler(Id triggerEnablerId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the Triggers mapped to a TriggerEnabler.

Parameters:

triggerEnablerId - Id of a TriggerEnabler

Returns:

list of triggers

Throws:

NotFoundException - triggerEnablerId is not found

NullArgumentException - triggerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.