net.rim.blackberry.api.pdap
Interface BlackBerryEventList

All Superinterfaces:
EventList, PIMList, BlackBerryPIMList

public interface BlackBerryEventList
extends EventList, BlackBerryPIMList

Contains the functionality for the BlackBerry-specific implementation of an EventList.

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.6.0

Field Summary
 
Fields inherited from interface javax.microedition.pim.EventList
ENDING, OCCURRING, STARTING
 
Fields inherited from interface javax.microedition.pim.PIMList
UNCATEGORIZED
 
Fields inherited from interface javax.microedition.pim.PIMList
UNCATEGORIZED
 
Method Summary
Category: Signed  BlackBerryEvent getByUID(String uid)
          Finds an event by its UID.
Category: Signed  void removeEvent(Event element, int flags)
          Removes an event.
 
Methods inherited from interface javax.microedition.pim.EventList
createEvent, getSupportedRepeatRuleFields, importEvent, items, removeEvent
 
Methods inherited from interface javax.microedition.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
 
Methods inherited from interface net.rim.blackberry.api.pdap.BlackBerryPIMList
addListener, getPIMListUID, isFieldLabelSettable, isWirelessSyncCapable, isWirelessSyncEnabled, removeListener, setFieldLabel, size
 
Methods inherited from interface javax.microedition.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
 



Method Detail

getByUID

BlackBerryEvent getByUID(String uid)
                         throws PIMException
Finds an event by its UID.

Parameters:
uid - the UID for which to search; may be null, in which case this method will behave as if the UID was not found.
Returns:
If an event with the specified UID is found in this list then its BlackBerryEvent object is returned; otherwise, if not found, returns null.
Throws:
PIMException - if an error occurs searching (eg. list is closed).
SecurityException - if the list was opened in a mode that does not allow reading.
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.6.0

removeEvent

void removeEvent(Event element,
                 int flags)
                 throws PIMException
Removes an event.

Parameters:
element - The event to be removed from the list.
flags - Option flags. A bitwise combination of flags that affect the event removal. Currently, the only supported flag is BlackBerryEvent.DO_NOT_NOTIFY_ATTENDEES.
Throws:
PIMException - thrown if an error occurs deleting the item or the list is no longer accessible or closed.
IllegalArgumentException - thrown if the event is null.
SecurityException - thrown if the application is not given permission to write to the event list.
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 6.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal