org.opencms.publish.CmsPublishJobBase Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* 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.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* 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 org.opencms.publish;
import org.opencms.file.CmsObject;
import org.opencms.main.CmsException;
import org.opencms.util.CmsUUID;
import java.util.Locale;
/**
* Defines a read-only publish job.
*
* @since 6.5.5
*/
public class CmsPublishJobBase {
/** The delegate publish job. */
protected CmsPublishJobInfoBean m_publishJob;
/**
* Internal constructor.
*
* @param job the job used to initialize
*/
protected CmsPublishJobBase(CmsPublishJobBase job) {
m_publishJob = job.m_publishJob;
}
/**
* Default constructor.
*
* @param publishJob the delegate publish job
*/
protected CmsPublishJobBase(CmsPublishJobInfoBean publishJob) {
m_publishJob = publishJob;
}
/**
* Returns the locale for this publish job.
*
* @return the locale for this publish job
*/
public Locale getLocale() {
return m_publishJob.getLocale();
}
/**
* Returns the project name or {@link org.opencms.publish.Messages#GUI_DIRECT_PUBLISH_PROJECT_NAME_0}
* if it is a direct publish job.
*
* @return the project name
*/
public String getProjectName() {
return m_publishJob.getProjectName();
}
/**
* Returns the publish history id.
*
* @return the publish history id
*/
public CmsUUID getPublishHistoryId() {
return m_publishJob.getPublishHistoryId();
}
/**
* Returns the number of resources in the publish list.
*
* @return the number of resources in the publish list
*/
public int getSize() {
return m_publishJob.getSize();
}
/**
* Returns the id of the user who initialized this publish job.
*
* @return the id of the user who initialized this publish job
*/
public CmsUUID getUserId() {
return m_publishJob.getUserId();
}
/**
* Returns the name of the user who initialized this publish job.
*
* @param cms the cms object
*
* @return the name of the user who initialized this publish job
*/
public String getUserName(CmsObject cms) {
String userName = getUserId().toString();
try {
userName = cms.readUser(getUserId()).getName();
} catch (CmsException e) {
// ignore
}
return userName;
}
/**
* Returns the direct publish state.
*
* @return the direct publish state
*/
public boolean isDirectPublish() {
return m_publishJob.isDirectPublish();
}
}