org.osid.control

Interface InputLookupSession

All Superinterfaces:

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

public interface InputLookupSession
extends OsidSession

This session provides methods for retrieving Input objects. The Input represents a fixed connection between two Scenes.

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 trigger view: All input methods in this session operate, retrieve and pertain to inputs defined explicitly in the current trigger. Using an isolated view is useful for managing Inputs with the InputAdminSession.
• federated trigger view: All input methods in this session operate, retrieve and pertain to all inputs defined in this trigger and any other inputs implicitly available in this trigger through trigger inheritence.
• effective input view: All input lookup methods return inputs where the current date falls in between the effective dates inclusive.
• any effective input view: input of any effective date 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 useFederatedSystemView() and useIsolatedSystemView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupInputs() Tests if this user can perform Input lookups.
Input	getInput(Id inputId) Gets the Input specified by its Id.
InputList	getInputs() Gets all Inputs.
InputList	getInputsByGenusType(Type inputGenusType) Gets a InputList corresponding to the given input genus Type which does not include inputs of genus types derived from the specified Type.
InputList	getInputsByIds(IdList inputIds) Gets a InputList corresponding to the given IdList.
InputList	getInputsByParentGenusType(Type inputGenusType) Gets a InputList corresponding to the given input genus Type and include any additional inputs with genus types derived from the specified Type.
InputList	getInputsByRecordType(Type inputRecordType) Gets a InputList containing the given input record Type.
InputList	getInputsForController(Id controllerId) Gets a list of inputs for a controller.
InputList	getInputsForControllerOnDate(Id controllerId, DateTime from, DateTime to) Gets a list of inputs for a controller and effective during the entire given date range inclusive but not confined to the date range.
InputList	getInputsForDevice(Id deviceId) Gets a list of inputs for a device.
InputList	getInputsForDeviceAndController(Id deviceId, Id controllerId) Gets a list of inputs for a device and controller.
InputList	getInputsForDeviceAndControllerOnDate(Id deviceId, Id controllerId, DateTime from, DateTime to) Gets a list of inputs for the device and controller and effective during the entire given date range inclusive but not confined to the date range.
InputList	getInputsForDeviceOnDate(Id deviceId, DateTime from, DateTime to) Gets a list of inputs for a device and effective during the entire given date range inclusive but not confined to the date range.
InputList	getInputsOnDate(DateTime from, DateTime to) Gets a list of inputs effective during the entire given date range inclusive but not confined to the date range.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
void	useAnyEffectiveInputView() All input of any effective dates are returned by methods in this session.
void	useComparativeInputView() 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	useEffectiveInputView() Only inputs whose effective dates are current are returned by methods in this session.
void	useFederatedSystemView() Federates the view for methods in this session.
void	useIsolatedSystemView() Isolates the view for methods in this session.
void	usePlenaryInputView() A complete view of the Input 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.

canLookupInputs

boolean canLookupInputs()

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

useComparativeInputView

void useComparativeInputView()

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.

usePlenaryInputView

void usePlenaryInputView()

A complete view of the Input 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 inputs in systems which are children of this trigger 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.

useEffectiveInputView

void useEffectiveInputView()

Only inputs whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveInputView

void useAnyEffectiveInputView()

All input of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getInput

Input getInput(Id inputId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

Gets the Input specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Input may have a different Id than requested, such as the case where a duplicate Id was assigned to a Input and retained for compatibility. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.

Parameters:

inputId - Id of the Input

Returns:

the input

Throws:

NotFoundException - inputId not found

NullArgumentException - inputId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getInputsByIds

InputList getInputsByIds(IdList inputIds)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets a InputList corresponding to the given IdList. In plenary mode, the returned list contains all of the inputs 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 Inputs may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.

Parameters:

inputIds - the list of Ids to retrieve

Returns:

the returned Input list

Throws:

NotFoundException - an Id was not found

NullArgumentException - inputIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsByGenusType

InputList getInputsByGenusType(Type inputGenusType)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a InputList corresponding to the given input genus Type which does not include inputs of genus types derived from the specified Type. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.

Parameters:

inputGenusType - an input genus type

Returns:

the returned Input list

Throws:

NullArgumentException - inputGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsByParentGenusType

InputList getInputsByParentGenusType(Type inputGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a InputList corresponding to the given input genus Type and include any additional inputs with genus types derived from the specified Type. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.

Parameters:

inputGenusType - an input genus type

Returns:

the returned Input list

Throws:

NullArgumentException - inputGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsByRecordType

InputList getInputsByRecordType(Type inputRecordType)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a InputList containing the given input record Type. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.

Parameters:

inputRecordType - an input record type

Returns:

the returned Input list

Throws:

NullArgumentException - inputRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsOnDate

InputList getInputsOnDate(DateTime from,
                        DateTime to)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets a list of inputs effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned Input 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.

getInputsForDevice

InputList getInputsForDevice(Id deviceId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets a list of inputs for a device. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.

Parameters:

deviceId - a device Id

Returns:

the returned Input list

Throws:

NullArgumentException - deviceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsForDeviceOnDate

InputList getInputsForDeviceOnDate(Id deviceId,
                                 DateTime from,
                                 DateTime to)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a list of inputs for a device and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.

Parameters:

deviceId - a device Id

from - start of date range

to - end of date range

Returns:

the returned Input list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - deviceId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsForController

InputList getInputsForController(Id controllerId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a list of inputs for a controller. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.

Parameters:

controllerId - a controller Id

Returns:

the returned Input list

Throws:

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsForControllerOnDate

InputList getInputsForControllerOnDate(Id controllerId,
                                     DateTime from,
                                     DateTime to)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of inputs for a controller and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.

Parameters:

controllerId - a controller Id

from - start of date range

to - end of date range

Returns:

the returned Input list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - controllerId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsForDeviceAndController

InputList getInputsForDeviceAndController(Id deviceId,
                                        Id controllerId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a list of inputs for a device and controller. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.

Parameters:

deviceId - a device Id

controllerId - a controller Id

Returns:

the returned Input list

Throws:

NullArgumentException - deviceId or controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsForDeviceAndControllerOnDate

InputList getInputsForDeviceAndControllerOnDate(Id deviceId,
                                              Id controllerId,
                                              DateTime from,
                                              DateTime to)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets a list of inputs for the device and controller and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.

Parameters:

deviceId - a device Id

controllerId - a controller Id

from - start of date range

to - end of date range

Returns:

the returned Input list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - device, controllerId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputs

InputList getInputs()
                    throws OperationFailedException,
                           PermissionDeniedException

Gets all Inputs. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.

Returns:

a list of Inputs

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.