Package wt.query.template

Class ParameterTemplate

java.lang.Object

wt.query.template.ParameterTemplate

All Implemented Interfaces:

Externalizable, Serializable

public class ParameterTemplate
extends Object
implements Externalizable

A ParameterTemplate represents a template for a parameter that can be used to generate a runtime parameter value for a report.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the value of the attribute: defaultValue; A default value that can be used if no value is explicitly specified.
String	getEnumerationIdentifier()	Gets the value of the attribute: enumerationIdentifier; EnumerationIdentifier is used for the display of enumeration dropdowns.
String	getInternalName()	Gets the value of the attribute: internalName; Internal Name is a version of Name that can be used as an HTML Id.
String	getName()	Gets the value of the attribute: name; Uniquely identifies the parameter.
String	getType()	Gets the value of the attribute: type; Specifies the type (Java language type) of the parameter value.
Object	getValue(Hashtable a_inputs)	Evaluates the ParameterTemplate using the user inputs to derive an actual parameter value.
Object	getValueWithNoDefaults(Hashtable a_inputs)	Evaluates the ParameterTemplate using only the user inputs (default value is not used) to derive an actual parameter value.
boolean	isMacro()	Gets the value of the attribute: macro; Indicates if the parameter value is a macro.
void	setDefaultValue(String a_DefaultValue)	Sets the value of the attribute: defaultValue; A default value that can be used if no value is explicitly specified.
void	setEnumerationIdentifier(String a_EnumerationIdentifier)	Sets the value of the attribute: enumerationIdentifier; EnumerationIdentifier is used for the display of enumeration dropdowns.
void	setInternalName(String a_InternalName)	Sets the value of the attribute: internalName; Internal Name is a version of Name that can be used as an HTML Id.
void	setMacro(boolean a_Macro)	Sets the value of the attribute: macro; Indicates if the parameter value is a macro.
void	setName(String a_Name)	Sets the value of the attribute: name; Uniquely identifies the parameter.
void	setType(String a_Type)	Sets the value of the attribute: type; Specifies the type (Java language type) of the parameter value.

Methods inherited from class java.lang.Object

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

Method Details

getName

public String getName()

Gets the value of the attribute: name; Uniquely identifies the parameter.

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: name; Uniquely identifies the parameter.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getInternalName

public String getInternalName()

Gets the value of the attribute: internalName; Internal Name is a version of Name that can be used as an HTML Id.

Supported API: true

Returns:

String

setInternalName

public void setInternalName(String a_InternalName)
                     throws WTPropertyVetoException

Sets the value of the attribute: internalName; Internal Name is a version of Name that can be used as an HTML Id.

Supported API: true

Parameters:

a_InternalName -

Throws:

WTPropertyVetoException

getEnumerationIdentifier

public String getEnumerationIdentifier()

Gets the value of the attribute: enumerationIdentifier; EnumerationIdentifier is used for the display of enumeration dropdowns.

Supported API: true

Returns:

String

setEnumerationIdentifier

public void setEnumerationIdentifier(String a_EnumerationIdentifier)
                              throws WTPropertyVetoException

Sets the value of the attribute: enumerationIdentifier; EnumerationIdentifier is used for the display of enumeration dropdowns.

Supported API: true

Parameters:

a_EnumerationIdentifier -

Throws:

WTPropertyVetoException

getDefaultValue

public String getDefaultValue()

Gets the value of the attribute: defaultValue; A default value that can be used if no value is explicitly specified.

Supported API: true

Returns:

String

setDefaultValue

public void setDefaultValue(String a_DefaultValue)
                     throws WTPropertyVetoException

Sets the value of the attribute: defaultValue; A default value that can be used if no value is explicitly specified.

Supported API: true

Parameters:

a_DefaultValue -

Throws:

WTPropertyVetoException

isMacro

public boolean isMacro()

Gets the value of the attribute: macro; Indicates if the parameter value is a macro.

Supported API: true

Returns:

boolean

setMacro

public void setMacro(boolean a_Macro)
              throws WTPropertyVetoException

Sets the value of the attribute: macro; Indicates if the parameter value is a macro.

Supported API: true

Parameters:

a_Macro -

Throws:

WTPropertyVetoException

getType

public String getType()

Gets the value of the attribute: type; Specifies the type (Java language type) of the parameter value.

Supported API: true

Returns:

String

setType

public void setType(String a_Type)
             throws WTPropertyVetoException

Sets the value of the attribute: type; Specifies the type (Java language type) of the parameter value.

Supported API: true

Parameters:

a_Type -

Throws:

WTPropertyVetoException

getValue

public Object getValue(Hashtable a_inputs)
                throws WTException

Evaluates the ParameterTemplate using the user inputs to derive an actual parameter value.

Supported API: true

Parameters:

a_inputs -

Returns:

Object

Throws:

WTException

getValueWithNoDefaults

public Object getValueWithNoDefaults(Hashtable a_inputs)
                              throws WTException

Evaluates the ParameterTemplate using only the user inputs (default value is not used) to derive an actual parameter value.

Supported API: true

Parameters:

a_inputs -

Returns:

Object

Throws:

WTException