Package org.itracker.model.util

Class WorkflowUtilities

java.lang.Object

org.itracker.model.util.WorkflowUtilities

public class WorkflowUtilities
extends Object

Contains utilities used when displaying and processing workflow and field events

Field Summary

Fields

Modifier and Type	Field	Description
static int	EVENT_FIELD_ONPOPULATE	Fires for each field when building the form.
static int	EVENT_FIELD_ONPOSTSUBMIT	Fires after all data is submitted to the db for all fields.
static int	EVENT_FIELD_ONPRESUBMIT	Fires after validation, but before the data is committed to the database.
static int	EVENT_FIELD_ONSETDEFAULT	Fires to set the current value of a form field.
static int	EVENT_FIELD_ONSORT	NOT CURRENTLY IMPLEMENTED.
static int	EVENT_FIELD_ONVALIDATE	Fires on validation of the form field.

Constructor Summary

Constructors

Constructor	Description
WorkflowUtilities()

Method Summary

Modifier and Type	Method	Description
static String	getEventName(int value, Locale locale)	Returns a title of workflow event, according to selected locale.
static String	getEventName(String value, Locale locale)
static NameValuePair[]	getEvents(Locale locale)	Returns an array of pairs (eventName, eventId), where eventName is an event title, according to selected locale.
static List<NameValuePair>	getListOptions(Map<Integer,List<NameValuePair>> listOptions, int fieldId)	Select a list of NameValuePair objects from provided map object according to fieldId selector.
static List<NameValuePair>	getListOptions(Map listOptions, Integer fieldId)	Select a list of NameValuePair objects from provided map object according to fieldId selector.

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_FIELD_ONPOPULATE

public static final int EVENT_FIELD_ONPOPULATE

Fires for each field when building the form. Mainly used to build dynamic list options.

See Also:

Constant Field Values

EVENT_FIELD_ONSORT

public static final int EVENT_FIELD_ONSORT

NOT CURRENTLY IMPLEMENTED. Use the onPopulate event instead. In the future, this event may be implemented to allow for list sorting after list value population.

See Also:

Constant Field Values

EVENT_FIELD_ONSETDEFAULT

public static final int EVENT_FIELD_ONSETDEFAULT

Fires to set the current value of a form field. This will overwrite any data in the form field pulled from the database.

See Also:

Constant Field Values

EVENT_FIELD_ONVALIDATE

public static final int EVENT_FIELD_ONVALIDATE

Fires on validation of the form field.

See Also:

Constant Field Values

EVENT_FIELD_ONPRESUBMIT

public static final int EVENT_FIELD_ONPRESUBMIT

Fires after validation, but before the data is committed to the database.

See Also:

Constant Field Values

EVENT_FIELD_ONPOSTSUBMIT

public static final int EVENT_FIELD_ONPOSTSUBMIT

Fires after all data is submitted to the db for all fields. Performed right before the response is sent.

See Also:

Constant Field Values

Constructor Detail

WorkflowUtilities

public WorkflowUtilities()

Method Detail

getEventName

public static String getEventName(int value,
                                  Locale locale)

Returns a title of workflow event, according to selected locale.

Parameters:

value - is an identifier of incoming event.

locale - is a selected locale.

Returns:

a name of event or something like "MISSING KEY: ".

getEventName

public static String getEventName(String value,
                                  Locale locale)

getEvents

public static NameValuePair[] getEvents(Locale locale)

Returns an array of pairs (eventName, eventId), where eventName is an event title, according to selected locale.

Parameters:

locale - is a selected locale.

Returns:

an array of pairs (eventName, eventId), which is never null.

getListOptions

public static List<NameValuePair> getListOptions(Map<Integer,List<NameValuePair>> listOptions,
                                                 int fieldId)

Select a list of NameValuePair objects from provided map object according to fieldId selector. Typesafe version of #getListOptions(Map, Integer)

Parameters:

listOptions - is a map, with stored NameValuePair objects lists associated with specific integer id.

fieldId - is a selector from map.

Returns:

a list of objects, which may be empty, but never null.

getListOptions

public static List<NameValuePair> getListOptions(Map listOptions,
                                                 Integer fieldId)

Select a list of NameValuePair objects from provided map object according to fieldId selector.

Parameters:

listOptions - is a map, with stored NameValuePair objects lists associated with specific integer id.

fieldId - is a selector from map.

Returns:

a list of objects, which may be empty, but never null.