wt.inf.template
Class GeneratedTemplateAttributes

java.lang.Object
  wt.inf.template.GeneratedTemplateAttributes

All Implemented Interfaces:

GeneratedTemplateInstanceAttributes, Serializable

public final class GeneratedTemplateAttributes

extends Object

implements GeneratedTemplateInstanceAttributes, Serializable

This is a light class that can be used by clients to specify ContainerTemplate attributes for SaveAsTemplate and ExportAsTemplate functionality.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private String	containerClassName
private String	description
private boolean	enabled
private String	locale
private String	name
private static String	RESOURCE

Constructor Summary

GeneratedTemplateAttributes(String name, String containerClassName)
This method is used to pass creation parameneters for a new template.

GeneratedTemplateAttributes(String name, String containerClassName, boolean enabled)
This method is used to pass creation parameneters for a new template.

GeneratedTemplateAttributes(String name, String containerClassName, boolean enabled, String description)
This method is used to pass creation parameneters for a new template.

Method Summary

private void	containerClassNameValidate(String a_ContainerClassName)
private void	descriptionValidate(String a_Description)
String	getContainerClassName() Gets the value of the attribute: containerClassName.
String	getDescription() Gets the value of the attribute: description.
String	getLocale() Gets the value of the attribute: locale.
String	getName() Gets the value of the attribute: name.
WTContainerTemplate	getTemplate() Supported API: false
boolean	isEnabled() Gets the value of the attribute: enabled.
private void	localeValidate(String a_Locale)
private void	nameValidate(String a_Name)
void	setContainerClassName(String a_ContainerClassName) Sets the value of the attribute: containerClassName.
void	setDescription(String a_Description) Sets the value of the attribute: description.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: enabled.
void	setLocale(String a_Locale) Sets the value of the attribute: locale.
void	setName(String a_Name) Sets the value of the attribute: name.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

description

private String description

enabled

private boolean enabled

containerClassName

private String containerClassName

locale

private String locale

Constructor Detail

GeneratedTemplateAttributes

public GeneratedTemplateAttributes(String name,
                                   String containerClassName,
                                   boolean enabled,
                                   String description)
                            throws WTException

This method is used to pass creation parameneters for a new template. Generally you can either specify the attributes explicitly or from a seed template, (persisted or unpersisted).

Supported API: false

Parameters:

name - This may not be null, and must not be an empty string or an exception will be thrown

containerClassName -

enabled -

description -

Throws:

WTException

GeneratedTemplateAttributes

public GeneratedTemplateAttributes(String name,
                                   String containerClassName,
                                   boolean enabled)
                            throws WTException

This method is used to pass creation parameneters for a new template. Generally you can either specify the attributes explicitly or from a seed template, (persisted or unpersisted).

Supported API: false

Parameters:

name - This may not be null, and must not be an empty string or an exception will be thrown

containerClassName -

enabled -

Throws:

WTException

GeneratedTemplateAttributes

public GeneratedTemplateAttributes(String name,
                                   String containerClassName)
                            throws WTException

This method is used to pass creation parameneters for a new template. Generally you can either specify the attributes explicitly or from a seed template, (persisted or unpersisted). This method is equivalent to setting enabled to true

Supported API: false

Parameters:

name - This may not be null, and must not be an empty string or an exception will be thrown

containerClassName -

Throws:

WTException

Method Detail

getName

public String getName()

Gets the value of the attribute: name.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: name.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: description.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: description.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

isEnabled

public boolean isEnabled()

Gets the value of the attribute: enabled.

Supported API: false

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: enabled.

Supported API: false

Parameters:

a_Enabled -

getContainerClassName

public String getContainerClassName()

Gets the value of the attribute: containerClassName.

Supported API: false

Returns:

String

setContainerClassName

public void setContainerClassName(String a_ContainerClassName)
                           throws WTPropertyVetoException

Sets the value of the attribute: containerClassName.

Supported API: false

Parameters:

a_ContainerClassName -

Throws:

WTPropertyVetoException

containerClassNameValidate

private void containerClassNameValidate(String a_ContainerClassName)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerClassName -

Throws:

WTPropertyVetoException

getLocale

public String getLocale()

Gets the value of the attribute: locale.

Supported API: false

Returns:

String

setLocale

public void setLocale(String a_Locale)
               throws WTPropertyVetoException

Sets the value of the attribute: locale.

Supported API: false

Parameters:

a_Locale -

Throws:

WTPropertyVetoException

localeValidate

private void localeValidate(String a_Locale)
                     throws WTPropertyVetoException

Parameters:

a_Locale -

Throws:

WTPropertyVetoException

getTemplate

public WTContainerTemplate getTemplate()
                                throws WTException

Supported API: false

Specified by:

getTemplate in interface GeneratedTemplateInstanceAttributes

Returns:

WTContainerTemplate

Throws:

WTException