com.arsdigita.cms
Class TemplateCollection

java.lang.Object
  extended bycom.arsdigita.domain.DomainQuery
      extended bycom.arsdigita.domain.DomainCollection
          extended bycom.arsdigita.cms.TemplateCollection
All Implemented Interfaces:
com.arsdigita.persistence.DataQuery
Direct Known Subclasses:
CategoryTemplateCollection

public abstract class TemplateCollection
extends com.arsdigita.domain.DomainCollection

Represents a collection of template mappings along with their link attributes.

Version:
$Id: //cms/dev/src/com/arsdigita/cms/TemplateCollection.java#9 $
Author:
Stanislav Freidin (sfreidin@arsdigita.com)
See Also:
DomainCollection, DataCollection, ItemTemplateCollection

Field Summary
static String IS_DEFAULT
           
static String TEMPLATE
           
static String USE_CONTEXT
           
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
TemplateCollection(com.arsdigita.persistence.DataCollection dataCollection)
          Constructor.
 
Method Summary
 com.arsdigita.persistence.Filter addEqualsFilter(String attr, Object value)
          Filter this collection for equality by the specified attribute
 void addOrder(String order)
          Set the order of this Collection.
 com.arsdigita.persistence.DataCollection getDataCollection()
          Return the internal DataCollection
 com.arsdigita.mimetypes.MimeType getMimeType()
          this is the mime type for this context but does not necessarily have to be the same mime type that is returned by calling getTemplate().getMimeType().
abstract  Template getTemplate()
          Return the current template
abstract  String getUseContext()
          Return the current use context
abstract  Boolean isDefault()
          Return true if the current template is the default for its context
 
Methods inherited from class com.arsdigita.domain.DomainCollection
getDomainObject
 
Methods inherited from class com.arsdigita.domain.DomainQuery
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

USE_CONTEXT

public static final String USE_CONTEXT
See Also:
Constant Field Values

IS_DEFAULT

public static final String IS_DEFAULT
See Also:
Constant Field Values

TEMPLATE

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

TemplateCollection

public TemplateCollection(com.arsdigita.persistence.DataCollection dataCollection)
Constructor.

Method Detail

addOrder

public void addOrder(String order)
Set the order of this Collection. This method needs to be called before next() is called on this collection.


getTemplate

public abstract Template getTemplate()
Return the current template


getUseContext

public abstract String getUseContext()
Return the current use context


isDefault

public abstract Boolean isDefault()
Return true if the current template is the default for its context


getMimeType

public com.arsdigita.mimetypes.MimeType getMimeType()
this is the mime type for this context but does not necessarily have to be the same mime type that is returned by calling getTemplate().getMimeType(). This can return null


addEqualsFilter

public com.arsdigita.persistence.Filter addEqualsFilter(String attr,
                                                        Object value)
                                                 throws com.arsdigita.persistence.PersistenceException
Filter this collection for equality by the specified attribute

Throws:
com.arsdigita.persistence.PersistenceException

getDataCollection

public com.arsdigita.persistence.DataCollection getDataCollection()
Return the internal DataCollection



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