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

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

public class WsModule
extends java.lang.Object

This object represents a Contour document group (also known as a set). A Set in Contour is a group of Items of the same type. Each Set is created from an Item Type.

Author:

Dylan

Constructor Summary

WsModule()
Creates an empty WsModule object.

WsModule(java.lang.String display, java.lang.String displayPlural, WsProject project, java.lang.String prefix, java.lang.String keySeparator, java.lang.Boolean displayInReleaseTree, boolean notification)
Creates a new WsModule object with the given values.

WsModule(java.lang.String display, WsProject project)
Creates a new WsModule object from the given display and project.

Method Summary

java.lang.String	getDescription() Gets the module's description.
java.lang.String	getDisplay() Gets the module's display.
java.lang.Boolean	getDisplayInReleaseTree() Does this module display in the release tree?
java.lang.String	getDisplayPlural() Gets the module's plural display.
WsDocumentType	getDocumentType() Gets the document type this module inherits from.
java.lang.Integer	getId() Gets the module's id.
java.lang.String	getImage() Gets the image associated with this module
java.lang.String	getKeySeparator() Gets module's key separator.
java.lang.String	getPrefix() Gets module's prefix
WsProject	getProject() Gets the project this module belongs to.
java.lang.Integer	getSequenceNumber() Gets module's starting sequence number.
java.lang.Integer	getSortOrder() Gets the module's sort order
boolean	isActive() Is this module active?
boolean	isEditable() Is this module editable?
boolean	isNotification() Is this module set to send notifications?
boolean	isParentNotification() Is this module set to send parent notifications?
void	setActive(boolean active) Sets whether or not this module is active.
void	setDescription(java.lang.String description) Sets the module's description.
void	setDisplay(java.lang.String display) Sets the module's display.
void	setDisplayInReleaseTree(java.lang.Boolean displayInReleaseTree) Sets whether or not this module is shown in the release tree
void	setDisplayPlural(java.lang.String displayPlural) Sets the module's plural display.
void	setDocumentType(WsDocumentType documentType) Sets the document type this module inherits from.
void	setEditable(boolean editable) Sets whether or not this module is editable.
void	setId(java.lang.Integer id) Sets the module's id.
void	setImage(java.lang.String image) Sets the image associated with this module
void	setKeySeparator(java.lang.String keySeparator) Sets module's key separator.
void	setNotification(boolean notification) Sets whether or not this module is set to send notifications.
void	setParentNotification(boolean parentNotification) Sets whether or not this module is set to send parent notifications.
void	setPrefix(java.lang.String prefix) Sets module's prefix
void	setProject(WsProject project) Sets the project this module belongs to.
void	setSequenceNumber(java.lang.Integer sequenceNumber) Set module's starting sequence number.
void	setSortOrder(java.lang.Integer sortOrder) Sets the module's sort order
java.lang.String	toString() Gets a string representation of this module.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsModule

public WsModule()

Creates an empty WsModule object.

WsModule

public WsModule(java.lang.String display,
                java.lang.String displayPlural,
                WsProject project,
                java.lang.String prefix,
                java.lang.String keySeparator,
                java.lang.Boolean displayInReleaseTree,
                boolean notification)

Creates a new WsModule object with the given values.

Parameters:

display - name of the module

displayPlural - plural name of the module (can be null)

project - project the module is in

prefix - prefix to put before item numbers (i.e. "TST" for "TST-05") (can be null)

keySeparator - separator between the prefix and item number (i.e. "-" for "TST-05") (can be null)

displayInReleaseTree - should this be displayed in the release tree?

notification - enable notifications?

WsModule

public WsModule(java.lang.String display,
                WsProject project)

Creates a new WsModule object from the given display and project.

Parameters:

display - name of the module

project - project the module is in

Method Detail

getId

public java.lang.Integer getId()

Gets the module's id.

Returns:

module id

setId

public void setId(java.lang.Integer id)

Sets the module's id.

Parameters:

id - module id

getDescription

public java.lang.String getDescription()

Gets the module's description.

