com.appiancorp.suiteapi.process

Class RecurringInterval.Yearly

java.lang.Object

com.appiancorp.suiteapi.process.RecurringInterval.Yearly

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

RecurringInterval

public static class RecurringInterval.Yearly
extends java.lang.Object
implements java.io.Serializable

Class defines time interval for Yearly events. Yearly events can occur on a specific day of the month i.e. on "10th day of Jan" or on a specific week day of the month i.e. on "SECOND Friday of March".

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Yearly()
Yearly(boolean weekdayBased_) Create a new yearly object

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getDayOfMonth() Returns the day of the month on which the event occurs
java.lang.String	getDayOfMonthExpr() Gets the day of the month on which the event occurs
java.lang.Integer	getDayOfWeek() Returns the day of the day of the week on which event occurs.
java.lang.Integer	getMonth() Gets the month of the year on which Yearly event occurs.
boolean	getWeekdayBased() Returns true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.
java.lang.Integer	getWeekType() Gets the Week of the month on which the Yearly event occurs.
void	setDayOfMonth(java.lang.Integer dayOfMonth_) Sets the day of the month on which event occurs
void	setDayOfMonthExpr(java.lang.String dayOfMonthExpr_) Sets the day of the month on which the event occurs
void	setDayOfWeek(java.lang.Integer dayOfWeek_) Sets the day of the week on which the day of the week on which event occurs.
void	setMonth(java.lang.Integer month_) Set the month of the year on which Yearly event occurs.
void	setWeekdayBased(boolean weekdayBased_) Set tp true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.
void	setWeekType(java.lang.Integer dayType_) Sets the Week of the month on which the Yearly event occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

Yearly

public Yearly()

Yearly

public Yearly(boolean weekdayBased_)

Create a new yearly object

Parameters:

weekdayBased_ - true if the Yearly events occur on a specific day of a week of month like R"SECOND Friday of March".

Method Detail

getDayOfMonth

public java.lang.Integer getDayOfMonth()

Returns the day of the month on which the event occurs

Returns:

1 - 31

setDayOfMonth

public void setDayOfMonth(java.lang.Integer dayOfMonth_)

Sets the day of the month on which event occurs

Parameters:

dayOfMonth_ - 1 - 31

Throws:

java.lang.IllegalArgumentException - if the parameters is not between 1 - 31

getDayOfWeek

public java.lang.Integer getDayOfWeek()

Returns the day of the day of the week on which event occurs. SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, SATURDAY = 7

Returns:

1 - 7

setDayOfWeek

public void setDayOfWeek(java.lang.Integer dayOfWeek_)

Sets the day of the week on which the day of the week on which event occurs. SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, SATURDAY = 7

Parameters:

dayOfWeek_ - between 1 - 7

getWeekType

public java.lang.Integer getWeekType()

Gets the Week of the month on which the Yearly event occurs. This property is used to specify monthly event like "Third Wednesday of Jan".

See Also:

RecurringInterval.Monthly.WEEK_FIRST, RecurringInterval.Monthly.WEEK_SECOND, RecurringInterval.Monthly.WEEK_THIRD, RecurringInterval.Monthly.WEEK_FOURTH, RecurringInterval.Monthly.WEEK_LAST

setWeekType

public void setWeekType(java.lang.Integer dayType_)

Sets the Week of the month on which the Yearly event occurs. This property is used to specify monthly event like "Third Wednesday of Jan".

See Also:

RecurringInterval.Monthly.WEEK_FIRST, RecurringInterval.Monthly.WEEK_SECOND, RecurringInterval.Monthly.WEEK_THIRD, RecurringInterval.Monthly.WEEK_FOURTH, RecurringInterval.Monthly.WEEK_LAST

getWeekdayBased

public boolean getWeekdayBased()

Returns true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.

setWeekdayBased

public void setWeekdayBased(boolean weekdayBased_)

Set tp true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.

getMonth

public java.lang.Integer getMonth()

Gets the month of the year on which Yearly event occurs. Jan = 0, Feb = 1 ..... Dec = 11

setMonth

public void setMonth(java.lang.Integer month_)

Set the month of the year on which Yearly event occurs.

Parameters:

month_ - integer representing month of the year: Jan = 0, Feb = 1 -- Dec = 11

getDayOfMonthExpr

public java.lang.String getDayOfMonthExpr()

Gets the day of the month on which the event occurs

Returns:

an expression resolving to a number (integer) between 1 and 31

setDayOfMonthExpr

public void setDayOfMonthExpr(java.lang.String dayOfMonthExpr_)

Sets the day of the month on which the event occurs

Parameters:

dayOfMonth_ - an expression resolving to a number (integer) between 1 and 31