Package org.opencms.publish
Class CmsPublishJobBase
- java.lang.Object
-
- org.opencms.publish.CmsPublishJobBase
-
- Direct Known Subclasses:
CmsPublishJobEnqueued
,CmsPublishJobFinished
,CmsPublishJobRunning
public class CmsPublishJobBase extends java.lang.Object
Defines a read-only publish job.- Since:
- 6.5.5
-
-
Field Summary
Fields Modifier and Type Field Description protected CmsPublishJobInfoBean
m_publishJob
The delegate publish job.
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsPublishJobBase(CmsPublishJobBase job)
Internal constructor.protected
CmsPublishJobBase(CmsPublishJobInfoBean publishJob)
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Locale
getLocale()
Returns the locale for this publish job.java.lang.String
getProjectName()
Returns the project name orMessages.GUI_DIRECT_PUBLISH_PROJECT_NAME_0
if it is a direct publish job.CmsUUID
getPublishHistoryId()
Returns the publish history id.int
getSize()
Returns the number of resources in the publish list.CmsUUID
getUserId()
Returns the id of the user who initialized this publish job.java.lang.String
getUserName(CmsObject cms)
Returns the name of the user who initialized this publish job.boolean
isDirectPublish()
Returns the direct publish state.
-
-
-
Field Detail
-
m_publishJob
protected CmsPublishJobInfoBean m_publishJob
The delegate publish job.
-
-
Constructor Detail
-
CmsPublishJobBase
protected CmsPublishJobBase(CmsPublishJobBase job)
Internal constructor.- Parameters:
job
- the job used to initialize
-
CmsPublishJobBase
protected CmsPublishJobBase(CmsPublishJobInfoBean publishJob)
Default constructor.- Parameters:
publishJob
- the delegate publish job
-
-
Method Detail
-
getLocale
public java.util.Locale getLocale()
Returns the locale for this publish job.- Returns:
- the locale for this publish job
-
getProjectName
public java.lang.String getProjectName()
Returns the project name orMessages.GUI_DIRECT_PUBLISH_PROJECT_NAME_0
if it is a direct publish job.- Returns:
- the project name
-
getPublishHistoryId
public CmsUUID getPublishHistoryId()
Returns the publish history id.- Returns:
- the publish history id
-
getSize
public int getSize()
Returns the number of resources in the publish list.- Returns:
- the number of resources in the publish list
-
getUserId
public CmsUUID getUserId()
Returns the id of the user who initialized this publish job.- Returns:
- the id of the user who initialized this publish job
-
getUserName
public java.lang.String getUserName(CmsObject cms)
Returns the name of the user who initialized this publish job.- Parameters:
cms
- the cms object- Returns:
- the name of the user who initialized this publish job
-
isDirectPublish
public boolean isDirectPublish()
Returns the direct publish state.- Returns:
- the direct publish state
-
-