com.arsdigita.categorization
Class CategoryCollection

java.lang.Object
  extended bycom.arsdigita.domain.DomainQuery
      extended bycom.arsdigita.domain.DomainCollection
          extended bycom.arsdigita.kernel.ACSObjectCollection
              extended bycom.arsdigita.categorization.CategoryCollection
All Implemented Interfaces:
DataQuery

public class CategoryCollection
extends ACSObjectCollection

Represents a collection of categories.

Instances of this class are produced by various methods in Category and other classes. See, for example, Category.getChildren() or Category.getDescendants().

Version:
$Revision: #14 $ $DateTime: 2004/04/07 16:07:11 $
Author:
Randy Graebner (randyg@alum.mit.edu)

Field Summary
 
Fields inherited from class com.arsdigita.kernel.ACSObjectCollection
versionId
 
Fields inherited from class com.arsdigita.domain.DomainCollection
m_dataCollection
 
Fields inherited from class com.arsdigita.domain.DomainQuery
m_dataQuery
 
Constructor Summary
CategoryCollection(DataCollection dataCollection)
           
 
Method Summary
 ACSObject getACSObject()
          Wrapper to getDomainObject() that casts the returned DomainObject as an ACSObject.
 Category getCategory()
          Wrapper to getDomainObject() that casts the returned DomainObject as a Category.
 String getDescription()
          Returns the description.
 String getName()
          Returns the name of the category.
 boolean isEnabled()
          Determines the current state of the category.
 void sort(boolean ascending)
          Sorts the category collection by the category sort key.
 
Methods inherited from class com.arsdigita.kernel.ACSObjectCollection
getDisplayName, getDomainObject, getID, getSpecificObjectType
 
Methods inherited from class com.arsdigita.domain.DomainQuery
addEqualsFilter, addFilter, addFilter, addInSubqueryFilter, addInSubqueryFilter, addNotEqualsFilter, addNotInSubqueryFilter, addOrder, addOrderWithNull, addPath, alias, clearFilter, clearOrder, close, first, get, getFilterFactory, getParameter, getPosition, getPropertyValues, getType, hasProperty, isAfterLast, isBeforeFirst, isEmpty, isFirst, isLast, last, next, previous, removeFilter, reset, rewind, setFilter, setOrder, setParameter, setRange, setRange, setReturnsLowerBound, setReturnsUpperBound, size
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CategoryCollection

public CategoryCollection(DataCollection dataCollection)
Method Detail

getName

public String getName()
Returns the name of the category.

Returns:
the category name.
See Also:
Category.getName()

getDescription

public String getDescription()
Returns the description.

Returns:
the description
See Also:
Category.getDescription()

isEnabled

public boolean isEnabled()
Determines the current state of the category.

Returns:
true if the category is enabled; false otherwise.
See Also:
Category.isEnabled()

getCategory

public Category getCategory()
Wrapper to getDomainObject() that casts the returned DomainObject as a Category.

Returns:
a Category for the current position in the collection.

getACSObject

public ACSObject getACSObject()
Description copied from class: ACSObjectCollection
Wrapper to getDomainObject() that casts the returned DomainObject as an ACSObject.

Overrides:
getACSObject in class ACSObjectCollection
Returns:
an ACSObject for the current position in the collection.
See Also:
ACSObjectCollection.getDomainObject(), Party, DomainObject

sort

public final void sort(boolean ascending)
Sorts the category collection by the category sort key.

See Also:
CategorizedCollection.sort(boolean)


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC