net.windward.xmlreport

Class TemplateVariable

java.lang.Object

net.windward.xmlreport.TemplateVariable

public class TemplateVariable
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateVariable.CAL_OFFSET What offset from the date run to set the calendar value to.
static class	TemplateVariable.VAR_TYPE What type of variable this data is

Constructor Summary

Constructors

Constructor and Description
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, boolean allowAll, boolean allowList, boolean allowFilter, boolean allowSort, TemplateVariable.VAR_TYPE varType, java.lang.Iterable<TemplateVariableValue> defaultValues, java.lang.Iterable<TemplateVariableValue> allowedValues, java.lang.String description, java.lang.String datasource) Create a SELECT object.
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, boolean allowAll, boolean allowList, boolean allowFilter, boolean allowSort, TemplateVariable.VAR_TYPE varType, java.lang.Object defValue, java.lang.String description, java.lang.String datasource) Create a SELECT object.
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, TemplateVariable.VAR_TYPE varType, java.lang.Iterable<TemplateVariableValue> defaultValues, java.lang.Iterable<TemplateVariableValue> allowedValues, TemplateVariable.CAL_OFFSET calOffset, java.lang.String description) Create a non-SELECT object.
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, TemplateVariable.VAR_TYPE varType, java.lang.Object defValue, TemplateVariable.CAL_OFFSET calOffset, java.lang.String description) Create a non-SELECT object.
TemplateVariable(java.lang.String name, TemplateVariable src) Create a variable object with a new name.
TemplateVariable(TemplateVariable src) Copy constructor.

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<TemplateVariable>	FromXml(TinyElement bear)
java.util.List<TemplateVariableValue>	getAllowedValues()
java.lang.String	getAutoMetadata()
TemplateVariable.CAL_OFFSET	getCalOffset()
java.lang.String	getDataSource()
java.util.List<TemplateVariableValue>	getDefaultValues()
java.lang.String	getDesription()
java.lang.String	getName()
java.lang.String	getUdtGuid()
TemplateVariable.VAR_TYPE	getVarType()
boolean	isAllowAll()
boolean	isAllowFilter()
boolean	isAllowList()
boolean	isAllowSort()
boolean	isRequired()
void	setAutoMetadata(java.lang.String value)
static TemplateVariable	SingleFromXml(TinyElement nodeVar)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Object defValue,
                        TemplateVariable.CAL_OFFSET calOffset,
                        java.lang.String description)

Create a non-SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

varType - What type of data this variable is.

defValue - The default value for this var. Can be null.

calOffset - For a default date, the calendar offset.

description - The description of this variable. This is optional.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        boolean allowAll,
                        boolean allowList,
                        boolean allowFilter,
                        boolean allowSort,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Object defValue,
                        java.lang.String description,
                        java.lang.String datasource)

Create a SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

allowAll - Can return all values for this select variable.

allowList - Can return a list of values for this select variable.

allowFilter - Can return a filtered result for this select variable.

allowSort - Can return a sorted result for this select variable.

varType - What type of data this variable is. This should be SELECT.

defValue - The default value for this var. Can be null.

description - The description of this variable. This is optional.

datasource - The name of the datasource for the select.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Iterable<TemplateVariableValue> defaultValues,
                        java.lang.Iterable<TemplateVariableValue> allowedValues,
                        TemplateVariable.CAL_OFFSET calOffset,
                        java.lang.String description)

Create a non-SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

varType - What type of data this variable is.

defaultValues - The default value for this var. Can be [0].

allowedValues - The default value for this var. Can be [0].

calOffset - For a default date, the calendar offset.

description - The description of this variable. This is optional.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        boolean allowAll,
                        boolean allowList,
                        boolean allowFilter,
                        boolean allowSort,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Iterable<TemplateVariableValue> defaultValues,
                        java.lang.Iterable<TemplateVariableValue> allowedValues,
                        java.lang.String description,
                        java.lang.String datasource)

Create a SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

allowAll - Can return all values for this select variable.

allowList - Can return a list of values for this select variable.

allowFilter - Can return a filtered result for this select variable.

allowSort - Can return a sorted result for this select variable.

varType - What type of data this variable is. This should be SELECT.

defaultValues - The default value for this var. Can be [0].

allowedValues - The default value for this var. Can be [0].

description - The description of this variable. This is optional.

datasource - The name of the datasource for the select.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        TemplateVariable src)

Create a variable object with a new name.

Parameters:

name - The new name.

src - Everything else is copied from this.

TemplateVariable

public TemplateVariable(TemplateVariable src)

Copy constructor. Copies ActiveValue and ActiveSort but no other Active* members.

Parameters:

src - The source object to copy from.

Method Detail

FromXml

public static java.util.ArrayList<TemplateVariable> FromXml(TinyElement bear)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

SingleFromXml

public static TemplateVariable SingleFromXml(TinyElement nodeVar)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getName

public java.lang.String getName()

getUdtGuid

public java.lang.String getUdtGuid()

isRequired

public boolean isRequired()

isAllowAll

public boolean isAllowAll()

isAllowList

public boolean isAllowList()

isAllowFilter

public boolean isAllowFilter()

isAllowSort

public boolean isAllowSort()

getVarType

public TemplateVariable.VAR_TYPE getVarType()

getCalOffset

public TemplateVariable.CAL_OFFSET getCalOffset()

getDataSource

public java.lang.String getDataSource()

getDesription

public java.lang.String getDesription()

getAutoMetadata

public java.lang.String getAutoMetadata()

setAutoMetadata

public void setAutoMetadata(java.lang.String value)

getDefaultValues

public java.util.List<TemplateVariableValue> getDefaultValues()

getAllowedValues

public java.util.List<TemplateVariableValue> getAllowedValues()