com.arsdigita.workflow.simple
Class TaskCollection

java.lang.Object
  extended bycom.arsdigita.domain.DomainQuery
      extended bycom.arsdigita.domain.DomainCollection
          extended bycom.arsdigita.workflow.simple.TaskCollection
All Implemented Interfaces:
DataQuery

public class TaskCollection
extends DomainCollection

Represents a collection on a task.

Version:
1.0
Author:
Uday Mathur, Khy Huang

Field Summary
static String versionId
           
 
Fields inherited from class com.arsdigita.domain.DomainCollection
m_dataCollection
 
Fields inherited from class com.arsdigita.domain.DomainQuery
m_dataQuery
 
Constructor Summary
TaskCollection(DataCollection dataCollection)
          Constructor.
 
Method Summary
 void addOrder(String order)
          Sets the order of this collection.
 void childrenOf(Task parent)
           
 Task getTask()
          Wrapper to getDomainObject() that casts the returned domain object as a task.
 
Methods inherited from class com.arsdigita.domain.DomainCollection
getDomainObject
 
Methods inherited from class com.arsdigita.domain.DomainQuery
addEqualsFilter, addFilter, addFilter, addInSubqueryFilter, addInSubqueryFilter, addNotEqualsFilter, addNotInSubqueryFilter, 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
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

TaskCollection

public TaskCollection(DataCollection dataCollection)
Constructor.

Parameters:
dataCollection - the data collection
See Also:
DomainCollection.DomainCollection(DataCollection)
Method Detail

getTask

public Task getTask()
Wrapper to getDomainObject() that casts the returned domain object as a task.

Returns:
a task.

addOrder

public void addOrder(String order)
Sets the order of this collection. Should be called before next() is called on this collection.

Specified by:
addOrder in interface DataQuery
Overrides:
addOrder in class DomainQuery
Parameters:
order - This String parameter specifies the ordering of the output. This should be a comma seperated list of Attribute names (not the database column names) in the order of precedence. Separating attributes by commas is the same as calling addOrder multiple times, each with the next attribute. For instance, this

              addOrder("creationDate");
              addOrder("creationUser");
              
is the same as

              addOrder("creationDate, creationUser");
              

If the items should be ordered in ascending order, the attribute name should be followed by the word "asc" If the items should be ordered in descending order, the attribute should be followed by the word "desc" For instance, or order by ascending date and descending user (for users created with the same date), you would use the following:


              addOrder("creationDate asc, creationUser desc");
              

childrenOf

public final void childrenOf(Task parent)


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