com.jamasoftware.contour.ws.domain

Class WsItem

java.lang.Object

com.jamasoftware.contour.ws.domain.WsItem

Direct Known Subclasses:

WsTestPlan

public class WsItem
extends 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 has a template with specific fields to complete when adding new Items of that type.

Author:

Dylan

Constructor Summary

Constructors

Constructor and Description
WsItem() Creates an empty WsItem object.
WsItem(String name, String description, Integer documentTypeId, Integer parentId) Creates a new WsItem object with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getChildDocumentTypeId() Gets the id of the item's child document type.
Date	getCreatedDate() Gets the date the item was created.
Boolean	getCurrentUserWritePermissions() Gets whether the current user has write permissions for the item.
String	getDescription() Gets the description of the item.
WsDocumentTypeCategory	getDocTypeCategory() Gets the category of this item's document type.
Integer	getDocumentTypeId() Gets the WsDocumentType id for this item
WsField[]	getFields() Gets the item's fields.
String	getGlobalId() Gets the global Id of this item.
Integer	getGlobalSortOrder() Gets the global sort order of this item in the project tree.
Boolean	getHasChildren() Gets whether or not this item has any children
Integer	getId() Gets the item's id.
Integer	getIndent() Gets the indent value of this item in the project tree.
Boolean	getIsStructureOnly() When searching with a filter, users can choose to include items that are necessary to maintain the heirarchy of the Contour tree, but are not in the filter results.
Date	getLastActivityDate() Gets the last date this item had an activity associated with it.
Date	getModifiedDate() Gets the date the item was modified.
String	getName() Gets the item name.
Integer	getParentId() Gets the id of the item's parent (Can be null).
Integer	getProjectId() Gets the id of the project this item belongs to.
String	getSequence() Gets the sequence number of this item.
Integer	getSortOrder() Gets the sort order of this item.
List<WsTestCaseStep>	getTestCaseSteps() If the item is a Test Case, this will contain the steps for the Test Case.
void	setChildDocumentTypeId(Integer childDocumentTypeId) Sets the id of the item's child document type.
void	setCreatedDate(Date createdDate) Sets the date the item was created.
void	setCurrentUserWritePermissions(Boolean currentUserWritePermissions)
void	setDescription(String description) Sets the description of the item.
void	setDocTypeCategory(WsDocumentTypeCategory docTypeCategory)
void	setDocumentTypeId(Integer documentTypeId) Set the WsDocumentType id for this item.
void	setFields(WsField[] fields) Sets the item's fields.
void	setGlobalId(String globalId)
void	setGlobalSortOrder(Integer globalSortOrder)
void	setHasChildren(Boolean hasChildren)
void	setId(Integer id)
void	setIndent(Integer indent)
void	setIsStructureOnly(Boolean isStructureOnly)
void	setLastActivityDate(Date lastActivityDate) Sets the last date this item had an activity associated with it.
void	setModifiedDate(Date modifiedDate) Sets the date this item was modified.
void	setName(String name) Sets the name of the item.
void	setParentId(Integer parentId) Sets the id of the item's parent.
void	setProjectId(Integer projectId) Sets the id of the project this item belongs to.
void	setSequence(String sequence)
void	setSortOrder(Integer sortOrder)
void	setTestCaseSteps(List<WsTestCaseStep> testCaseSteps)
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(String name,
      String description,
      Integer documentTypeId,
      Integer parentId)

Creates a new WsItem object with the given values.

Parameters:

name - name of the item

description - description of the item (can be null)

documentTypeId - id of the WsDocumentType the item is in

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

Method Detail

getId

public Integer getId()

Gets the item's id.

Returns:

item id

setId

public void setId(Integer id)

getDocumentTypeId

public Integer getDocumentTypeId()

Gets the WsDocumentType id for this item

Returns:

The id of the document type of this item.

setDocumentTypeId

public void setDocumentTypeId(Integer documentTypeId)

Set the WsDocumentType id for this item.

Parameters:

documentTypeId - The id of the type to set this item as

getName

public String getName()

Gets the item name.

Returns:

name of the item

setName

public void setName(String name)

Sets the name of the item.

Parameters:

name - name to set to item

getDescription

