com.jamasoftware.contour.ws.v3.domain
Class WsDocumentTypeCategory

java.lang.Object
  com.jamasoftware.contour.ws.v3.domain.WsDocumentTypeCategory

public class WsDocumentTypeCategory
extends java.lang.Object

This object represents the Category of a WsDocumentType.

Author:

Dylan

Field Summary

static WsDocumentTypeCategory	ATTACHMENT The Attachment category signifies that this document type represents the system's attachments, ID 1001.
static WsDocumentTypeCategory	COMPONENT The Component category signifies that this document type represents Components of the system hierarchy, ID 1002.
static WsDocumentTypeCategory	CORE The Core category signifies that this document type represents the fields that apply to all items, ID 1000.
static WsDocumentTypeCategory	SECTION The Folder category signifies that this document type represents Folders in the system hierarchy, ID 1004.
static WsDocumentTypeCategory	SET The Set category signifies that this document type represents Sets in the system hierarchy, ID 1003.
static WsDocumentTypeCategory	TEST_CASE The Test Case category signifies that this document type represents Test Cases in the system, ID 1009.
static WsDocumentTypeCategory	TEST_CYCLE
static WsDocumentTypeCategory	TEST_PLAN
static WsDocumentTypeCategory	TEST_RUN
static WsDocumentTypeCategory	TEXT The Text category signifies that this document type represents Texts in the system, ID 1005.

Constructor Summary

WsDocumentTypeCategory()
Creates an empty WsDocumentTypeCategory.

WsDocumentTypeCategory(java.lang.Integer id, java.lang.String name)
Creates a WsDocumentTypeCategory object with the given id and name.

Method Summary

boolean	equals(java.lang.Object obj) Checks whether the given object is equal to this WsDocumentTypeCategory.
java.lang.Integer	getId() Gets the category's id.
java.lang.String	getName() Gets the category's name.
static WsDocumentTypeCategory	getWsDocumentTypeCategoryById(java.lang.Integer id) Gets the WsDocumentCategoryType object given it's id.
static boolean	isCategory(WsDocumentTypeCategory docTypeCategory, WsDocumentTypeCategory category)
void	setId(java.lang.Integer id) Sets the category's id.
void	setName(java.lang.String name) Sets the category's name.
java.lang.String	toString() Gets a string representation of this document type category.

Methods inherited from class java.lang.Object

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

Field Detail

CORE

public static final WsDocumentTypeCategory CORE

The Core category signifies that this document type represents the fields that apply to all items, ID 1000.

ATTACHMENT

public static final WsDocumentTypeCategory ATTACHMENT

The Attachment category signifies that this document type represents the system's attachments, ID 1001.

COMPONENT

public static final WsDocumentTypeCategory COMPONENT

The Component category signifies that this document type represents Components of the system hierarchy, ID 1002.

SET

public static final WsDocumentTypeCategory SET

The Set category signifies that this document type represents Sets in the system hierarchy, ID 1003.

SECTION

public static final WsDocumentTypeCategory SECTION

The Folder category signifies that this document type represents Folders in the system hierarchy, ID 1004.

TEXT

public static final WsDocumentTypeCategory TEXT

The Text category signifies that this document type represents Texts in the system, ID 1005.

TEST_CASE

public static final WsDocumentTypeCategory TEST_CASE

The Test Case category signifies that this document type represents Test Cases in the system, ID 1009. Test Cases use the Test Case Step field and are used in Contour's Test Center.

TEST_PLAN

public static final WsDocumentTypeCategory TEST_PLAN

TEST_CYCLE

public static final WsDocumentTypeCategory TEST_CYCLE

TEST_RUN

public static final WsDocumentTypeCategory TEST_RUN

Constructor Detail

WsDocumentTypeCategory

public WsDocumentTypeCategory()

Creates an empty WsDocumentTypeCategory.

WsDocumentTypeCategory

public WsDocumentTypeCategory(java.lang.Integer id,
                              java.lang.String name)

Creates a WsDocumentTypeCategory object with the given id and name. The id must match one of the pre-defined categories for it to be valid in Contour.

Parameters:

id - id to use in the new WsDocumentTypeCategory object

name - name to use in the new WsDocumentTypeCategory object

Method Detail

getWsDocumentTypeCategoryById

public static WsDocumentTypeCategory getWsDocumentTypeCategoryById(java.lang.Integer id)

Gets the WsDocumentCategoryType object given it's id. For example: getWsDocumentTypeCategoryById(1001) will return WsDocumentTypeCategory.ATTACHMENT.

Parameters:

id - id of the WsDocumentCategoryType to get

Returns:

WsDocumentCategoryType with the given id

isCategory

public static boolean isCategory(WsDocumentTypeCategory docTypeCategory,
                                 WsDocumentTypeCategory category)

Parameters:

docTypeCategory - category you want to check

category - category to match

Returns:

whether or not docTypeCategory is the same as the given category

getId

public java.lang.Integer getId()

Gets the category's id.

Returns:

id of the category

setId

public void setId(java.lang.Integer id)

Sets the category's id.

Parameters:

id - id to set

getName

public java.lang.String getName()

Gets the category's name.

Returns:

name of the category

setName

public void setName(java.lang.String name)

Sets the category's name.

Parameters:

name - name of the category

equals

public boolean equals(java.lang.Object obj)

Checks whether the given object is equal to this WsDocumentTypeCategory.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to check equality with

toString

public java.lang.String toString()

Gets a string representation of this document type category.

Overrides:

toString in class java.lang.Object

Returns:

String