|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.file.CmsProject
Describes an OpenCms project, which contains a set of VFS resources that are being worked on at the same time.
Field Summary | |
static int |
ONLINE_PROJECT_ID
The id of the online project. |
static java.lang.String |
ONLINE_PROJECT_NAME
The name of the online project. |
static int |
PROJECT_STATE_INVISIBLE
Indicates that a project is invisible in the workplace. |
static int |
PROJECT_STATE_UNLOCKED
Indicates an unlocked project. |
static int |
PROJECT_TYPE_NORMAL
Indicates a normal project. |
static int |
PROJECT_TYPE_TEMPORARY
Indicates a temporary project that is deleted after it is published. |
Constructor Summary | |
CmsProject()
Default constructor for gui usage. |
|
CmsProject(int projectId,
java.lang.String name,
java.lang.String description,
int taskId,
CmsUUID ownerId,
CmsUUID groupId,
CmsUUID managerGroupId,
int flags,
long dateCreated,
int type)
Creates a new CmsProject. |
|
CmsProject(java.sql.ResultSet res,
CmsSqlManager sqlManager)
Construct a new CmsProject from a SQL ResultSet. |
Method Summary | |
java.lang.Object |
clone()
Returns a clone of this Objects instance. |
int |
compareTo(java.lang.Object o)
Compares this instance to another given object instance of this class . |
boolean |
equals(java.lang.Object obj)
|
long |
getDateCreated()
Returns the creation date of this project. |
java.lang.String |
getDescription()
Returns the description of this project. |
int |
getFlags()
Returns the state of this project. |
CmsUUID |
getGroupId()
Returns the user group id of this project. |
int |
getId()
Returns the id of this project. |
CmsUUID |
getManagerGroupId()
Returns the manager group id of this project. |
java.lang.String |
getName()
Returns the name of this project. |
CmsUUID |
getOwnerId()
Returns the user id of the project owner. |
int |
getTaskId()
Returns the task id of this project. |
int |
getType()
Returns the type of this project. |
int |
hashCode()
|
boolean |
isDeleteAfterPublishing()
Returns the delete After Publishing flag. |
static boolean |
isInsideProject(java.util.List projectResources,
CmsResource resource)
Checks if the full resource name (including the site root) of a resource matches any of the project resources of a project. |
static boolean |
isInsideProject(java.util.List projectResources,
java.lang.String resourcename)
Checks if the full resource name (including the site root) of a resource matches any of the project resources of a project. |
boolean |
isOnlineProject()
Returns true if this project is the Online project. |
static boolean |
isOnlineProject(int projectId)
Returns true if the given project id is the online project id. |
void |
setDeleteAfterPublishing(boolean deleteAfterPublishing)
Sets the delete After Publishing flag. |
void |
setDescription(java.lang.String description)
Sets the description of this project. |
void |
setFlags(int flags)
Sets the flags of this project. |
void |
setGroupId(CmsUUID id)
Sets the user group id of this project. |
void |
setManagerGroupId(CmsUUID id)
Sets the manager group id of this project. |
void |
setName(java.lang.String name)
Sets the name. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int ONLINE_PROJECT_ID
public static final java.lang.String ONLINE_PROJECT_NAME
public static final int PROJECT_STATE_INVISIBLE
public static final int PROJECT_STATE_UNLOCKED
public static final int PROJECT_TYPE_NORMAL
public static final int PROJECT_TYPE_TEMPORARY
Constructor Detail |
public CmsProject()
public CmsProject(int projectId, java.lang.String name, java.lang.String description, int taskId, CmsUUID ownerId, CmsUUID groupId, CmsUUID managerGroupId, int flags, long dateCreated, int type)
projectId
- the id to use for this projectname
- the name for this projectdescription
- the description for this projecttaskId
- the task id for this projectownerId
- the owner id for this projectgroupId
- the group id for this projectmanagerGroupId
- the manager group id for this projectflags
- the flags for this projectdateCreated
- the creation date of this projecttype
- the type of this projectpublic CmsProject(java.sql.ResultSet res, CmsSqlManager sqlManager) throws java.sql.SQLException
res
- the result set to create a project fromsqlManager
- the SQL manager to use
java.sql.SQLException
- in case something goes wrongMethod Detail |
public static boolean isInsideProject(java.util.List projectResources, CmsResource resource)
projectResources
- a List of project resources as Stringsresource
- the resource to check
public static boolean isInsideProject(java.util.List projectResources, java.lang.String resourcename)
projectResources
- a List of project resources as Stringsresourcename
- the resource to check
public static boolean isOnlineProject(int projectId)
projectId
- the project id to check
public java.lang.Object clone()
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
o
- the other given object instance to compare with
public boolean equals(java.lang.Object obj)
Object.equals(java.lang.Object)
public long getDateCreated()
public java.lang.String getDescription()
public int getFlags()
public CmsUUID getGroupId()
public int getId()
public CmsUUID getManagerGroupId()
public java.lang.String getName()
public CmsUUID getOwnerId()
public int getTaskId()
public int getType()
public int hashCode()
Object.hashCode()
public boolean isDeleteAfterPublishing()
getType()
public boolean isOnlineProject()
true
if this project is the Online project.
true
if this project is the Online projectpublic void setDeleteAfterPublishing(boolean deleteAfterPublishing)
deleteAfterPublishing
- the delete After Publishing flag to setpublic void setDescription(java.lang.String description)
description
- the description to setpublic void setFlags(int flags)
flags
- the flag to setpublic void setGroupId(CmsUUID id)
id
- the user group id of this projectpublic void setManagerGroupId(CmsUUID id)
id
- the manager group id of this projectpublic void setName(java.lang.String name)
name
- the name to setpublic java.lang.String toString()
Object.toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |