org.osid.control

Interface SettingSystemSession

All Superinterfaces:

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

public interface SettingSystemSession
extends OsidSession

This session provides methods to retrieve Setting to System settings. A Setting 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	canLookupSettingSystemSettings() Tests if this user can perform lookups of setting/system mappings.
IdList	getSettingIdsBySystem(Id systemId) Gets the list of Setting Ids associated with a System.
IdList	getSettingIdsBySystems(IdList systemIds) Gets the list of Setting Ids corresponding to a list of Systems.
SettingList	getSettingsBySystem(Id systemId) Gets the list of Settings associated with a System.
SettingList	getSettingsBySystems(IdList systemIds) Gets the list of Settings corresponding to a list of Systems.
IdList	getSystemIdsBySetting(Id settingId) Gets the System Ids mapped to a Setting.
SystemList	getSystemsBySetting(Id settingId) Gets the Systems mapped to a Setting.
void	useComparativeSettingSystemView() 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	usePlenarySettingSystemView() A complete view of the Setting 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

canLookupSettingSystemSettings

boolean canLookupSettingSystemSettings()

Tests if this user can perform lookups of setting/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 settings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSettingSystemView

void useComparativeSettingSystemView()

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.

usePlenarySettingSystemView

void usePlenarySettingSystemView()

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

getSettingIdsBySystem

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

Gets the list of Setting Ids associated with a System.

Parameters:

systemId - Id of the System

Returns:

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

getSettingsBySystem

SettingList getSettingsBySystem(Id systemId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of Settings associated with a System.

Parameters:

systemId - Id of the System

Returns:

list of related settings

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.

getSettingIdsBySystems

IdList getSettingIdsBySystems(IdList systemIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

systemIds - list of system Ids

Returns:

list of setting Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSettingsBySystems

SettingList getSettingsBySystems(IdList systemIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

systemIds - list of system Ids

Returns:

list of settings

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsBySetting

IdList getSystemIdsBySetting(Id settingId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the System Ids mapped to a Setting.

Parameters:

settingId - Id of a Setting

Returns:

list of systems

Throws:

NotFoundException - settingId is not found

NullArgumentException - settingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsBySetting

SystemList getSystemsBySetting(Id settingId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the Systems mapped to a Setting.

Parameters:

settingId - Id of a Setting

Returns:

list of systems

Throws:

NotFoundException - settingId is not found

NullArgumentException - settingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.