org.osid.control

Interface TriggerSmartSystemSession

All Superinterfaces:

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

public interface TriggerSmartSystemSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A TriggerQuery can be retrieved from this session and mapped to this System to create a virtual collection of Triggers. The triggers may be sequenced using the TriggerSearchOrder from this session.

This System has a default query that matches any trigger and a default search order that specifies no sequencing. The queries may be examined using a TriggerQueryInspector. The query may be modified by converting the inspector back to a TriggerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTriggerQuery(TriggerQuery triggerQuery) Applies a trigger query to this system.
void	applyTriggerSequencing(TriggerSearchOrder triggerSearchOrder) Applies a trigger search order to this system.
boolean	canManageSmartSystems() Tests if this user can manage smart systems.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
TriggerQuery	getTriggerQuery() Gets a trigger query.
TriggerQuery	getTriggerQueryFromInspector(TriggerQueryInspector triggerQueryInspector) Gets a trigger query from an inspector.
TriggerSearchOrder	getTriggerSearchOrder() Gets a trigger search order.
TriggerQueryInspector	inspectTriggerQuery() Gets a trigger query inspector for this system.

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.

canManageSmartSystems

boolean canManageSmartSystems()

Tests if this user can manage smart systems. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart system management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getTriggerQuery

TriggerQuery getTriggerQuery()

Gets a trigger query.

Returns:

the trigger query

Compliance:

mandatory - This method must be implemented.

getTriggerSearchOrder

TriggerSearchOrder getTriggerSearchOrder()

Gets a trigger search order.

Returns:

the trigger search order

Compliance:

mandatory - This method must be implemented.

applyTriggerQuery

void applyTriggerQuery(TriggerQuery triggerQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Applies a trigger query to this system.

Parameters:

triggerQuery - the trigger query

Throws:

NullArgumentException - triggerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - triggerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectTriggerQuery

TriggerQueryInspector inspectTriggerQuery()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a trigger query inspector for this system.

Returns:

the trigger query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyTriggerSequencing

void applyTriggerSequencing(TriggerSearchOrder triggerSearchOrder)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a trigger search order to this system.

Parameters:

triggerSearchOrder - the trigger search order

Throws:

NullArgumentException - triggerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - triggerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getTriggerQueryFromInspector

TriggerQuery getTriggerQueryFromInspector(TriggerQueryInspector triggerQueryInspector)

Gets a trigger query from an inspector.

Parameters:

triggerQueryInspector - a trigger query inspector

Returns:

the trigger query

Throws:

NullArgumentException - triggerQueryInspector is null

UnsupportedException - triggerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.