001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.publish;
029
030import org.opencms.db.CmsPublishList;
031import org.opencms.report.I_CmsReport;
032
033/**
034 * Defines a read-only publish job that is still waiting for publishing.<p>
035 *
036 * @since 6.5.5
037 */
038public class CmsPublishJobEnqueued extends CmsPublishJobBase {
039
040    /**
041     * Default constructor.<p>
042     *
043     * @param publishJob the delegate publish job
044     */
045    protected CmsPublishJobEnqueued(CmsPublishJobInfoBean publishJob) {
046
047        super(publishJob);
048    }
049
050    /**
051     * Returns the time this object has been created.<p>
052     *
053     * @return the time this object has been created
054     */
055    public long getEnqueueTime() {
056
057        return m_publishJob.getEnqueueTime();
058    }
059
060    /**
061     * Returns the list of resources to publish.<p>
062     *
063     * @return the list of resources to publish
064     */
065    public CmsPublishList getPublishList() {
066
067        return m_publishJob.getPublishList();
068    }
069
070    /**
071     * Returns the report for this publish job.<p>
072     *
073     * This is not the original report, it is wrapper that
074     * also writes to a temporary file.<p>
075     *
076     * @return the report for this publish job
077     */
078    public I_CmsReport getReport() {
079
080        return m_publishJob.getPublishReport();
081    }
082}