org.osid.control

Interface InputSystemSession

All Superinterfaces:

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

public interface InputSystemSession
extends OsidSession

This session provides methods to retrieve Input to System mappings. A Input may appear in multiple System objects. 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

Methods

Modifier and Type	Method and Description
boolean	canLookupInputSystemMappings() Tests if this user can perform lookups of input/system mappings.
IdList	getInputIdsBySystem(Id systemId) Gets the list of Input Ids associated with a System.
IdList	getInputIdsBySystems(IdList systemIds) Gets the list of Input Ids corresponding to a list of Systems.
InputList	getInputsBySystem(Id systemId) Gets the list of Inputs associated with a System.
InputList	getInputsBySystems(IdList systemIds) Gets the list of Input corresponding to a list of Systems.
IdList	getSystemIdsByInput(Id inputId) Gets the System Ids mapped to a Input.
SystemList	getSystemsByInput(Id inputId) Gets the Systems mapped to a Input.
void	useComparativeInputSystemView() 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	usePlenaryInputSystemView() A complete view of the Input and System 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

canLookupInputSystemMappings

boolean canLookupInputSystemMappings()

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

useComparativeInputSystemView

void useComparativeInputSystemView()

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.

usePlenaryInputSystemView

void usePlenaryInputSystemView()

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

getInputIdsBySystem

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

Gets the list of Input Ids associated with a System.

Parameters:

systemId - Id of the System

Returns:

list of related input 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.

getInputsBySystem

InputList getInputsBySystem(Id systemId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the list of Inputs associated with a System.

Parameters:

systemId - Id of the System

Returns:

list of related inputs

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.

getInputIdsBySystems

IdList getInputIdsBySystems(IdList systemIds)
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Parameters:

systemIds - list of system Ids

Returns:

list of input Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputsBySystems

InputList getInputsBySystems(IdList systemIds)
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

systemIds - list of system Ids

Returns:

list of inputs

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByInput

IdList getSystemIdsByInput(Id inputId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the System Ids mapped to a Input.

Parameters:

inputId - Id of a Input

Returns:

list of systems

Throws:

NotFoundException - inputId is not found

NullArgumentException - inputId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByInput

SystemList getSystemsByInput(Id inputId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the Systems mapped to a Input.

Parameters:

inputId - Id of a Input

Returns:

list of systems

Throws:

NotFoundException - inputId is not found

NullArgumentException - inputId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.