com.arsdigita.cms
Class CategoryItemsQuery

java.lang.Object
  extended bycom.arsdigita.domain.DomainQuery
      extended bycom.arsdigita.cms.CategoryItemsQuery
All Implemented Interfaces:
com.arsdigita.persistence.DataQuery

public class CategoryItemsQuery
extends com.arsdigita.domain.DomainQuery

This class represents a query which returns the ContentItems in a given category. The query may return either LIVE or DRAFT items. For each ContentItem returned, the fields represented in the query are ItemID, Name, DisplayName, ObjectType and DefaultDomainClass.

See Also:
DomainQuery

Field Summary
static String CATEGORY_ID
           
static String CONTEXT
           
static String DEFAULT_DOMAIN_CLASS
           
static String DISPLAY_NAME
           
static String ITEM_ID
           
static String NAME
           
static String OBJECT_TYPE
           
 
Fields inherited from class com.arsdigita.domain.DomainQuery
m_dataQuery, versionId
 
Method Summary
 String getDefaultDomainClass()
          Returns the value of the defaultDomainClass property associated with
 String getDisplayName()
          Returns the value of the displayName property associated with
 BigDecimal getItemID()
          Returns the value of the itemID property associated with
 String getName()
          Returns the value of the name property associated with
 String getObjectType()
          Returns the value of the objectType property associated with
static CategoryItemsQuery retrieve(com.arsdigita.categorization.Category cat)
          Returns a CategoryItemsQuery for the given Category and default LIVE context
static CategoryItemsQuery retrieve(com.arsdigita.categorization.Category cat, String context)
          Returns a CategoryItemsQuery for the given Category and item context
 
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
 

Field Detail

CATEGORY_ID

public static final String CATEGORY_ID
See Also:
Constant Field Values

CONTEXT

public static final String CONTEXT
See Also:
Constant Field Values

ITEM_ID

public static final String ITEM_ID
See Also:
Constant Field Values

NAME

public static final String NAME
See Also:
Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME
See Also:
Constant Field Values

OBJECT_TYPE

public static final String OBJECT_TYPE
See Also:
Constant Field Values

DEFAULT_DOMAIN_CLASS

public static final String DEFAULT_DOMAIN_CLASS
See Also:
Constant Field Values
Method Detail

retrieve

public static CategoryItemsQuery retrieve(com.arsdigita.categorization.Category cat)
Returns a CategoryItemsQuery for the given Category and default LIVE context

Parameters:
cat - Category within which to retrieve items

retrieve

public static CategoryItemsQuery retrieve(com.arsdigita.categorization.Category cat,
                                          String context)
Returns a CategoryItemsQuery for the given Category and item context

Parameters:
cat - Category within which to retrieve items
context - Context (DRAFT or LIVE) for the items.

getItemID

public BigDecimal getItemID()
Returns the value of the itemID property associated with

Returns:
the value of the itemID

getName

public String getName()
Returns the value of the name property associated with

Returns:
the value of the name

getDisplayName

public String getDisplayName()
Returns the value of the displayName property associated with

Returns:
the value of the displayName

getObjectType

public String getObjectType()
Returns the value of the objectType property associated with

Returns:
the value of the objectType

getDefaultDomainClass

public String getDefaultDomainClass()
Returns the value of the defaultDomainClass property associated with

Returns:
the value of the defaultDomainClass


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