blackboard.data.navigation
Class ToolSettings

java.lang.Object
  blackboard.data.navigation.ToolSettings

Direct Known Subclasses:

CourseToolSettings

public class ToolSettings
extends java.lang.Object

The settings for a tool: whether the tool is available, and whether it's accessible to guests and observers. Also tracks setting locks, and the node at which the setting was created.

Since:

Bb 9.1 SP8

Nested Class Summary

static class	ToolSettings.Availability Tool availability settings.
static class	ToolSettings.SettingNavItem Enum used to represent the NavigationItem internal handles used for settings.
static class	ToolSettings.SettingNavItemFamily Enum used to represent the NavigationItem families used for settings.
static class	ToolSettings.SettingsAttribute Encapsulates everything interesting about a tool setting: Whether it's enabled Whether it's locked What node it was set at
static class	ToolSettings.Type

Field Summary

protected Id	_applicationId
protected java.lang.String	_applicationLabel
protected ToolSettings.SettingsAttribute	_enabled
protected ToolSettings.SettingsAttribute	_guestAllowed
protected java.lang.String	_identifier
protected ToolSettings.SettingsAttribute	_observerAllowed
protected ToolSettings.Type	_type

Constructor Summary

ToolSettings(blackboard.platform.plugin.ContentHandler cHandler)
Constructor.

ToolSettings(blackboard.platform.plugin.ContentHandler cHandler, ToolSettings.SettingsAttribute enabled)
Constructor.

ToolSettings(blackboard.data.navigation.NavigationApplication application, ToolSettings.Type type)
Constructor.

ToolSettings(blackboard.data.navigation.NavigationApplication application, ToolSettings.Type type, ToolSettings.SettingsAttribute toolSetting, ToolSettings.SettingsAttribute guestSetting, ToolSettings.SettingsAttribute observerSetting)
Constructor.

Method Summary

blackboard.data.navigation.NavigationApplication	getApplication()
Id	getApplicationId()
java.lang.String	getApplicationLabel()
blackboard.platform.plugin.ContentHandler	getContentHandler()
ToolSettings.SettingsAttribute	getGuestAllowedSetting()
java.lang.String	getIdentifier()
ToolSettings.SettingsAttribute	getObserverAllowedSetting()
ToolSettings.SettingsAttribute	getToolEnabledSetting()
ToolSettings.Type	getType()
protected void	setGuestAllowedSetting(ToolSettings.SettingsAttribute guestAllowed)
protected void	setObserverAllowedSetting(ToolSettings.SettingsAttribute observerAllowed)
protected void	setToolEnabledSetting(ToolSettings.SettingsAttribute value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_type

protected ToolSettings.Type _type

_applicationLabel

protected java.lang.String _applicationLabel

_identifier

protected java.lang.String _identifier

_applicationId

protected Id _applicationId

_enabled

protected ToolSettings.SettingsAttribute _enabled

_guestAllowed

protected ToolSettings.SettingsAttribute _guestAllowed

_observerAllowed

protected ToolSettings.SettingsAttribute _observerAllowed

Constructor Detail

ToolSettings

public ToolSettings(blackboard.data.navigation.NavigationApplication application,
                    ToolSettings.Type type)

Constructor. Use this for system-type settings only.

Parameters:

application - The tool to which these settings apply

type - The kind of object this setting applies to

ToolSettings

public ToolSettings(blackboard.data.navigation.NavigationApplication application,
                    ToolSettings.Type type,
                    ToolSettings.SettingsAttribute toolSetting,
                    ToolSettings.SettingsAttribute guestSetting,
                    ToolSettings.SettingsAttribute observerSetting)

Constructor.

Parameters:

application - The tool to which these settings apply

type - The kind of object this setting applies to

toolSetting - Setting for the tool as a whole

guestSetting - Setting for the tool's guest availability

observerSetting - Setting for the tool's observer availability

ToolSettings

public ToolSettings(blackboard.platform.plugin.ContentHandler cHandler,
                    ToolSettings.SettingsAttribute enabled)

Constructor.

Parameters:

cHandler - The content handler to create these settings for

enabled - The enabled setting

ToolSettings

public ToolSettings(blackboard.platform.plugin.ContentHandler cHandler)

Constructor. The enablement setting is derived from the content handler's availability.

Parameters:

cHandler - The content handler to create these settings for

Method Detail

getToolEnabledSetting

public ToolSettings.SettingsAttribute getToolEnabledSetting()

getGuestAllowedSetting

public ToolSettings.SettingsAttribute getGuestAllowedSetting()

Returns:

SettingsAttribute indicating if guest access is allowed and the setting is locked in node. SettingsAttribute.INAPPLICABLE_SETTING if guest access is not applicable to tool

See Also:

ToolSettings.SettingsAttribute.INAPPLICABLE_SETTING

getObserverAllowedSetting

public ToolSettings.SettingsAttribute getObserverAllowedSetting()

Returns:

SettingsAttribute indicating if observer access is allowed and the setting is locked in node. SettingsAttribute.INAPPLICABLE_SETTING if observer access is not applicable to tool

See Also:

ToolSettings.SettingsAttribute.INAPPLICABLE_SETTING

setToolEnabledSetting

protected void setToolEnabledSetting(ToolSettings.SettingsAttribute value)

setGuestAllowedSetting

protected void setGuestAllowedSetting(ToolSettings.SettingsAttribute guestAllowed)

setObserverAllowedSetting

protected void setObserverAllowedSetting(ToolSettings.SettingsAttribute observerAllowed)

getType

public ToolSettings.Type getType()

getApplicationLabel

public java.lang.String getApplicationLabel()

Returns:

localized label of application.

See Also:

NavigationApplication.getLabel()

getIdentifier

public java.lang.String getIdentifier()

getApplicationId

public Id getApplicationId()

getApplication

public blackboard.data.navigation.NavigationApplication getApplication()

getContentHandler

public blackboard.platform.plugin.ContentHandler getContentHandler()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object