net.rim.blackberry.api.pim
Interface EventList

All Superinterfaces:
PIMList

Deprecated. In favour of EventList.

public interface EventList
extends PIMList

Represents an EventList. An EventList contains PIM Event objects.

The EventList object defines that fields that are valid for a given Event. If an Event that contains fields that are not supported, is added to an EventList, the fields will be discarded. The PIMList.isSupportedField(int) is invoked to determine if a field (as specified by the integer argument) is supported by an EventList. Similarly, the PIMList.getSupportedAttributes(int) method is invoked to return an integer array representing all fields supported by the list.

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.

Since:
JDE 3.6.0
See Also:
PIMItem, Event

Field Summary
static int ENDING
          Deprecated. Represents a search type for Events based on the occurrence's specific end date/time.
static int OCCURRING
          Deprecated. Represents a search type for Events based on any occurrence of an event during a given period of time.
static int STARTING
          Deprecated. Represents a search type for Events based on the event occurrence's specific start date/time.
 
Fields inherited from interface net.rim.blackberry.api.pim.PIMList
UNCATEGORIZED
 
Method Summary
 Event createEvent()
          Deprecated. Creates a new Event instance.
 int[] getSupportedRepeatRuleFields(int frequency)
          Deprecated.  
 int[] getSupportedRepeatRuleFrequencies()
          Deprecated.  
 Event importEvent(Event element)
          Deprecated. Imports an Event into the list using a given, predefined Event object.
 Enumeration items(int searchType, long startDate, long endDate, boolean initialEventOnly)
          Deprecated. Returns an enumeration of all events in the EventList ordered by start date inclusive.
 void removeEvent(Event element)
          Deprecated. Removes an Event from the list.
 
Methods inherited from interface net.rim.blackberry.api.pim.PIMList
addCategory, close, deleteCategory, getArrayElementLabel, getAttributeLabel, getCategories, getFieldDataType, getFieldLabel, getName, getSupportedArrayElements, getSupportedAttributes, getSupportedFields, isCategory, isSupportedArrayElement, isSupportedAttribute, isSupportedField, items, items, items, itemsByCategory, maxCategories, maxValues, renameCategory, stringArraySize
 

Field Detail

STARTING

public static final int STARTING
Deprecated. 
Represents a search type for Events based on the event occurrence's specific start date/time.
Since:
JDE 3.6.0

ENDING

public static final int ENDING
Deprecated. 
Represents a search type for Events based on the occurrence's specific end date/time.
Since:
JDE 3.6.0

OCCURRING

public static final int OCCURRING
Deprecated. 
Represents a search type for Events based on any occurrence of an event during a given period of time.
Since:
JDE 3.6.0
Method Detail

createEvent

public Event createEvent()
Deprecated. 
Creates a new Event instance.

The new Event object is created initially empty and contains fields for all attributes that are supported by the list.

The Event object is not added to the EventList upon creation. The method PIMItem.commit() must be invoked in order to add the Event to the list.

Returns:
The new event object.
Since:
JDE 3.6.0

importEvent

public Event importEvent(Event element)
Deprecated. 
Imports an Event into the list using a given, predefined Event object.

The Event is created using as much of the existing information as possible. If a field in the existing Event object is not supported by the EventList, the field is not included in the Event. If the specified Event is already in the list, a new Event is created with similar information.

The Event object is not added to the EventList upon creation. The method PIMItem.commit() must be invoked in order to add the Event to the list.

Parameters:
element - The Event object to import data from.
Returns:
The Event object to add to the list.
Since:
JDE 4.0.2

removeEvent

public void removeEvent(Event element)
                 throws PIMException
Deprecated. 
Removes an Event from the list.

Parameters:
element - The Event to be removed from the list.
Throws:
PIMException - Thrown if an error occurs, or if the Event cannot be found in the list.
Since:
JDE 4.0.2

items

public Enumeration items(int searchType,
                         long startDate,
                         long endDate,
                         boolean initialEventOnly)
                  throws PIMException
Deprecated. 
Returns an enumeration of all events in the EventList ordered by start date inclusive.

Parameters:
searchtype - Determines which events are returned. One of STARTING, ENDING, OCCURRING.
startDate - The start date of the events to return (in long MS form).
endDate - The end date of the events to return (in long MS form).
initialEventOnly - true indicates that the search will include only the initial event. false indicates that recurrences of the event will also be calculated.
Returns:
An enumeration containing the events from start date to end date.
Throws:
PIMException - Thrown if an error occurs, the list is no longer accesible, or the operation is unsupported.
Since:
JDE 4.0.2

getSupportedRepeatRuleFields

public int[] getSupportedRepeatRuleFields(int frequency)
                                   throws IllegalArgumentException
Deprecated. 
Since:
JDE 4.0.2

getSupportedRepeatRuleFrequencies

public int[] getSupportedRepeatRuleFrequencies()
Deprecated. 
Since:
JDE 3.7.0


Copyright 1999-2004 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.