com.aspose.email
Class ByDay

java.lang.Object
  extended by com.aspose.email.ByDay

public class ByDay
extends Object

Represents Nth occurrence (or all occurrences) of the specified day of the week.


<p>Corresponds to one day of the week specified in the BYDAY part of a recurrence rule.</p> <p>Can be used in a monthly or yearly recurrence rule to specify Nth occurrence (or all occurrences) of the specified day of the week in a month or year.</p> <p>BYDAY=MO represents all Mondays of the month or year. To represent all occurrences, set NthOccurrence to 0.</p> <p>BYDAY=2MO represents 2nd Monday in a month or year.</p> <p>BYDAY=-1MO represents the last Monday of a month or year.</p>

See Also:
ByDayCollection

Constructor Summary
ByDay(int dayOfWeek)
           Initializes a new instance of ByDay class.
ByDay(int nthOccurrence, int dayOfWeek)
           Initializes a new instance of ByDay class.
 
Method Summary
 boolean equals(ByDay other)
           
 boolean equals(Object obj)
           
 int getDayOfWeek()
           Gets or sets the day of the week.
 int getNthOccurrence()
           Gets or sets the nth occurrence of the day of the week.
 int hashCode()
           
 boolean isAllOccurrences()
           Returns True when NthOccurrence is zero (meaning all occurrences of this day of week).
 void setDayOfWeek(int value)
           
 void setNthOccurrence(int value)
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ByDay

public ByDay(int dayOfWeek)

Initializes a new instance of ByDay class.

Parameters:
dayOfWeek - A day of the week.

ByDay

public ByDay(int nthOccurrence,
             int dayOfWeek)

Initializes a new instance of ByDay class.

Parameters:
nthOccurrence - The nth occurrence of the day of the week.
dayOfWeek - A day of the week.
Method Detail

getNthOccurrence

public int getNthOccurrence()

Gets or sets the nth occurrence of the day of the week.


<p>Valid range for this property is from -53 to 53.</p> <p>Positive values represent Nth occurrence from the beginning of the period, for example NthOccurrence = 1, represents 1st occurrence of the day of the week.</p> <p>Negative values represent Nth occurrence from the end of the period, for example NthOccurrence = -1, represents last occurrence of the day of the week.</p> <p>When NthOccurrence is zero, it represents all occurrences of the specified day of the week. For example, BYDAY=MO has NthOccurrence zero and represents all Mondays in the set.</p>


setNthOccurrence

public void setNthOccurrence(int value)

getDayOfWeek

public int getDayOfWeek()

Gets or sets the day of the week.


setDayOfWeek

public void setDayOfWeek(int value)

isAllOccurrences

public boolean isAllOccurrences()

Returns True when NthOccurrence is zero (meaning all occurrences of this day of week).


equals

public boolean equals(ByDay other)

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright (c) 2002-2011 Aspose Pty Ltd. All Rights Reserved.