com.appiancorp.suiteapi.process.calendar

Class CalendarElement

java.lang.Object

com.appiancorp.suiteapi.process.calendar.CalendarElement

All Implemented Interfaces:

com.appiancorp.core.expr.calendar.PortableCalendarElement

Direct Known Subclasses:

CalendarDateElement

public class CalendarElement
extends java.lang.Object
implements com.appiancorp.core.expr.calendar.PortableCalendarElement

The CalendarElement stores a start and end time, which is used by the WorkingCalendar to specify all start and end times per day. The start and end times are stored by specifying the minute of the day which will be the start time, and a duration which will define the end time.

Constructor Summary

Constructors

Constructor and Description
CalendarElement() Constructs an empty CalendarElement (0 for both values).
CalendarElement(int minuteOfDay_, int lengthInMinutes_) Constructs a CalendarElement with default values for the start minute and number of duration minutes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getLengthInMinutes() Get the duration of this start-end period in minutes.
int	getMinuteOfDay() Get the minute of the day on which this start-end period will start. 0 minutes corresponds to midnight.
int	hashCode()
protected java.lang.String	minuteString(int minutes)
void	setLengthInMinutes(int lengthInMinutes_) Set the duration of this start-end period in minutes.
void	setMinuteOfDay(int minuteOfDay_) Set the minute of the day on which this start-end period will start.
java.lang.String[]	startEndToString(javax.servlet.http.HttpSession hs_) Returns the string respresentation of the Start and End time of this element.
static CalendarElement	stringToCalendarElement(java.lang.String startTime, java.lang.String endTime, java.util.Locale locale, java.lang.String calendarId) Given the start time and end time as strings, returns a calendar element.
java.lang.String	toString() Simple toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CalendarElement

public CalendarElement()

Constructs an empty CalendarElement (0 for both values).

CalendarElement

public CalendarElement(int minuteOfDay_,
                       int lengthInMinutes_)

Constructs a CalendarElement with default values for the start minute and number of duration minutes.

Parameters:

minuteOfDay_ - The starting minute of the day.

lengthInMinutes_ - The duration of this element in minutes.

Method Detail

getLengthInMinutes

public int getLengthInMinutes()

Get the duration of this start-end period in minutes. The end time in minutes is determined by adding this duration to the start time in minutes.

Specified by:

getLengthInMinutes in interface com.appiancorp.core.expr.calendar.PortableCalendarElement

Returns:

The duration of the start-end period in minutes.

See Also:

setLengthInMinutes(int)

setLengthInMinutes

public void setLengthInMinutes(int lengthInMinutes_)

Set the duration of this start-end period in minutes.

Parameters:

lengthInMinutes_ - The duration of the start-end period in minutes to set.

See Also:

getLengthInMinutes()

getMinuteOfDay

public int getMinuteOfDay()

Get the minute of the day on which this start-end period will start. 0 minutes corresponds to midnight.

Specified by:

getMinuteOfDay in interface com.appiancorp.core.expr.calendar.PortableCalendarElement

Returns:

Returns the minuteOfDay.

See Also:

setMinuteOfDay(int)

setMinuteOfDay

public void setMinuteOfDay(int minuteOfDay_)

Set the minute of the day on which this start-end period will start.

Parameters:

minuteOfDay_ - The minuteOfDay to set.

See Also:

getMinuteOfDay()

startEndToString

public java.lang.String[] startEndToString(javax.servlet.http.HttpSession hs_)

Returns the string respresentation of the Start and End time of this element.

Parameters:

hs_ - the http session, needed to format the entries according to the locale.

Returns:

an array of two elements, the first entry is the start time, the second entry is the end time.

stringToCalendarElement

public static CalendarElement stringToCalendarElement(java.lang.String startTime,
                                                      java.lang.String endTime,
                                                      java.util.Locale locale,
                                                      java.lang.String calendarId)
                                               throws java.text.ParseException

Given the start time and end time as strings, returns a calendar element. The strings must be formatted according to the picker format for times. If both entries are blank, a blank CalendarElement will be returned.

Parameters:

startTime - The start time as a string.

endTime - The end time as a string.

locale - The locale under which the passed strings where generated.

calendarId - The Id of the calendar under which the passed strings where generated.

Returns:

a CalendarElement

Throws:

java.text.ParseException - If the startTime and/or endTime cannot be parsed into an actual time value.

toString

public java.lang.String toString()

Simple toString method. The format of this is allowed to change.

Overrides:

toString in class java.lang.Object

minuteString

protected java.lang.String minuteString(int minutes)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object