com.jamasoftware.contour.ws.v2.domain
Class WsItem

java.lang.Object
  com.jamasoftware.contour.ws.v2.domain.WsItem

public class WsItem
extends java.lang.Object

This object represents a Contour Document/Item. Depending on how your Organization uses Contour, an Item could represent a feature, a requirement, a use case, a test case, a defect, and/or other Items you need to manage and track within the development process. Each type of Item is grouped in a Set and has a template with specific fields to complete when adding new Items.

Author:

Dylan

Constructor Summary

WsItem()
Creates an empty WsItem object.

WsItem(java.lang.String name, java.lang.String description, java.lang.Integer moduleId, java.lang.Integer parentId, java.lang.Boolean isFolder)
Creates a new WsItem object with the given values.

Method Summary

java.util.Date	getCreatedDate() Gets the date the item was created.
java.lang.String	getDescription() Gets the description of the item.
WsField[]	getFields() Gets the item's fields.
java.lang.Integer	getId() Gets the item's id.
java.lang.Boolean	getIsFolder() Is this item a folder?
java.util.Date	getModifiedDate() Gets the date the item was modified.
java.lang.Integer	getModuleId() Gets the module id of the module this item is a member of.
java.lang.String	getName() Gets the item name.
java.lang.Integer	getParentId() Gets the id of the item's parent (Can be null).
java.lang.Integer	getProjectId() Gets the id of the project this item is in.
void	setCreatedDate(java.util.Date createdDate) Sets the date the item was created.
void	setDescription(java.lang.String description) Sets the description of the item.
void	setFields(WsField[] fields) Sets the item's fields.
void	setId(java.lang.Integer id)
void	setIsFolder(java.lang.Boolean isFolder) Sets whether this item is a folder.
void	setModifiedDate(java.util.Date modifiedDate) Sets the date this item was modified.
void	setModuleId(java.lang.Integer moduleId) Sets the module id of the module this item is a member of.
void	setName(java.lang.String name) Sets the name of the item.
void	setParentId(java.lang.Integer parentId) Sets the id of the item's parent
void	setProjectId(java.lang.Integer projectId) Sets the id of the project this item is in.
java.lang.String	toString() Gets a string representation of this item.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsItem

public WsItem()

Creates an empty WsItem object.

WsItem

public WsItem(java.lang.String name,
              java.lang.String description,
              java.lang.Integer moduleId,
              java.lang.Integer parentId,
              java.lang.Boolean isFolder)

Creates a new WsItem object with the given values.

Parameters:

name - name of the item

description - description of the item (can be null)

moduleId - id of the module the item is in

parentId - id of the parent of the item (can be null)

isFolder - is this item a folder?

Method Detail

getId

public java.lang.Integer getId()

Gets the item's id.

Returns:

item id

setId

public void setId(java.lang.Integer id)

getModuleId

public java.lang.Integer getModuleId()

Gets the module id of the module this item is a member of.

Returns:

module id of this item

setModuleId

public void setModuleId(java.lang.Integer moduleId)

Sets the module id of the module this item is a member of.

Parameters:

moduleId - id of the module this item should be member of

getName

public java.lang.String getName()

Gets the item name.

Returns:

name of the item

setName

public void setName(java.lang.String name)

Sets the name of the item.

Parameters:

name - name to set to item

getDescription

public java.lang.String getDescription()

Gets the description of the item.

Returns:

description of the item

setDescription

public void setDescription(java.lang.String description)

Sets the description of the item.

Parameters:

description - description of the item

getCreatedDate

public java.util.Date getCreatedDate()

Gets the date the item was created.

Returns:

Date

setCreatedDate

public void setCreatedDate(java.util.Date createdDate)

Sets the date the item was created.

Parameters:

createdDate - date item was created

getModifiedDate

public java.util.Date getModifiedDate()

Gets the date the item was modified.

Returns:

Date

setModifiedDate

public void setModifiedDate(java.util.Date modifiedDate)

Sets the date this item was modified.

Parameters:

modifiedDate - date item was modified

getParentId

public java.lang.Integer getParentId()

Gets the id of the item's parent (Can be null).

Returns:

item id of this item's parent

setParentId

public void setParentId(java.lang.Integer parentId)

Sets the id of the item's parent

Parameters:

parentId - id of an item to be the parent of this item. The parent must be a folder.

getIsFolder

public java.lang.Boolean getIsFolder()

Is this item a folder?

Returns:

whether or not this item is a folder

setIsFolder

public void setIsFolder(java.lang.Boolean isFolder)

Sets whether this item is a folder.

Parameters:

isFolder - whether or not this item should be a folder

getFields

public WsField[] getFields()

Gets the item's fields.

Returns:

an array of WsFields

setFields

public void setFields(WsField[] fields)

Sets the item's fields.

Parameters:

fields - an array of WsFields

getProjectId

public java.lang.Integer getProjectId()

Gets the id of the project this item is in.

Returns:

project id

setProjectId

public void setProjectId(java.lang.Integer projectId)

Sets the id of the project this item is in.

Parameters:

projectId - project id

toString

public java.lang.String toString()

Gets a string representation of this item.

Overrides:

toString in class java.lang.Object

Returns:

String