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;
032import org.opencms.util.CmsUUID;
033
034/**
035 * Defines a read-only publish job that is being published.<p>
036 *
037 * @since 6.5.5
038 */
039public class CmsPublishJobRunning extends CmsPublishJobBase {
040
041    /**
042     * Default constructor.<p>
043     *
044     * @param publishJob the delegate publish job
045     */
046    protected CmsPublishJobRunning(CmsPublishJobInfoBean publishJob) {
047
048        super(publishJob);
049    }
050
051    /**
052     * Returns the time this object has been created.<p>
053     *
054     * @return the time this object has been created
055     */
056    public long getEnqueueTime() {
057
058        return m_publishJob.getEnqueueTime();
059    }
060
061    /**
062     * Returns the list of resources to publish.<p>
063     *
064     * @return the list of resources to publish
065     */
066    public CmsPublishList getPublishList() {
067
068        return m_publishJob.getPublishList();
069    }
070
071    /**
072     * Returns the report for this publish job.<p>
073     *
074     * This is not the original report, it is wrapper that
075     * also writes to a temporary file.<p>
076     *
077     * @return the report for this publish job
078     *
079     * @see CmsPublishJobEnqueued#getReport()
080     */
081    public I_CmsReport getReport() {
082
083        return m_publishJob.getPublishReport();
084    }
085
086    /**
087     * Returns the time the publish job did actually start.<p>
088     *
089     * @return the time the publish job did actually start
090     */
091    public long getStartTime() {
092
093        return m_publishJob.getStartTime();
094    }
095
096    /**
097     * Returns the UUID of the running publish thread.<p>
098     *
099     * @return the UUID of the running publish thread
100     */
101    public CmsUUID getThreadUUID() {
102
103        return m_publishJob.getThreadUUID();
104    }
105}