net.rim.blackberry.api.pdap
Interface BlackBerryEvent

All Superinterfaces:
Event, PIMItem

public interface BlackBerryEvent
extends Event

Represents an event contained in the default RIM BlackBerry calendar.

This interface defines extended fields in addition to the standard fields that are used to reference fields with the BlackBerry Event.

You can use any of the static field constants defined here in your code on any valid BlackBerryEvent instance.

Setting the NOTE field to the empty string "" is equivalent to removing any value from the field.

When the ALLDAY field is set to true, both the START and END dates are moved to midnight GMT on the day they were set. Additionally, when a START or END date is added to an all day BlackBerryEvent, the date value will automatically be moved back to midnight GMT on the same day. To create a multi-day all day event, set the END parameter to midnight after the final day that is to be included in the appointment.

BlackBerryEvent objects do not support the REVISION Event field.

See Also:
Event, PIMItem
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

Field Summary
Category: Signed static int ALLDAY
          Indicates whether or not an event is an all day event.
Category: Signed static int ATTENDEES
          A list of e-mail addresses identifying attendees at an Event.
Category: Signed static int FB_BUSY
          Constant indicating this event's duration is shown as busy.
Category: Signed static int FB_FREE
          Constant indicating this event's duration is shown as free.
Category: Signed static int FB_OUT_OF_OFFICE
          Constant indicating this event's duration is shown as out of the office.
Category: Signed static int FB_TENTATIVE
          Constant indicating this event's duration is shown as tentative.
Category: Signed static int FREE_BUSY
          Indicates whether to show an event as Free, Tentative, Busy or Out Of The Office.
 
Fields inherited from interface javax.microedition.pim.Event
ALARM, CLASS, CLASS_CONFIDENTIAL, CLASS_PRIVATE, CLASS_PUBLIC, END, LOCATION, NOTE, REVISION, START, SUMMARY, UID
 
Fields inherited from interface javax.microedition.pim.PIMItem
ATTR_NONE, BINARY, BOOLEAN, DATE, EXTENDED_ATTRIBUTE_MIN_VALUE, EXTENDED_FIELD_MIN_VALUE, INT, STRING, STRING_ARRAY
 
Method Summary
 
Methods inherited from interface javax.microedition.pim.Event
getRepeat, setRepeat
 
Methods inherited from interface javax.microedition.pim.PIMItem
addBinary, addBoolean, addDate, addInt, addString, addStringArray, addToCategory, commit, countValues, getAttributes, getBinary, getBoolean, getCategories, getDate, getFields, getInt, getPIMList, getString, getStringArray, isModified, maxCategories, removeFromCategory, removeValue, setBinary, setBoolean, setDate, setInt, setString, setStringArray
 



Field Detail

ATTENDEES

static final int ATTENDEES
A list of e-mail addresses identifying attendees at an Event.

This field is of type String and can contain multiple values.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

ALLDAY

static final int ALLDAY
Indicates whether or not an event is an all day event. This field is of type PIMItem.BOOLEAN and has a maximum of 1 value. Setting this field to true changes this event to an all day event, and setting it to false make it NOT an all day event. If this field is not set or the value is removed then it is changed to NOT an all day event.

Note that all day events can span multiple days. The start date will be 00:00:00.000 on the day that the event begins. The end date will be 00:00:00.000 on the day after the event ends. This way the difference between the start date and the end date will be the number of days (in milliseconds) of the duration of the event. Also, applications that do not wish to use BlackBerryEvent but instead use only javax.microedition.pim.Event will determine the correct duration of all day events.

For example, suppose an all day event begins on April 01, 2008 and ends April 9, 2008, inclusive. Then the start date will be 1207022400000 and the end date will be 1207800000000. The difference between these numbers is 777600000, which is the number of milliseconds in 9 days, the number of days that the all day event spans.

The start and end dates of all day events are retrieved as usual, using the getDate() specifying Event.START or Event.END for the field, respectively.

When an event's boolean ALLDAY field is set then the addDate() and setDate() methods behave in a special way for the fields Event.START and Event.END: the date is rounded down to 00:00:00.000.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

FREE_BUSY

static final int FREE_BUSY
Indicates whether to show an event as Free, Tentative, Busy or Out Of The Office.

This field is of type int. If the field is not populated then the event will be shown as Busy.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

FB_FREE

static final int FB_FREE
Constant indicating this event's duration is shown as free.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

FB_TENTATIVE

static final int FB_TENTATIVE
Constant indicating this event's duration is shown as tentative.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

FB_BUSY

static final int FB_BUSY
Constant indicating this event's duration is shown as busy.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

FB_OUT_OF_OFFICE

static final int FB_OUT_OF_OFFICE
Constant indicating this event's duration is shown as out of the office.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.