blackboard.dataintegration.ims.data
Class HierarchyProperties

java.lang.Object
  extended by blackboard.dataintegration.ims.data.HierarchyProperties

public class HierarchyProperties
extends java.lang.Object

Properties that define how IMS integrations handle incoming group items translate into Learn nodes.

NOTE: This class is included in the Public API for use by Data Integration custom field mapping scripts. It should not be used by any Building Blocks.

Since:
Bb 9.1 SP6

Constructor Summary
HierarchyProperties()
          Constructor.
HierarchyProperties(java.lang.String blob)
          Constructor.
 
Method Summary
 java.lang.String enblobinate()
          Converts the properties into a text blob that can later be rehydrated into a full-fledged object.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getSelectedRootNode()
          The batchUID of the node to which all incoming top-level nodes should be associated.
 int hashCode()
           
 boolean isPerformSectionAssociation()
          Whether the integration should create course associations for any course-section level learning contexts in the feed.
 boolean isUseCourseLevel()
          Whether to import Course-level group elements from the Vista feed file.
 boolean isUseDivisionLevel()
          Whether to import Division-level group elements from the Vista feed file.
 boolean isUseGroupLevel()
          Whether to import Group-level group elements from the Vista feed file.
 boolean isUseSystemRootNode()
          Whether to attach top-level nodes to Learn root, or to the node specified by the integration.
 void setPerformSectionAssociation(boolean performSectionAssociation)
          Whether the integration should create course associations for any course-section level learning contexts in the feed.
 void setSelectedRootNode(java.lang.String selectedRootNode)
          The batchUID of the node to which all incoming top-level nodes should be associated.
 void setUseCourseLevel(boolean useCourseLevel)
          Whether to import Course-level group elements from the Vista feed file.
 void setUseDivisionLevel(boolean useDivisionLevel)
          Whether to import Division-level group elements from the Vista feed file.
 void setUseGroupLevel(boolean useGroupLevel)
          Whether to import Group-level group elements from the Vista feed file.
 void setUseSystemRootNode(boolean useSystemRootNode)
          Whether to attach top-level nodes to Learn root, or to the node specified by the integration.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HierarchyProperties

public HierarchyProperties()
Constructor.


HierarchyProperties

public HierarchyProperties(java.lang.String blob)
Constructor. Builds a properties object based on the the given raw string. The string must be build by the enblobinate() method. String blob A blob of text representing the properties.

Method Detail

isUseDivisionLevel

public boolean isUseDivisionLevel()
Whether to import Division-level group elements from the Vista feed file. If set to true, Learn nodes will be created for each division learning context. If set to false, division learning contexts will be ignored. Defaults to true.

Returns:
Whether to import division learning contexts.

setUseDivisionLevel

public void setUseDivisionLevel(boolean useDivisionLevel)
Whether to import Division-level group elements from the Vista feed file. If set to true, Learn nodes will be created for each division learning context. If set to false, division learning contexts will be ignored. Defaults to true.

Parameters:
useDivisionLevel - Whether to import division learning contexts.

isUseGroupLevel

public boolean isUseGroupLevel()
Whether to import Group-level group elements from the Vista feed file. If set to true, Learn nodes will be created for each group learning context. If set to false, group learning contexts will be ignored. Defaults to true.

Returns:
Whether to import group learning contexts.

setUseGroupLevel

public void setUseGroupLevel(boolean useGroupLevel)
Whether to import Group-level group elements from the Vista feed file. If set to true, Learn nodes will be created for each group learning context. If set to false, group learning contexts will be ignored. Defaults to true.

Parameters:
useGroupLevel - Whether to import group learning contexts.

isUseCourseLevel

public boolean isUseCourseLevel()
Whether to import Course-level group elements from the Vista feed file. If set to true, Learn nodes will be created for each course learning context. If set to false, course learning contexts will be ignored. Defaults to false.

Returns:
Whether to import course learning contexts.

setUseCourseLevel

public void setUseCourseLevel(boolean useCourseLevel)
Whether to import Course-level group elements from the Vista feed file. If set to true, Learn nodes will be created for each course learning context. If set to false, course learning contexts will be ignored. Defaults to false.

Parameters:
useCourseLevel - Whether to import course learning contexts.

isPerformSectionAssociation

public boolean isPerformSectionAssociation()
Whether the integration should create course associations for any course-section level learning contexts in the feed. If false, then no course associations will be created. If true, incoming courses will be associated with the nearest available/enabled node. Example: if this property is enabled and course-level learning contexts import is disabled (see isUseCourseLevel()) , then the courses created by these course section will be associated with the group that is the parent of the suppressed course. Note that this has no effect on whether the course is created -- only whether it is associated with any nodes.

Returns:
True if the integration should perform section associations.
See Also:
isUseDivisionLevel(), isUseGroupLevel(), isUseCourseLevel()

setPerformSectionAssociation

public void setPerformSectionAssociation(boolean performSectionAssociation)
Whether the integration should create course associations for any course-section level learning contexts in the feed. If false, then no course associations will be created. If true, incoming courses will be associated with the nearest available/enabled node. Example: if this property is enabled and course-level learning contexts import is disabled (see isUseCourseLevel()) , then the courses created by these course section will be associated with the group that is the parent of the suppressed course. Note that this has no effect on whether the course is created -- only whether it is associated with any nodes.

Parameters:
performSectionAssociation - True if the integration should perform section associations.
See Also:
isUseDivisionLevel(), isUseGroupLevel(), isUseCourseLevel()

isUseSystemRootNode

public boolean isUseSystemRootNode()
Whether to attach top-level nodes to Learn root, or to the node specified by the integration.

Returns:
true if the integration should use Learn root; false if it should use the selected node.
See Also:
getSelectedRootNode()

setUseSystemRootNode

public void setUseSystemRootNode(boolean useSystemRootNode)
Whether to attach top-level nodes to Learn root, or to the node specified by the integration.

Parameters:
useSystemRootNode - true if the integration should use Learn root; false if it should use the selected node.
See Also:
getSelectedRootNode()

getSelectedRootNode

public java.lang.String getSelectedRootNode()
The batchUID of the node to which all incoming top-level nodes should be associated. Only applies when isUseSystemRootNode() is false.

Returns:
The batch uid of the selected root node.
See Also:
Node.getIdentifier(), isUseSystemRootNode()

setSelectedRootNode

public void setSelectedRootNode(java.lang.String selectedRootNode)
The batchUID of the node to which all incoming top-level nodes should be associated. Only applies when isUseSystemRootNode() is false.

Parameters:
selectedRootNode - The batch uid of the selected root node.
See Also:
Node.getIdentifier(), isUseSystemRootNode()

enblobinate

public java.lang.String enblobinate()
Converts the properties into a text blob that can later be rehydrated into a full-fledged object.

Returns:
Enblobified properties.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2012 Blackboard, Inc. All Rights Reserved.