com.jamasoftware.contour.ws.domain

Class WsModule

java.lang.Object

com.jamasoftware.contour.ws.domain.WsModule

public class WsModule
extends 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

Constructors

Constructor and Description
WsModule() Creates an empty WsModule object.
WsModule(WsProject project, WsDocumentType documentType) Creates a new WsModule object from the given WsProject and WsDocumentType.

Method Summary

Methods

Modifier and Type	Method and Description
WsDocumentType	getDocumentType() Gets the document type this module inherits from.
Integer	getId() Gets the module's id.
WsProject	getProject() Gets the project this module belongs to.
Integer	getSortOrder() Gets the module's sort order
boolean	isActive() Is this module active?
void	setActive(boolean active) Sets whether or not this module is active.
void	setDocumentType(WsDocumentType documentType) Sets the document type this module inherits from.
void	setId(Integer id) Sets the module's id.
void	setProject(WsProject project) Sets the project this module belongs to.
void	setSortOrder(Integer sortOrder) Sets the module's sort order
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(WsProject project,
        WsDocumentType documentType)

Creates a new WsModule object from the given WsProject and WsDocumentType.

Parameters:

project - project the module is in

documentType - document type the module represents

Method Detail

getId

public Integer getId()

Gets the module's id.

Returns:

module id

setId

public void setId(Integer id)

Sets the module's id.

Parameters:

id - module id

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

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

getSortOrder

public Integer getSortOrder()

Gets the module's sort order

Returns:

module sort order

setSortOrder

public void setSortOrder(Integer sortOrder)

Sets the module's sort order

Parameters:

sortOrder - module sort order

toString

public String toString()

Gets a string representation of this module.

Overrides:

toString in class Object

Returns:

String