blackboard.cms.lrngobj
Class LOCategoryTree

java.lang.Object
  blackboard.cms.lrngobj.LOCategoryTree

public class LOCategoryTree

extends java.lang.Object

Learning Object Category Tree within the Blackboard application.

Since:

Bb CS 1.2

Version:

$Revision: $

Method Summary

java.util.SortedSet	getCategoriesByParentId(blackboard.persist.Id id) Returns a SortedSet of LOCategory Items based on the Parent Id.
LOCategory	getCategoryById(blackboard.persist.Id id) Return a LOCategory item based on an Id
java.util.SortedSet	getTopLevelCategories() Returns a SortedSet of all the Top Level Categories.
static LOCategoryTree	loadTree() Build a LOCategoryTree object that is populated with all the LOCategory items

Methods inherited from class java.lang.Object

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

Method Detail

loadTree

public static LOCategoryTree loadTree()
                               throws blackboard.persist.PersistenceException

Build a LOCategoryTree object that is populated with all the LOCategory items

Returns:

a LOCategoryTree object

Throws:

blackboard.persist.PersistenceException

Since:

Bb CS 1.2

getTopLevelCategories

public java.util.SortedSet getTopLevelCategories()

Returns a SortedSet of all the Top Level Categories.

Returns:

a SortedSet of LOCategory items taht represent the Top Level Categories

Throws:

blackboard.persist.PersistenceException

Since:

Bb CS 1.2

getCategoriesByParentId

public java.util.SortedSet getCategoriesByParentId(blackboard.persist.Id id)

Returns a SortedSet of LOCategory Items based on the Parent Id. This method is useful for determining the child categories given a parent category

Parameters:

id - the Parent Id of the LOCategory Item

Returns:

Returns a SortedSet of LOCategory Items based on the Parent Id

Since:

Bb CS 1.2

getCategoryById

public LOCategory getCategoryById(blackboard.persist.Id id)

Return a LOCategory item based on an Id

Parameters:

id - the Id of the LOCategory item

Returns:

Return a LOCategory item based on an Id

Since:

Bb CS 1.2