wt.clients.lifecycle.administrator
Class CLifeCycleTemplate

java.lang.Object
  wt.clients.util.PersistableItem
      wt.clients.lifecycle.administrator.CLifeCycleTemplate

public class CLifeCycleTemplate

extends PersistableItem

A client wrapper class to handle Life Cycle Templates.

Field Summary

(package private) WTContainerRef	context
(package private) CPhaseTemplateList	cPhaseTemplateList
(package private) boolean	isBasic
(package private) LifeCycleTemplate	lifeCycleTemplate
(package private) TransactionContainer	lifeCycleTransaction
(package private) BatchContainer	mainBatchContainer

Fields inherited from class wt.clients.util.PersistableItem

Constructor Summary

CLifeCycleTemplate()
Creates a new client life cycle template object.

CLifeCycleTemplate(LifeCycleTemplate life_cycle_template)
Creates a new client life cycle template object given the server life cycle template.

Method Summary

protected void	delete() Deletes the life cycle template.
WTContainerRef	getContainerRef()
protected WTContainerRef	getContext() Return the enabled value of the life cycle template.
protected CPhaseTemplateList	getCPhaseTemplateList() Returns the list of phase templates in this life cycle template.
protected String	getDescription() Returns the description of the life cycle template.
protected LifeCycleTemplate	getLifeCycleTemplate() Returns the life cycle template.
protected BatchContainer	getMainBatchContainer() Returns the main batch container for a update or create.
protected String	getName() Returns the name of the life cycle template.
protected String	getSupportedClass() Returns the supported class of the life cycle template.
protected TransactionContainer	getTransactionContainer() Returns the transaction container for the life cycle template.
protected boolean	isBasic() Return the basic value of the life cycle template.
protected boolean	isEnabled() Return the enabled value of the life cycle template.
protected boolean	isRouting() Return the routing value of the life cycle template.
void	refresh() Refreshes this CLifeCycleTemplate to it's database state.
void	save() Saves the life cycle template.
void	setBasic(boolean a_Basic) Sets the routing value of the life cycle template.
protected void	setCPhaseTemplateList(CPhaseTemplateList cphase_template_list) Sets the phase template list of the life cycle template.
protected void	setDescription(String description) Sets the description of the life cycle template.
protected void	setEnabled(boolean a_Enabled) Sets the enabled value of the life cycle template.
protected void	setFolder(String folder_name) Sets the folder of the life cycle template.
protected void	setName(String name) Sets the name of the life cycle template.
protected void	setRouting(boolean a_Routing) Sets the routing value of the life cycle template.
protected void	setSupportedClass(String supported_class) Sets the supported class of the life cycle template.

Methods inherited from class wt.clients.util.PersistableItem

isCreated, isModified, setCreated, setModified

Methods inherited from class java.lang.Object

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

Field Detail

lifeCycleTemplate

LifeCycleTemplate lifeCycleTemplate

cPhaseTemplateList

CPhaseTemplateList cPhaseTemplateList

lifeCycleTransaction

TransactionContainer lifeCycleTransaction

mainBatchContainer

BatchContainer mainBatchContainer

context

WTContainerRef context

isBasic

boolean isBasic

Constructor Detail

CLifeCycleTemplate

public CLifeCycleTemplate()
                   throws WTException

Creates a new client life cycle template object.

Throws:

WTException - if the object cannot be created

CLifeCycleTemplate

public CLifeCycleTemplate(LifeCycleTemplate life_cycle_template)

Creates a new client life cycle template object given the server life cycle template.

Parameters:

life_cycle_template - the real life cycle template object used to base the wrapper upon

Method Detail

getContainerRef

public WTContainerRef getContainerRef()

getLifeCycleTemplate

protected LifeCycleTemplate getLifeCycleTemplate()

Returns the life cycle template.

getMainBatchContainer

protected BatchContainer getMainBatchContainer()

Returns the main batch container for a update or create.

getTransactionContainer

protected TransactionContainer getTransactionContainer()

Returns the transaction container for the life cycle template.

save

public void save()
          throws WTException

Saves the life cycle template.

Overrides:

save in class PersistableItem

Throws:

WTException - if the template cannot be saved

delete

protected void delete()
               throws WTException

Deletes the life cycle template.

Throws:

WTException - if the template cannot be deleted.

refresh

public void refresh()
             throws WTException,
                    QueryException

Refreshes this CLifeCycleTemplate to it's database state.

Overrides:

refresh in class PersistableItem

Throws:

WTException - if the object cannot be refreshed

QueryException - if the object cannot be queried

getSupportedClass

protected String getSupportedClass()

Returns the supported class of the life cycle template.

setSupportedClass

protected void setSupportedClass(String supported_class)
                          throws WTPropertyVetoException

Sets the supported class of the life cycle template.

Parameters:

supported_class - the supported class name

Throws:

WTPropertyVetoException - if the parameter is invalid

getDescription

protected String getDescription()

Returns the description of the life cycle template.

setDescription

protected void setDescription(String description)
                       throws WTPropertyVetoException

Sets the description of the life cycle template.

Parameters:

description - the description of the life cycle template

Throws:

WTPropertyVetoException - if the parameter is invalid

getName

protected String getName()

Returns the name of the life cycle template.

setName

protected void setName(String name)
                throws WTPropertyVetoException

Sets the name of the life cycle template.

Parameters:

name - the name of the life cycle template

Throws:

WTPropertyVetoException - if the parameter is invalid

isEnabled

protected boolean isEnabled()

Return the enabled value of the life cycle template.

getContext

protected WTContainerRef getContext()

Return the enabled value of the life cycle template.

setEnabled

protected void setEnabled(boolean a_Enabled)
                   throws WTPropertyVetoException

Sets the enabled value of the life cycle template.

Throws:

WTPropertyVetoException - if the parameter is invalid

isRouting

protected boolean isRouting()

Return the routing value of the life cycle template.

setRouting

protected void setRouting(boolean a_Routing)
                   throws WTPropertyVetoException

Sets the routing value of the life cycle template.

Throws:

WTPropertyVetoException - if the parameter is invalid

isBasic

protected boolean isBasic()

Return the basic value of the life cycle template.

setBasic

public void setBasic(boolean a_Basic)
              throws WTPropertyVetoException

Sets the routing value of the life cycle template.

Throws:

WTPropertyVetoException - if the parameter is invalid

setFolder

protected void setFolder(String folder_name)
                  throws WTException

Sets the folder of the life cycle template.

Parameters:

folder_name - the folder name of the life cycle template

Throws:

WTException - if the folder cannot be set

setCPhaseTemplateList

protected void setCPhaseTemplateList(CPhaseTemplateList cphase_template_list)

Sets the phase template list of the life cycle template.

Parameters:

cphase_template_list - the list of phases in this life cycle

getCPhaseTemplateList

protected CPhaseTemplateList getCPhaseTemplateList()
                                            throws WTPropertyVetoException,
                                                   WTException

Returns the list of phase templates in this life cycle template.

Throws:

WTPropertyVetoException - if the life cycle template is not found

WTException - if the phase list could not be returned