/*
 * Copyright (C) 2002-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.portal;

import com.arsdigita.web.ApplicationCollection;
import com.arsdigita.persistence.DataObject;
import com.arsdigita.persistence.DataCollection;
import com.arsdigita.util.Assert;

/**
 * 
 *
 * <p>Describes a set of portlet domain objects.</p>
 *
 * @see Portlet
 * @see Portal
 * @see DefaultPortalModel
 * @author Justin Ross
 * @author James Parsons
 * @version $Id: PortletCollection.java 287 2005-02-22 00:29:02Z sskracic $
 */
public class PortletCollection extends ApplicationCollection {
    public static final String versionId = "$Id: PortletCollection.java 287 2005-02-22 00:29:02Z sskracic $ by $Author: sskracic $, $DateTime: 2004/08/16 18:10:38 $";

    public PortletCollection(DataCollection dataCollection) {
        super(dataCollection);
    }

    /**
     * Get the current item as a Portlet domain object.
     *
     * @return a Portlet domain object.
     * @post return != null
     */
    public Portlet getPortlet() {
        DataObject dataObject = m_dataCollection.getDataObject();

        Portlet portlet = Portlet.retrievePortlet(dataObject);

        Assert.assertNotNull(portlet);

        return portlet;
    }
}
