org.osid.control

Interface InputSmartSystemSession

All Superinterfaces:

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

public interface InputSmartSystemSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A InputQuery can be retrieved from this session and systemped to this System to create a virtual collection of Inputs. The inputs may be sequenced using the InputSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyInputQuery(InputQuery inputQuery) Applies an input query to this system.
void	applyInputSequencing(InputSearchOrder inputSearchOrder) Applies an input search order to this system.
boolean	canManageSmartSystems() Tests if this user can manage smart systems.
InputQuery	getInputQuery() Gets an input query.
InputQuery	getInputQueryFromInspector(InputQueryInspector inputQueryInspector) Gets an input query from an inspector.
InputSearchOrder	getInputSearchOrder() Gets an input search order.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
InputQueryInspector	inspectInputQuery() Gets an input 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.

getInputQuery

InputQuery getInputQuery()

Gets an input query.

Returns:

the input query

Compliance:

mandatory - This method must be implemented.

getInputSearchOrder

InputSearchOrder getInputSearchOrder()

Gets an input search order.

Returns:

the input search order

Compliance:

mandatory - This method must be implemented.

applyInputQuery

void applyInputQuery(InputQuery inputQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies an input query to this system.

Parameters:

inputQuery - the input query

Throws:

NullArgumentException - inputQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - inputQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectInputQuery

InputQueryInspector inspectInputQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an input query inspector for this system.

Returns:

the input query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyInputSequencing

void applyInputSequencing(InputSearchOrder inputSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies an input search order to this system.

Parameters:

inputSearchOrder - the input search order

Throws:

NullArgumentException - inputSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - inputSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getInputQueryFromInspector

InputQuery getInputQueryFromInspector(InputQueryInspector inputQueryInspector)

Gets an input query from an inspector.

Parameters:

inputQueryInspector - an input query inspector

Returns:

the input query

Throws:

NullArgumentException - inputQueryInspector is null

UnsupportedException - inputQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.