wt.clients.workflow.definer
Interface WfTemplateEditor

interface WfTemplateEditor

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener)
void	deleteWfTemplate() Deletes the WfNodeTemplate this Editor references.
BatchContainer	getBatchContainer()
Component	getComponent() Returns the component which will edit the specified NodeTemplate.
String	getIconName() Returns the icon of this node template.
String	getName() Returns the name of this node template.
WfProcessTemplate	getParentTemplate() Returns the parent template.
Point	getPosition() Returns the name of this node template.
String	getSubtype() Returns the subtype of the template.
TransactionContainer	getTransactionContainer()
WfNodeTemplate	getWfTemplate() Returns the WfNodeTemplate this Editor references.
WfNodeTemplate	newWfTemplate() Creates a new node template.
WfNodeTemplate	newWfTemplate(WfProcessTemplate process) Creates a new node template.
void	populateWfTemplate(WfNodeTemplate node) Populate the Editor with the WfNodeTemplate it should reference.
void	populateWfTemplate(WfNodeTemplate node, WfProcessTemplate process) Populate the Editor with the WfNodeTemplate it should reference.
void	saveWfTemplate() Saves the WfNodeTemplate this Editor references.
void	setBatchContainer(BatchContainer batch)
void	setSubtype(String subtype) Sets the subtype of the template.
void	setTransactionContainer(TransactionContainer transaction)
void	setWfTemplate(WfNodeTemplate node) Sets the WfNodeTemplate this Editor should reference.

Method Detail

setSubtype

public void setSubtype(String subtype)

Sets the subtype of the template. This will also set the default name and icon of the template.

Parameters:

subtype - Any String which is used as a key for finding icons and names and creating new templates.

getSubtype

public String getSubtype()

Returns the subtype of the template.

getName

public String getName()

Returns the name of this node template.

getPosition

public Point getPosition()

Returns the name of this node template.

getIconName

public String getIconName()

Returns the icon of this node template.

newWfTemplate

public WfNodeTemplate newWfTemplate()

Creates a new node template. Either the subtype of the template must be set using the setSubtype method or there are are no subtypes for this node template.

newWfTemplate

public WfNodeTemplate newWfTemplate(WfProcessTemplate process)

Creates a new node template. Either the subtype of the template must be set using the setSubtype method or there are are no subtypes for this node template. The process specifies which process this template will become a step in.

Parameters:

process - The process this template is a step of.

populateWfTemplate

public void populateWfTemplate(WfNodeTemplate node)

Populate the Editor with the WfNodeTemplate it should reference. This is used to pre-populate an Editor with an existing node template.

Parameters:

node - The template this Editor will reference and update.

populateWfTemplate

public void populateWfTemplate(WfNodeTemplate node,
                               WfProcessTemplate process)

Populate the Editor with the WfNodeTemplate it should reference. This is used to pre-populate an Editor with an existing node template which is in an existing WfProcessTemplate.

Parameters:

node - The template this Editor will reference and update.

process - The process this template is a step of.

setWfTemplate

public void setWfTemplate(WfNodeTemplate node)

Sets the WfNodeTemplate this Editor should reference. This is used to pre-populate an Editor with an existing node template.

Parameters:

node - The template this Editor will reference and update.

getWfTemplate

public WfNodeTemplate getWfTemplate()

Returns the WfNodeTemplate this Editor references.

saveWfTemplate

public void saveWfTemplate()
                    throws WTException

Saves the WfNodeTemplate this Editor references.

Throws:

WTException

deleteWfTemplate

public void deleteWfTemplate()

Deletes the WfNodeTemplate this Editor references.

getParentTemplate

public WfProcessTemplate getParentTemplate()

Returns the parent template.

setBatchContainer

public void setBatchContainer(BatchContainer batch)

getBatchContainer

public BatchContainer getBatchContainer()

setTransactionContainer

public void setTransactionContainer(TransactionContainer transaction)

getTransactionContainer

public TransactionContainer getTransactionContainer()

getComponent

public Component getComponent()

Returns the component which will edit the specified NodeTemplate.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)