Interface InputEnablerSystemSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InputEnablerSystemSession
extends OsidSession

This session provides methods to retrieve InputEnabler to System mappings. An InputEnabler 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

Modifier and Type	Method	Description
boolean	canLookupInputEnablerSystemMappings()	Tests if this user can perform lookups of input enabler/system mappings.
IdList	getInputEnablerIdsBySystem(Id systemId)	Gets the list of InputEnablerIds associated with a System .
IdList	getInputEnablerIdsBySystems(IdList systemIds)	Gets the list of InputEnabler Ids corresponding to a list of Systems .
InputEnablerList	getInputEnablersBySystem(Id systemId)	Gets the list of input enablers associated with a System .
InputEnablerList	getInputEnablersBySystems(IdList systemIds)	Gets the list of input enablers corresponding to a list of Systems .
IdList	getSystemIdsByInputEnabler(Id inputEnablerId)	Gets the System Ids mapped to an InputEnabler .
SystemList	getSystemsByInputEnabler(Id inputEnablerId)	Gets the Systems mapped to an InputEnabler .
void	useComparativeInputEnablerSystemView()	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	usePlenaryInputEnablerSystemView()	A complete view of the InputEnabler and System returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupInputEnablerSystemMappings

boolean canLookupInputEnablerSystemMappings()

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

useComparativeInputEnablerSystemView

void useComparativeInputEnablerSystemView()

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.

usePlenaryInputEnablerSystemView

void usePlenaryInputEnablerSystemView()

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

getInputEnablerIdsBySystem

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

Gets the list of InputEnablerIds associated with a System .

Parameters:

systemId - Id of the System

Returns:

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

getInputEnablersBySystem

InputEnablerList getInputEnablersBySystem(Id systemId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of input enablers associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related input enablers

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.

getInputEnablerIdsBySystems

IdList getInputEnablerIdsBySystems(IdList systemIds)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

systemIds - list of system Ids

Returns:

list of input enabler Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputEnablersBySystems

InputEnablerList getInputEnablersBySystems(IdList systemIds)
                                    throws OperationFailedException,
PermissionDeniedException

Gets the list of input enablers corresponding to a list of Systems .

Parameters:

systemIds - list of system Ids

Returns:

list of input enablers

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByInputEnabler

IdList getSystemIdsByInputEnabler(Id inputEnablerId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the System Ids mapped to an InputEnabler .

Parameters:

inputEnablerId - Id of an InputEnabler

Returns:

list of system Ids

Throws:

NotFoundException - inputEnablerId is not found

NullArgumentException - inputEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByInputEnabler

SystemList getSystemsByInputEnabler(Id inputEnablerId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Systems mapped to an InputEnabler .

Parameters:

inputEnablerId - Id of an InputEnabler

Returns:

list of systems

Throws:

NotFoundException - inputEnablerId is not found

NullArgumentException - inputEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.