libreccm-legacy/ccm-cms/src/com/arsdigita/cms/ContentSectionCollection.java

78 lines
2.4 KiB
Java
Executable File

/*
* Copyright (C) 2001-2004 Red Hat Inc. All Rights Reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
package com.arsdigita.cms;
import com.arsdigita.domain.DomainCollection;
import com.arsdigita.domain.DomainObject;
import com.arsdigita.persistence.DataCollection;
/**
* This class contains a collection of {@link
* com.arsdigita.cms.ContentSection content sections}.
*
* @see com.arsdigita.domain.DomainCollection
* @see com.arsdigita.persistence.DataCollection
*
* @author Stanislav Freidin (sfreidin@arsdigita.com)
* @version $Id: ContentSectionCollection.java 2140 2011-01-16 12:04:20Z pboy $
*/
public class ContentSectionCollection extends DomainCollection {
/**
* Constructor.
*
*/
public ContentSectionCollection(DataCollection dataCollection) {
super(dataCollection);
}
/**
* Set the order of this Collection. This method needs to be called
* before <code>next()</code> is called on this collection.
*
* @param order: name of the pdl property to use for sorting the collection
* (e.g. "primaryURL" in order to sort by section name
* see c.ad.london.util.cmd.SiteMapList as an example ).
*/
@Override
public void addOrder(String order) {
m_dataCollection.addOrder(order);
}
/**
* Returns a <code>DomainObject</code> for the current position in
* the collection.
*
*/
@Override
public DomainObject getDomainObject() {
return new ContentSection(m_dataCollection.getDataObject());
}
/**
* Returns a <code>MimeType</code> for the current position in
* the collection.
*
*/
public ContentSection getContentSection() {
return (ContentSection)getDomainObject();
}
}