planetj.dataengine.autorun
Class AutoRunPropertyGroup

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--planetj.property.PropertyGroup
                    |
                    +--planetj.dataengine.autorun.AutoRunPropertyGroup

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

Direct Known Subclasses:

DistributionPropertyGroup

public class AutoRunPropertyGroup

extends PropertyGroup

A PropertyGroup containing auto run information

See Also:

Serialized Form

Field Summary

static List	ALL_PROPERTIES
static String	AUTORUN
static String	FREQUENCY
static List	REQUIRED_PROPERTIES
static String	START_DATE
static String	START_DATE_TODAY
static String	START_TIME
static String	START_TIME_IMMEDIATELY

Fields inherited from class planetj.property.PropertyGroup

ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, INTEGER_PROPERTY, LIST_PROPERTY, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

AutoRunPropertyGroup()
DistributionPropertyGroup constructor comment.

AutoRunPropertyGroup(int initialCapacity)
DistributionPropertyGroup constructor comment.

AutoRunPropertyGroup(String pName)
DistributionPropertyGroup constructor comment.

Method Summary

List	getAllPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
SimpleDateFormat	getDateFormat(String name) Returns the date formatter to use when formatting dates for the specified property
long	getFrequency() Gets the frequency (in seconds) that the report should run
List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.
Date	getStartDate() Gets the day on which the distribution should be started
Date	getStartDateTime() Gets the exact time and day to start the distribution
Date	getStartTime() Gets the time of day which the distribution should be started

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getListValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, put, put, put, setName, toString, updateProperty

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

AUTORUN

public static final String AUTORUN

See Also:

Constant Field Values

START_DATE

public static final String START_DATE

See Also:

Constant Field Values

START_TIME

public static final String START_TIME

See Also:

Constant Field Values

FREQUENCY

public static final String FREQUENCY

See Also:

Constant Field Values

START_DATE_TODAY

public static final String START_DATE_TODAY

See Also:

Constant Field Values

START_TIME_IMMEDIATELY

public static final String START_TIME_IMMEDIATELY

See Also:

Constant Field Values

ALL_PROPERTIES

public static final List ALL_PROPERTIES

REQUIRED_PROPERTIES

public static final List REQUIRED_PROPERTIES

Constructor Detail

AutoRunPropertyGroup

public AutoRunPropertyGroup()

DistributionPropertyGroup constructor comment.

AutoRunPropertyGroup

public AutoRunPropertyGroup(int initialCapacity)

DistributionPropertyGroup constructor comment.

Parameters:

initialCapacity - int

AutoRunPropertyGroup

public AutoRunPropertyGroup(String pName)

DistributionPropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAllPropertyNames

public List getAllPropertyNames()

Gets a List containing the names of all the supported properties, not including metaproperties.

Specified by:

getAllPropertyNames in class PropertyGroup

getDateFormat

public SimpleDateFormat getDateFormat(String name)

Returns the date formatter to use when formatting dates for the specified property

Overrides:

getDateFormat in class PropertyGroup

getFrequency

public long getFrequency()

Gets the frequency (in seconds) that the report should run

getRequiredPropertyNames

public List getRequiredPropertyNames()

Gets a List containing the names of all the required properties.

Specified by:

getRequiredPropertyNames in class PropertyGroup

getStartDate

public Date getStartDate()

Gets the day on which the distribution should be started

getStartDateTime

public Date getStartDateTime()

Gets the exact time and day to start the distribution

getStartTime

public Date getStartTime()

Gets the time of day which the distribution should be started