blackboard.data.navigation
Class ToolSettings.SettingsAttribute

java.lang.Object
  extended by blackboard.data.navigation.ToolSettings.SettingsAttribute
Direct Known Subclasses:
CourseToolSettings.CourseSettingsAttribute
Enclosing class:
ToolSettings

public static class ToolSettings.SettingsAttribute
extends java.lang.Object

Encapsulates everything interesting about a tool setting:

  1. Whether it's enabled
  2. Whether it's locked
  3. What node it was set at


Field Summary
protected  ToolSettings.Availability _availability
           
protected  boolean _isApplicable
           
protected  Node _node
           
protected  Id _nodeId
           
static ToolSettings.SettingsAttribute INAPPLICABLE_SETTING
          Used for any setting that cannot be set because system explicitly disabled it completely for tool or it is not applicable to type of tool.
 
Constructor Summary
ToolSettings.SettingsAttribute(ToolSettings.Availability availability, Id nodeId)
           
 
Method Summary
 ToolSettings.Availability getAvailability()
           
 Node getNode()
           
 Id getNodeId()
           
 java.lang.String getNodeName()
           
 boolean isApplicable()
           
 boolean isAvailable()
           
 boolean isLocked()
           
 void setAvailability(ToolSettings.Availability availability)
           
 void setNode(Node node)
           
 void setNodeId(Id nodeId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INAPPLICABLE_SETTING

public static final ToolSettings.SettingsAttribute INAPPLICABLE_SETTING
Used for any setting that cannot be set because system explicitly disabled it completely for tool or it is not applicable to type of tool. For instance, ToolSettings.getGuest/ObserverSetting will return this value if tool's canAllowGuest/Observer flag is set to false or tool is ContentHandler type.

Availability value of this setting is OffLocked, isApplicable is false, and nodeId is institutional hierarchy's root node id indicating it is enforced at system level.


_availability

protected ToolSettings.Availability _availability

_nodeId

protected Id _nodeId

_node

protected Node _node

_isApplicable

protected boolean _isApplicable
Constructor Detail

ToolSettings.SettingsAttribute

public ToolSettings.SettingsAttribute(ToolSettings.Availability availability,
                                      Id nodeId)
Method Detail

isAvailable

public boolean isAvailable()

isLocked

public boolean isLocked()

isApplicable

public boolean isApplicable()
Returns:
false if setting is not applicable to type of tool or completely disabled so it can't be used. true, otherwise.

getAvailability

public ToolSettings.Availability getAvailability()

setAvailability

public void setAvailability(ToolSettings.Availability availability)

getNodeId

public Id getNodeId()

setNodeId

public void setNodeId(Id nodeId)

getNode

public Node getNode()

setNode

public void setNode(Node node)

getNodeName

public java.lang.String getNodeName()


Copyright © 2012 Blackboard, Inc. All Rights Reserved.