Returns:

module description

setDescription

public void setDescription(java.lang.String description)

Sets the module's description.

Parameters:

description - module description

getDisplay

public java.lang.String getDisplay()

Gets the module's display.

Returns:

module display

setDisplay

public void setDisplay(java.lang.String display)

Sets the module's display.

Parameters:

display - module display

getDisplayPlural

public java.lang.String getDisplayPlural()

Gets the module's plural display.

Returns:

module plural display

setDisplayPlural

public void setDisplayPlural(java.lang.String displayPlural)

Sets the module's plural display.

Parameters:

displayPlural - module plural display

getProject

public WsProject getProject()

Gets the project this module belongs to.

Returns:

project this module is in

See Also:

WsProject

setProject

public void setProject(WsProject project)

Sets the project this module belongs to.

Parameters:

project - project this module is in

See Also:

WsProject

getDocumentType

public WsDocumentType getDocumentType()

Gets the document type this module inherits from.

Returns:

module document type

setDocumentType

public void setDocumentType(WsDocumentType documentType)

Sets the document type this module inherits from.

Parameters:

documentType - module document type

getImage

public java.lang.String getImage()

Gets the image associated with this module

Returns:

module image

setImage

public void setImage(java.lang.String image)

Sets the image associated with this module

Parameters:

image - module image

isActive

public boolean isActive()

Is this module active?

Returns:

whether or not this module is active

setActive

public void setActive(boolean active)

Sets whether or not this module is active.

Parameters:

active - whether or not this module should be active

getPrefix

public java.lang.String getPrefix()

Gets module's prefix

Returns:

module prefix

setPrefix

public void setPrefix(java.lang.String prefix)

Sets module's prefix

Parameters:

prefix - prefix to put before item numbers (i.e. "TST" for "TST-05")

getSequenceNumber

public java.lang.Integer getSequenceNumber()

Gets module's starting sequence number.

Returns:

module sequence number

setSequenceNumber

public void setSequenceNumber(java.lang.Integer sequenceNumber)

Set module's starting sequence number.

Parameters:

sequenceNumber - module sequence number

getKeySeparator

public java.lang.String getKeySeparator()

Gets module's key separator.

Returns:

module key separator

setKeySeparator

public void setKeySeparator(java.lang.String keySeparator)

Sets module's key separator.

Parameters:

keySeperator - separator between the prefix and item number (i.e. "-" for "TST-05")

getDisplayInReleaseTree

public java.lang.Boolean getDisplayInReleaseTree()

Does this module display in the release tree?

Returns:

whether or not this module is shown in the release tree

setDisplayInReleaseTree

public void setDisplayInReleaseTree(java.lang.Boolean displayInReleaseTree)

Sets whether or not this module is shown in the release tree

Parameters:

displayInReleaseTree - whether or not this module should be shown in the release tree

getSortOrder

public java.lang.Integer getSortOrder()

Gets the module's sort order

Returns:

module sort order

setSortOrder

public void setSortOrder(java.lang.Integer sortOrder)

Sets the module's sort order

Parameters:

sortOrder - module sort order

isNotification

public boolean isNotification()

Is this module set to send notifications?

Returns:

whether or not this module is set to send notifications

setNotification

public void setNotification(boolean notification)

Sets whether or not this module is set to send notifications.

Parameters:

notification - whether or not this module should be set to send notifications

isParentNotification

public boolean isParentNotification()

Is this module set to send parent notifications?

Returns:

whether or not this module is set to send parent notifications

setParentNotification

public void setParentNotification(boolean parentNotification)

Sets whether or not this module is set to send parent notifications.

Parameters:

parentNotification - whether or not this module should be set to send parent notifications

isEditable

public boolean isEditable()

Is this module editable?

Returns:

whether or not this module is editable

setEditable

public void setEditable(boolean editable)

Sets whether or not this module is editable.

Parameters:

editable - whether or not this module should be editable

toString

public java.lang.String toString()

Gets a string representation of this module.

Overrides:

toString in class java.lang.Object

Returns:

String