public String getDescription()

Gets the description of the item.

Returns:

description of the item

setDescription

public void setDescription(String description)

Sets the description of the item.

Parameters:

description - description of the item

getCreatedDate

public Date getCreatedDate()

Gets the date the item was created.

Returns:

Date

setCreatedDate

public void setCreatedDate(Date createdDate)

Sets the date the item was created.

Parameters:

createdDate - date item was created

getModifiedDate

public Date getModifiedDate()

Gets the date the item was modified.

Returns:

Date

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Sets the date this item was modified.

Parameters:

modifiedDate - date item was modified

getLastActivityDate

public Date getLastActivityDate()

Gets the last date this item had an activity associated with it.

Returns:

Date

setLastActivityDate

public void setLastActivityDate(Date lastActivityDate)

Sets the last date this item had an activity associated with it.

Parameters:

lastActivityDate - the last date this item had an activity associated with it

getParentId

public 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(Integer parentId)

Sets the id of the item's parent. This will not affect anything on item update, but will place the item in the tree when saving a new item.

Parameters:

parentId - id of an item to be the parent of this item. The parent must 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 Integer getProjectId()

Gets the id of the project this item belongs to.

Returns:

Integer

setProjectId

public void setProjectId(Integer projectId)

Sets the id of the project this item belongs to.

Parameters:

projectId - id of the project this item should belong to

getDocTypeCategory

public WsDocumentTypeCategory getDocTypeCategory()

Gets the category of this item's document type.

Returns:

WsDocumentTypeCategory

setDocTypeCategory

public void setDocTypeCategory(WsDocumentTypeCategory docTypeCategory)

getChildDocumentTypeId

public Integer getChildDocumentTypeId()

Gets the id of the item's child document type. This is used by Sets and Folders to determine what type of items they can contain.

Returns:

Integer

setChildDocumentTypeId

public void setChildDocumentTypeId(Integer childDocumentTypeId)

Sets the id of the item's child document type. This is used by Sets and Folders to determine what type of items they can contain.

Parameters:

childDocumentTypeId - id of the document type this item can contain (only used for Sets and Folders)

getSortOrder

public Integer getSortOrder()

Gets the sort order of this item.

Returns:

Integer

setSortOrder

public void setSortOrder(Integer sortOrder)

getGlobalSortOrder

public Integer getGlobalSortOrder()

Gets the global sort order of this item in the project tree.

Returns:

Integer

setGlobalSortOrder

public void setGlobalSortOrder(Integer globalSortOrder)

getIndent

public Integer getIndent()

Gets the indent value of this item in the project tree.

Returns:

Integer

setIndent

public void setIndent(Integer indent)

getSequence

public String getSequence()

Gets the sequence number of this item. ("1.1.4", "3.2", etc...).

Returns:

String

setSequence

public void setSequence(String sequence)

getHasChildren

public Boolean getHasChildren()

Gets whether or not this item has any children

Returns:

Boolean

setHasChildren

public void setHasChildren(Boolean hasChildren)

getCurrentUserWritePermissions

public Boolean getCurrentUserWritePermissions()

Gets whether the current user has write permissions for the item. Read permission is implied by the fact that the item was retrieved from Contour.

Returns:

Boolean

setCurrentUserWritePermissions

public void setCurrentUserWritePermissions(Boolean currentUserWritePermissions)

getIsStructureOnly

public Boolean getIsStructureOnly()

When searching with a filter, users can choose to include items that are necessary to maintain the heirarchy of the Contour tree, but are not in the filter results. This property designates this item as a heirarchy-only item.

Returns:

Boolean

setIsStructureOnly

public void setIsStructureOnly(Boolean isStructureOnly)

getGlobalId

public String getGlobalId()

Gets the global Id of this item.

Returns:

String

setGlobalId

public void setGlobalId(String globalId)

getTestCaseSteps

public List<WsTestCaseStep> getTestCaseSteps()

If the item is a Test Case, this will contain the steps for the Test Case.

setTestCaseSteps

public void setTestCaseSteps(List<WsTestCaseStep> testCaseSteps)

toString

public String toString()

Gets a string representation of this item.

Overrides:

toString in class Object

Returns:

String