|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--javax.microedition.pim.RepeatRule
Contains the repeating rule functionality for event items. The
RepeatRule class defines when and how often an event is
repeated, for example, yearly, monthly or daily.
You can use the RepeatRule object to create a recurring event by allowing you
to specify a recurrence pattern for the event. The RepeatRule
allows you to specify the frequency, interval and number of
recurrences for each event.
Below, a RepeatRule is created and associated with a new
event. The event will repeat on the 28th day of every month.
For more information about this class or about the personal information management (PIM) API, refer to
The PDA Profile specification (JSR-000075) for the J2ME(TM) Platform.
RepeatRule recurring = new RepeatRule();
recurring.setInt(RepeatRule.FREQUENCY, RepeatRule.MONTHLY);
recurring.setInt(RepeatRule.DAY_IN_MONTH, 28);
events = EventList.open(EventList.READ_WRITE);
Event event = events.createEvent();
event.setRepeat(recurring);
Event,
EventList| Field Summary | ||
static int |
APRIL
Represents the constant for the month: April. |
|
static int |
AUGUST
Represents the constant for the month: August. |
|
static int |
COUNT
Represents the number of times the event will occur. |
|
static int |
DAILY
Indicates that the frequency of the event occurs daily. |
|
static int |
DAY_IN_MONTH
Represents the day in the month that this event will occur. |
|
static int |
DAY_IN_WEEK
Represents the day in the week that this event will occur. |
|
static int |
DAY_IN_YEAR
Represents the day in the year that this event will occur. |
|
static int |
DECEMBER
Represents the constant for the month: December. |
|
static int |
END
Represents the end date of an event. |
|
static int |
FEBRUARY
Represents the constant for the month: February. |
|
static int |
FIFTH
Represents the fifth week of the month. |
|
static int |
FIFTHLAST
Represents the fifth last week of the month. |
|
static int |
FIRST
Represents the first week of the month. |
|
static int |
FOURTH
Represents the fourth week of the month. |
|
static int |
FOURTHLAST
Represents the fourth last week of the month. |
|
static int |
FREQUENCY
Represents the frequency of the event. |
|
static int |
FRIDAY
Represents the constant for the day: Friday. |
|
static int |
INTERVAL
The interval represents the amount of time between events, or the number of times the frequency repeats between events. |
|
static int |
JANUARY
Represents the constant for the month: January. |
|
static int |
JULY
Represents the constant for the month: July. |
|
static int |
JUNE
Represents the constant for the month: June. |
|
static int |
LAST
Represents the last week of the month. |
|
static int |
MARCH
Represents the constant for the month: March. |
|
static int |
MAY
Represents the constant for the month: May. |
|
static int |
MONDAY
Represents the constant for the day: Monday. |
|
static int |
MONTH_IN_YEAR
Represents the month in the year that this event will occur. |
|
static int |
MONTHLY
Indicates that the frequency of the event occurs monthly. |
|
static int |
NOVEMBER
Represents the constant for the month: November. |
|
static int |
OCTOBER
Represents the constant for the month: October. |
|
static int |
SATURDAY
Represents the constant for the day: Saturday. |
|
static int |
SECOND
Represents the second week of the month. |
|
static int |
SECONDLAST
Represents the second last week of the month. |
|
static int |
SEPTEMBER
Represents the constant for the month: September. |
|
static int |
SUNDAY
Represents the constant for the day: Sunday. |
|
static int |
THIRD
Represents the third week of the month. |
|
static int |
THIRDLAST
Represents the third last week of the month. |
|
static int |
THURSDAY
Represents the constant for the day: Thursday. |
|
static int |
TUESDAY
Represents the constant for the day: Tuesday. |
|
static int |
WEDNESDAY
Represents the constant for the day: Wednesday. |
|
static int |
WEEK_IN_MONTH
Represents the week in the month that this event will occur. |
|
static int |
WEEKLY
Indicates that the frequency of the event occurs weekly. |
|
static int |
YEARLY
Indicates that the frequency of the event occurs yearly. |
|
| Constructor Summary | ||
RepeatRule()
Creates a new RepeatRule instance. |
||
| Method Summary | ||
void |
addExceptDate(long date)
Adds a date for which the event will not occur. |
|
Enumeration |
dates(long startDate,
long subsetBeginning,
long subsetEnding)
Returns an enumeration of event dates, ordered by date, between the specified subsetBeginning and subsetEnding parameters. |
|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
|
long |
getDate(int field)
Returns the date of the specified field. |
|
Enumeration |
getExceptDates()
Returns an Enumeration of dates for which this RepeatRule should not occur, with the Enumeration containing java.util.Date instances. |
|
int[] |
getFields()
Returns an array of integers representing the fields in the RepeatRule. |
|
int |
getInt(int field)
Returns an integer representing a RepeatRule field value. |
|
void |
removeExceptDate(long date)
Removes an excepted date from the RepeatRule. |
|
void |
setDate(int field,
long value)
Sets a date for the specified field. |
|
void |
setInt(int field,
int value)
Sets an integer that specifies a RepeatRule field and value. |
|
| Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int AUGUST
public static final int COUNT
This value is determined using Event.START and RepeatRule.END
public static final int DAILY
public static final int DAY_IN_MONTH
This index is 1-based. In other words, the value 15 represents the 15th day of the month.
public static final int DAY_IN_WEEK
This index is 1-based. In other words, the value 2 represents the 2nd day of the week. Values can be OR'd together to indicate a multple day event.
public static final int DAY_IN_YEAR
This index is 1-based. In other words, the value 200 represents the 200th day of the month.
public static final int DECEMBER
public static final int FEBRUARY
public static final int FIFTHLAST
public static final int FOURTHLAST
public static final int FREQUENCY
This value can be YEARLY, MONTHLY,
WEEKLY, DAILY.
public static final int INTERVAL
public static final int JANUARY
public static final int MONTH_IN_YEAR
This index is 1-based. In other words, the value 6 represents the 6th month of the year. Values can be OR'd together to set multple months.
public static final int MONTHLY
public static final int NOVEMBER
public static final int OCTOBER
public static final int SATURDAY
public static final int SECONDLAST
public static final int SEPTEMBER
public static final int THIRDLAST
public static final int THURSDAY
public static final int TUESDAY
public static final int WEDNESDAY
public static final int WEEK_IN_MONTH
This index is 1-based. In other words, the value 2 represents the 2nd week of the month. Values can be OR'd together to set multple weeks.
public static final int WEEKLY
public static final int YEARLY
| Constructor Detail |
| Method Detail |
public void addExceptDate(long date)
date - The date to remove from the list of except dates expressed in the same long value format as
java.util.Date, which is milliseconds since the epoch (00:00:00 GMT, January 1, 1970).public Enumeration dates(long startDate, long subsetBeginning, long subsetEnding)
subsetBeginning and subsetEnding parameters.
Excepted dates (as excepted by the addExceptDate(long)
method), are events which will not occur.
startDate - The start date for which to begin.subsetBeginning - The starting date for which to return event dates.subsetEnding - The ending date for which to return end dates. The
value null specifies that no more events occur.public boolean equals(Object obj)
Object
The equals method implements an equivalence relation:
x,
x.equals(x) should return true.
x and
y, x.equals(y) should return
true if and only if y.equals(x) returns
true.
x,
y, and z, if x.equals(y)
returns true and y.equals(z) returns
true, then x.equals(z) should return
true.
x
and y, multiple invocations of x.equals(y)
consistently return true or consistently return
false, provided no information used in
equals comparisons on the object is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any reference values x and y,
this method returns true if and only if x and
y refer to the same object (x==y has the
value true).
Objectobj - the reference object with which to compare.true if this object is the same as the obj
argument; false otherwise.Boolean.hashCode(),
Hashtablepublic long getDate(int field)
The field value is currently limited to END.
field - The field for which to return the date value.IllegalArgumentException - Thrown if the field is not one of the
the valid RepeatRule fields for this method, or if the value is not a valid value for field.public Enumeration getExceptDates()
Returns an Enumeration of dates for which this
RepeatRule should not occur, with the Enumeration containing
java.util.Date instances.
java.util.Date.public int[] getFields()
RepeatRule.
public int getInt(int field)
RepeatRule field value.
The value can be one of the following: COUNT, DAYNUMBER, FREQUENCY,
INTERVAL, MONTH_IN_YEAR, WEEK_IN_MONTH, DAY_IN_WEEK, DAY_IN_YEAR.
field - The field for which to return the integer value.IllegalArgumentException - Thrown if the specifed field
is not valid.public void removeExceptDate(long date)
RepeatRule.
date - The date to remove from the list of except dates expressed in the same long value format as
java.util.Date, which is milliseconds since the epoch (00:00:00 GMT, January 1, 1970).
public void setDate(int field,
long value)
The field value is currently limited to END.
field - The field for which to set the date.value - The long value to set the date to.IllegalArgumentException - Thrown if the field is not one of the
the valid RepeatRule fields for this method, or if the value is not a valid value for field.
public void setInt(int field,
int value)
RepeatRule field and value.
field - An integer represnting the field to set.value - An integer representing the value to set. Setting the field
to null clears it.IllegalArgumentException - Thrown if field is not one of the the
valid RepeatRule fields for this method, or if value is not a valid value for field
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2008 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.