net.windward.xmlreport

Enum TemplateVariable.CAL_OFFSET

java.lang.Object

java.lang.Enum<TemplateVariable.CAL_OFFSET>

net.windward.xmlreport.TemplateVariable.CAL_OFFSET

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TemplateVariable.CAL_OFFSET>

Enclosing class:

TemplateVariable

public static enum TemplateVariable.CAL_OFFSET
extends java.lang.Enum<TemplateVariable.CAL_OFFSET>

What offset from the date run to set the calendar value to. These have set integer values that are identical in ScheduleVarItem and in .aspx pages - do not change them.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXED Use the value saved for the map var.
START_OF_MONTH Set the value to the first day of the month we are on.
START_OF_QUARTER Set the value to the first day of the quarter we are on.
START_OF_WEEK Set the value to the first day of the week we are on.
START_OF_YEAR Set the value to the first day of the year we are on.
TODAY Set the value to today.

Method Summary

Modifier and Type	Method and Description
int	getNumVal()
static TemplateVariable.CAL_OFFSET	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TemplateVariable.CAL_OFFSET[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIXED

public static final TemplateVariable.CAL_OFFSET FIXED

Use the value saved for the map var.

TODAY

public static final TemplateVariable.CAL_OFFSET TODAY

Set the value to today.

START_OF_WEEK

public static final TemplateVariable.CAL_OFFSET START_OF_WEEK

Set the value to the first day of the week we are on. This uses the culture of the server that runs the event.

START_OF_MONTH

public static final TemplateVariable.CAL_OFFSET START_OF_MONTH

Set the value to the first day of the month we are on. This uses the culture of the server that runs the event.

START_OF_QUARTER

public static final TemplateVariable.CAL_OFFSET START_OF_QUARTER

Set the value to the first day of the quarter we are on. This uses the culture of the server that runs the event.

START_OF_YEAR

public static final TemplateVariable.CAL_OFFSET START_OF_YEAR

Set the value to the first day of the year we are on. This uses the culture of the server that runs the event.

Method Detail

values

public static TemplateVariable.CAL_OFFSET[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TemplateVariable.CAL_OFFSET c : TemplateVariable.CAL_OFFSET.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TemplateVariable.CAL_OFFSET valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNumVal

public int getNumVal()