org.osid.control

Interface SettingSystemAssignmentSession

All Superinterfaces:

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

public interface SettingSystemAssignmentSession
extends OsidSession

This session provides methods to re-assign Settings to System mappings. A Setting may appear in multiple System objects and removing the last reference to a Setting is the equivalent of deleting it. Each System may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Setting to another System is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSettingToSystem(Id settingId, Id systemId) Adds an existing Setting to a System.
boolean	canAssignSettings() Tests if this user can alter setting/system mappings.
boolean	canAssignSettingsToSystem(Id systemId) Tests if this user can alter setting/system mappings.
IdList	getAssignableSystemIds(Id systemId) Gets a list of systems including and under the given system node in which any setting can be assigned.
IdList	getAssignableSystemIdsForSetting(Id systemId, Id settingId) Gets a list of systems including and under the given system node in which a specific setting can be assigned.
void	reassignSettingToSystem(Id settingId, Id fromSystemId, Id toSystemId) Moves a Setting from one System to another.
void	unassignSettingFromSystem(Id settingId, Id systemId) Removes a Setting from a System.

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

canAssignSettings

boolean canAssignSettings()

Tests if this user can alter setting/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if setting is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignSettingsToSystem

boolean canAssignSettingsToSystem(Id systemId)

Tests if this user can alter setting/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parameters:

systemId - the Id of the System

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - systemId is null

Compliance:

mandatory - This method must be implemented.

getAssignableSystemIds

IdList getAssignableSystemIds(Id systemId)
                              throws OperationFailedException

Gets a list of systems including and under the given system node in which any setting can be assigned.

Parameters:

systemId - the Id of the System

Returns:

list of assignable system Ids

Throws:

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableSystemIdsForSetting

IdList getAssignableSystemIdsForSetting(Id systemId,
                                      Id settingId)
                                        throws OperationFailedException

Gets a list of systems including and under the given system node in which a specific setting can be assigned.

Parameters:

systemId - the Id of the System

settingId - the Id of the Setting

Returns:

list of assignable system Ids

Throws:

NullArgumentException - systemId or settingId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSettingToSystem

void assignSettingToSystem(Id settingId,
                         Id systemId)
                           throws AlreadyExistsException,
                                  NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Adds an existing Setting to a System.

Parameters:

settingId - the Id of the Setting

systemId - the Id of the System

Throws:

AlreadyExistsException - settingId is already assigned to systemId

NotFoundException - settingId or systemId not found

NullArgumentException - settingId or systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSettingFromSystem

void unassignSettingFromSystem(Id settingId,
                             Id systemId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Removes a Setting from a System.

Parameters:

settingId - the Id of the Setting

systemId - the Id of the System

Throws:

NotFoundException - settingId or systemId not found or settingId not assigned to systemId

NullArgumentException - settingId or systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignSettingToSystem

void reassignSettingToSystem(Id settingId,
                           Id fromSystemId,
                           Id toSystemId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Moves a Setting from one System to another. Mappings to other Systems are unaffected.

Parameters:

settingId - the Id of the Setting

fromSystemId - the Id of the current System

toSystemId - the Id of the destination System

Throws:

NotFoundException - settingId, fromSystemId, or toSystemId not found or sceneId not mapped to fromSystemId

NullArgumentException - settingId, fromSystemId, or toSystemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.