Interface ControllerSystemSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ControllerSystemSession
extends OsidSession

This session provides methods to retrieve Controller to System mappings. A Controller may appear in multiple Systems . 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	canLookupControllerSystemMappings()	Tests if this user can perform lookups of controller/system mappings.
IdList	getControllerIdsBySystem(Id systemId)	Gets the list of Controller Ids associated with a System .
IdList	getControllerIdsBySystems(IdList systemIds)	Gets the list of Controller Ids corresponding to a list of Systems .
ControllerList	getControllersBySystem(Id systemId)	Gets the list of controllers associated with a System .
ControllerList	getControllersBySystems(IdList systemIds)	Gets the list of controllers corresponding to a list of Systems .
IdList	getSystemIdsByController(Id controllerId)	Gets the System Ids mapped to a Controller .
SystemList	getSystemsByController(Id controllerId)	Gets the Systems mapped to a Controller .
void	useComparativeControllerSystemView()	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	usePlenaryControllerSystemView()	A complete view of the Controller 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

canLookupControllerSystemMappings

boolean canLookupControllerSystemMappings()

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

useComparativeControllerSystemView

void useComparativeControllerSystemView()

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.

usePlenaryControllerSystemView

void usePlenaryControllerSystemView()

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

getControllerIdsBySystem

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

Gets the list of Controller Ids associated with a System .

Parameters:

systemId - Id of the System

Returns:

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

getControllersBySystem

ControllerList getControllersBySystem(Id systemId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of controllers associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related controllers

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.

getControllerIdsBySystems

IdList getControllerIdsBySystems(IdList systemIds)
                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

systemIds - list of system Ids

Returns:

list of controller Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getControllersBySystems

ControllerList getControllersBySystems(IdList systemIds)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

systemIds - list of system Ids

Returns:

list of controllers

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByController

IdList getSystemIdsByController(Id controllerId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the System Ids mapped to a Controller .

Parameters:

controllerId - Id of a Controller

Returns:

list of systems

Throws:

NotFoundException - controllerId is not found

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByController

SystemList getSystemsByController(Id controllerId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Systems mapped to a Controller .

Parameters:

controllerId - Id of a Controller

Returns:

list of systems

Throws:

NotFoundException - controllerId is not found

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.