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

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

public class WsDocumentType
extends java.lang.Object

This object represents a Contour Item Type. These define the fields available to a given WsItem.

Author:

Dylan

Constructor Summary

WsDocumentType()
Creates an empty WsDocumentType object.

WsDocumentType(java.lang.Integer id)
Creates a WsDocumentType object with the given id.

Method Summary

java.lang.Boolean	getActive() Is this document type active?
WsDocumentTypeCategory	getCategory() Gets document type's category.
java.lang.String	getComponents() Gets document type's components (change request, tags, etc...).
java.lang.String	getDescription() Gets the document type's description.
java.lang.String	getDisplay() Gets document type's display.
java.lang.String	getDisplayPlural() Gets document type's plural display.
java.lang.String	getDocumentTypeKey() Gets document type's key, used in creating document keys.
WsField[]	getFields() Gets the fields associated with this document type.
java.lang.Integer	getId() Gets the document type's id.
java.lang.String	getImage() Gets the image associated with this type
java.lang.Integer	getRefId() Gets document type's reference id.
java.lang.Integer	getScope() Gets the document type's scope.
void	setActive(java.lang.Boolean active) Sets whether or not this document type is active.
void	setCategory(WsDocumentTypeCategory category) Sets document type's category.
void	setCategoryById(java.lang.Integer categoryId) Sets document type's category given the category's id.
void	setComponents(java.lang.String components) Sets document type's components (change request, tags, etc...).
void	setDescription(java.lang.String description) Sets the document type's description.
void	setDisplay(java.lang.String display) Sets document type's display.
void	setDisplayPlural(java.lang.String displayPlural) Sets document type's plural display.
void	setDocumentTypeKey(java.lang.String documentTypeKey) Sets document type's key
void	setFields(WsField[] fields) Sets the fields associated with this document type.
void	setId(java.lang.Integer id) Sets the document type's id.
void	setImage(java.lang.String image) Sets the image associated with this type
void	setRefId(java.lang.Integer refId) Sets document type's reference id.
void	setScope(java.lang.Integer scope) Sets the document type's scope.
java.lang.String	toString() Gets a string representation of this document type.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsDocumentType

public WsDocumentType()

Creates an empty WsDocumentType object.

WsDocumentType

public WsDocumentType(java.lang.Integer id)

Creates a WsDocumentType object with the given id.

Parameters:

id - id of the WsDocumentType to set

Method Detail

getId

public java.lang.Integer getId()

Gets the document type's id.

Returns:

document type id

setId

public void setId(java.lang.Integer id)

Sets the document type's id.

Parameters:

id - document type id

getDescription

public java.lang.String getDescription()

Gets the document type's description.

Returns:

document type's description

setDescription

public void setDescription(java.lang.String description)

Sets the document type's description.

Parameters:

description - document type's description

getScope

public java.lang.Integer getScope()

Gets the document type's scope.

Returns:

document type's scope

See Also:

WsScope

setScope

public void setScope(java.lang.Integer scope)

Sets the document type's scope.

Parameters:

scope - document type's scope

See Also:

WsScope

getRefId

public java.lang.Integer getRefId()

Gets document type's reference id.

Returns:

document type's reference id

setRefId

public void setRefId(java.lang.Integer refId)

Sets document type's reference id.

Parameters:

refId - document type's reference id

getComponents

public java.lang.String getComponents()

Gets document type's components (change request, tags, etc...).

Returns:

document type's components

setComponents

public void setComponents(java.lang.String components)

Sets document type's components (change request, tags, etc...).

Parameters:

components - document type's components

getDisplay

public java.lang.String getDisplay()

Gets document type's display.

Returns:

document type's display

setDisplay

public void setDisplay(java.lang.String display)

Sets document type's display.

Parameters:

display - document type's display

getDisplayPlural

public java.lang.String getDisplayPlural()

Gets document type's plural display.

Returns:

document type's plural display

setDisplayPlural

public void setDisplayPlural(java.lang.String displayPlural)

Sets document type's plural display.

Parameters:

displayPlural - document type's plural display

getDocumentTypeKey

public java.lang.String getDocumentTypeKey()

Gets document type's key, used in creating document keys.

Returns:

document type's key

setDocumentTypeKey

public void setDocumentTypeKey(java.lang.String documentTypeKey)

Sets document type's key

Parameters:

documentTypeKey - document type's key

getCategory

public WsDocumentTypeCategory getCategory()

Gets document type's category.

Returns:

document type's category

setCategory

public void setCategory(WsDocumentTypeCategory category)

Sets document type's category.

Parameters:

category - document type's category

setCategoryById

public void setCategoryById(java.lang.Integer categoryId)

Sets document type's category given the category's id.

Parameters:

categoryId - id of the category to set for this document type

getActive

public java.lang.Boolean getActive()

Is this document type active?

Returns:

whether or not this document type active

setActive

public void setActive(java.lang.Boolean active)

Sets whether or not this document type is active.

Parameters:

active - whether or not this document type should be active

getImage

public java.lang.String getImage()

Gets the image associated with this type

Returns:

type image

setImage

public void setImage(java.lang.String image)

Sets the image associated with this type

Parameters:

image - type image

getFields

public WsField[] getFields()

Gets the fields associated with this document type.

Returns:

array of WsFields

setFields

public void setFields(WsField[] fields)

Sets the fields associated with this document type.

Parameters:

fields - fields associated with this document type

toString

public java.lang.String toString()

Gets a string representation of this document type.

Overrides:

toString in class java.lang.Object

Returns:

String