com.jamasoftware.contour.ws.domain

Class WsProject

java.lang.Object

com.jamasoftware.contour.ws.domain.WsProject

public class WsProject
extends Object

This object represents a Contour project. A project is a collection of Modules, Items, Filters, Releases and Baselines, and is defined according to your needs.

Author:

Dylan

Constructor Summary

Constructors

Constructor and Description
WsProject() Creates an empty WsProject object.
WsProject(Integer id) Creates a WsProject object with the given id.
WsProject(String name, String description, Integer parent, Boolean isFolder, WsUser projectManager, WsOrganization organization) Creates a new WsProject object with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getActive() Is this project active?
String	getDescription() Gets the project's description.
Integer	getId() Gets the project's id.
Boolean	getIsFolder() Is this project a folder?
String	getName() Gets the project's name.
WsOrganization	getOrganization() Gets the organization this project is in.
Integer	getParent() Gets the parent of the project.
WsLookup	getProjectGroup() Gets the group this project belongs to.
String	getProjectKey() Gets the key associated with the project.
WsUser	getProjectManager() Gets the manager for this project.
WsProjectType	getProjectType() Gets the default item type for this project.
WsLookup	getStatus() Gets the status of the project.
void	setActive(Boolean active) Sets whether or not this project is active.
void	setDescription(String description) Sets the project's description.
void	setId(Integer id) Sets the project's id.
void	setIsFolder(Boolean isFolder) Sets whether or not this project is a folder.
void	setName(String name) Sets the project's name.
void	setOrganization(WsOrganization organization) Sets the organization this project is in.
void	setParent(Integer parent) Sets the parent of the project.
void	setProjectGroup(WsLookup projectGroup) Sets the group this project belongs to.
void	setProjectKey(String projectKey) Sets the key associated with the project.
void	setProjectManager(WsUser projectManager) Sets the manager for this project.
void	setProjectType(WsProjectType projectType) Sets the default item type for this project.
void	setStatus(WsLookup status) Sets the status of the project.
String	toString() Gets a string representation of this project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WsProject

public WsProject()

Creates an empty WsProject object.

WsProject

public WsProject(Integer id)

Creates a WsProject object with the given id.

Parameters:

id - id to set for the WsProject object

WsProject

public WsProject(String name,
         String description,
         Integer parent,
         Boolean isFolder,
         WsUser projectManager,
         WsOrganization organization)

Creates a new WsProject object with the given values.

Parameters:

name - name of the project

description - description of the project (can be null)

parent - id of the parent project (can be null)

isFolder - is this project a folder?

projectManager - project manager

organization - organization the project is in

Method Detail

getId

public Integer getId()

Gets the project's id.

Returns:

project id

setId

public void setId(Integer id)

Sets the project's id.

Parameters:

id - the project's id

getName

public String getName()

Gets the project's name.

Returns:

project name

setName

public void setName(String name)

Sets the project's name.

Parameters:

name - project name

getDescription

public String getDescription()

Gets the project's description.

Returns:

project description

setDescription

public void setDescription(String description)

Sets the project's description.

Parameters:

description - project description

getStatus

public WsLookup getStatus()

Gets the status of the project.

Returns:

project status

setStatus

public void setStatus(WsLookup status)

Sets the status of the project.

Parameters:

status - status of the project

getParent

public Integer getParent()

Gets the parent of the project.

Returns:

id of the parent of this project (Can be null).

setParent

public void setParent(Integer parent)

Sets the parent of the project.

Parameters:

parent - id of the parent of this project.

getIsFolder

public Boolean getIsFolder()

Is this project a folder?

Returns:

whether or not this project is a folder.

setIsFolder

public void setIsFolder(Boolean isFolder)

Sets whether or not this project is a folder.

Parameters:

isFolder - whether or not this project is a folder

getActive

public Boolean getActive()

Is this project active?

Returns:

whether or not this project is active

setActive

public void setActive(Boolean active)

Sets whether or not this project is active.

Parameters:

active - whether or not this project is active

getProjectManager

public WsUser getProjectManager()

Gets the manager for this project.

Returns:

project manager

setProjectManager

public void setProjectManager(WsUser projectManager)

Sets the manager for this project.

Parameters:

projectManager - user to be set as project manager

getOrganization

public WsOrganization getOrganization()

Gets the organization this project is in.

Returns:

organization containing this project

setOrganization

public void setOrganization(WsOrganization organization)

Sets the organization this project is in.

Parameters:

organization - to contain this project

getProjectGroup

public WsLookup getProjectGroup()

Gets the group this project belongs to.

Returns:

project group

setProjectGroup

public void setProjectGroup(WsLookup projectGroup)

Sets the group this project belongs to.

Parameters:

projectGroup - project group

getProjectType

public WsProjectType getProjectType()

Gets the default item type for this project.

Returns:

default item type for project (can be null)

setProjectType

public void setProjectType(WsProjectType projectType)

Sets the default item type for this project.

Parameters:

projectType - default item type

getProjectKey

public String getProjectKey()

Gets the key associated with the project. This is used along with a document's type key to generate it's document key.

Returns:

String

setProjectKey

public void setProjectKey(String projectKey)

Sets the key associated with the project. This is used along with a document's type key to generate it's document key.

Parameters:

projectKey - key to associate with this project

toString

public String toString()

Gets a string representation of this project.

Overrides:

toString in class Object

Returns:

String