org.opencms.file.history
Class CmsHistoryProject

java.lang.Object
  extended by org.opencms.file.CmsProject
      extended by org.opencms.file.history.CmsHistoryProject
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable<CmsProject>

public class CmsHistoryProject
extends CmsProject

Describes an OpenCms historical project entry.

Since:
6.9.1

Nested Class Summary
 
Nested classes/interfaces inherited from class org.opencms.file.CmsProject
CmsProject.CmsProjectType
 
Field Summary
 
Fields inherited from class org.opencms.file.CmsProject
ONLINE_PROJECT_ID, ONLINE_PROJECT_NAME, PROJECT_FLAG_HIDDEN, PROJECT_FLAG_NONE, PROJECT_TYPE_NORMAL, PROJECT_TYPE_TEMPORARY, PROJECT_TYPE_WORKFLOW
 
Constructor Summary
CmsHistoryProject(int publishTag, CmsUUID projectId, java.lang.String name, java.lang.String description, CmsUUID ownerId, CmsUUID groupId, CmsUUID managerGroupId, long dateCreated, CmsProject.CmsProjectType type, long datePublished, CmsUUID userPublished, java.util.List<java.lang.String> projectResources)
          Creates a new CmsHistoryProject.
 
Method Summary
 java.lang.Object clone()
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getGroupManagersName(CmsObject cms)
          Returns the project manager group name.
 java.lang.String getGroupUsersName(CmsObject cms)
          Returns the projects user group name.
 java.lang.String getOwnerName(CmsObject cms)
          Returns the owner name.
 java.util.List<java.lang.String> getProjectResources()
          Returns the project resources (i.e. the "view" of the project).
 CmsUUID getPublishedBy()
          Returns the id of the user that published this project.
 java.lang.String getPublishedByName(CmsObject cms)
          Returns the publishers name.
 long getPublishingDate()
          Returns the publishing date of this project.
 int getPublishTag()
          Returns the publish tag.
 int hashCode()
           
 void setProjectResources(java.util.List<java.lang.String> projectResources)
          Sets the projectResources.
 
Methods inherited from class org.opencms.file.CmsProject
checkProjectName, compareTo, getDateCreated, getDescription, getFlags, getGroupId, getManagerGroupId, getName, getOuFqn, getOwnerId, getSimpleName, getType, getUuid, isDeleteAfterPublishing, isHidden, isInsideProject, isInsideProject, isOnlineProject, isOnlineProject, isWorkflowProject, setDeleteAfterPublishing, setDescription, setFlags, setGroupId, setHidden, setManagerGroupId, setName, setOwnerId, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CmsHistoryProject

public CmsHistoryProject(int publishTag,
                         CmsUUID projectId,
                         java.lang.String name,
                         java.lang.String description,
                         CmsUUID ownerId,
                         CmsUUID groupId,
                         CmsUUID managerGroupId,
                         long dateCreated,
                         CmsProject.CmsProjectType type,
                         long datePublished,
                         CmsUUID userPublished,
                         java.util.List<java.lang.String> projectResources)
Creates a new CmsHistoryProject.

Parameters:
publishTag - the version id for this historical project
projectId - the id to use for this project
name - the name for this project
description - the description for this project
ownerId - the owner id for this project
groupId - the group id for this project
managerGroupId - the manager group id for this project
dateCreated - the creation date of this project
type - the type of this project
datePublished - the date this backup project was published
userPublished - the id of the user who published
projectResources - a list of resources that are the project "view"
Method Detail

clone

public java.lang.Object clone()
Overrides:
clone in class CmsProject
See Also:
CmsProject.clone()

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class CmsProject
See Also:
Object.equals(java.lang.Object)

getGroupManagersName

public java.lang.String getGroupManagersName(CmsObject cms)
Returns the project manager group name.

Parameters:
cms - the current cms context
Returns:
the projects manager group name

getGroupUsersName

public java.lang.String getGroupUsersName(CmsObject cms)
Returns the projects user group name.

Parameters:
cms - the current cms context
Returns:
the projects user group name

getOwnerName

public java.lang.String getOwnerName(CmsObject cms)
Returns the owner name.

Parameters:
cms - the current cms context
Returns:
the owner name

getProjectResources

public java.util.List<java.lang.String> getProjectResources()
Returns the project resources (i.e. the "view" of the project).

Returns:
the project resources

getPublishedBy

public CmsUUID getPublishedBy()
Returns the id of the user that published this project.

Returns:
the id of the user that published this project

getPublishedByName

public java.lang.String getPublishedByName(CmsObject cms)
Returns the publishers name.

Parameters:
cms - the current cms context
Returns:
the publishers name

getPublishingDate

public long getPublishingDate()
Returns the publishing date of this project.

Returns:
the publishing date of this project

getPublishTag

public int getPublishTag()
Returns the publish tag.

Returns:
the publish tag

hashCode

public int hashCode()
Overrides:
hashCode in class CmsProject
See Also:
Object.hashCode()

setProjectResources

public void setProjectResources(java.util.List<java.lang.String> projectResources)
Sets the projectResources.

Parameters:
projectResources - the projectResources to set