Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
calIRecurrenceInfo Interface Reference

import "calIRecurrenceInfo.idl";

Inheritance diagram for calIRecurrenceInfo:
Inheritance graph
[legend]
Collaboration diagram for calIRecurrenceInfo:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void makeImmutable ()
calIRecurrenceInfo clone ()
void onStartDateChange (in calIDateTime aNewStartTime, in calIDateTime aOldStartTime)
 The start date of an item is directly referenced by parts of calIRecurrenceInfo, thus changing the former without adjusting the latter would break the internal structure.
void getRecurrenceItems (out unsigned long aCount,[array, size_is(aCount), retval] out calIRecurrenceItem aItems)
void setRecurrenceItems (in unsigned long aCount,[array, size_is(aCount)] in calIRecurrenceItem aItems)
unsigned long countRecurrenceItems ()
void clearRecurrenceItems ()
void appendRecurrenceItem (in calIRecurrenceItem aItem)
calIRecurrenceItem getRecurrenceItemAt (in unsigned long aIndex)
void deleteRecurrenceItemAt (in unsigned long aIndex)
void deleteRecurrenceItem (in calIRecurrenceItem aItem)
void insertRecurrenceItemAt (in calIRecurrenceItem aItem, in unsigned long aIndex)
void removeOccurrenceAt (in calIDateTime aRecurrenceId)
 This is a shortcut to appending or removing a single negative date assertion.
void restoreOccurrenceAt (in calIDateTime aRecurrenceId)
void modifyException (in calIItemBase anItem, in boolean aTakeOverOwnership)
 Modify an a particular occurrence with the given exception proxy item.
calIItemBase getExceptionFor (in calIDateTime aRecurrenceId, in boolean aCreate)
 Return an existing exception item for the given recurrence ID.
void removeExceptionFor (in calIDateTime aRecurrenceId)
 Removes an exception item for the given recurrence ID, if any exist.
void getExceptionIds (out unsigned long aCount,[array, size_is(aCount), retval] out calIDateTime aIds)
 Returns a list of all recurrence ids that have exceptions.
calIItemBase getOccurrenceFor (in calIDateTime aRecurrenceId)
calIItemBase getNextOccurrence (in calIDateTime aTime)
 Return the chronologically next occurrence after aTime.
calIItemBase getPreviousOccurrence (in calIDateTime aTime)
 Return the chronologically previous occurrence after aTime.
void getOccurrenceDates (in calIDateTime aRangeStart, in calIDateTime aRangeEnd, in unsigned long aMaxCount, out unsigned long aCount,[array, size_is(aCount), retval] out calIDateTime aDates)
 Return an array of calIDateTime representing all start times of this event between start (inclusive) and end (non-inclusive).
void getOccurrences (in calIDateTime aRangeStart, in calIDateTime aRangeEnd, in unsigned long aMaxCount, out unsigned long aCount,[array, size_is(aCount), retval] out calIItemBase aItems)
 Return an array of calIItemBase representing all occurrences of this event between start (inclusive) and end (non-inclusive).

Public Attributes

readonly attribute boolean isMutable
attribute calIItemBase item
readonly attribute boolean isFinite
 isFinite is true if the recurrence items specify a finite number of occurrences.

Detailed Description

Definition at line 49 of file calIRecurrenceInfo.idl.


Member Function Documentation

Return an existing exception item for the given recurrence ID.

If an exception does not exist, and aCreate is set, a new one is created and returned. Otherwise, null is returned.

void calIRecurrenceInfo::getExceptionIds ( out unsigned long  aCount,
[array, size_is(aCount), retval] out calIDateTime  aIds 
)

Returns a list of all recurrence ids that have exceptions.

Return the chronologically next occurrence after aTime.

This takes exceptions and EXDATE/RDATEs into account.

Parameters:
aTimeThe (exclusive) date to start searching.
Returns:
The next occurrence, or null if there is none.
void calIRecurrenceInfo::getOccurrenceDates ( in calIDateTime  aRangeStart,
in calIDateTime  aRangeEnd,
in unsigned long  aMaxCount,
out unsigned long  aCount,
[array, size_is(aCount), retval] out calIDateTime  aDates 
)

Return an array of calIDateTime representing all start times of this event between start (inclusive) and end (non-inclusive).

Exceptions are taken into account.

Parameters:
aRangeStartThe (inclusive) date to start searching.
aRangeEndThe (exclusive) date to end searching.
aMaxCountThe maximum number of dates to return
aCountThe number of dates returned.
Returns:
The array of dates.
void calIRecurrenceInfo::getOccurrences ( in calIDateTime  aRangeStart,
in calIDateTime  aRangeEnd,
in unsigned long  aMaxCount,
out unsigned long  aCount,
[array, size_is(aCount), retval] out calIItemBase  aItems 
)

Return an array of calIItemBase representing all occurrences of this event between start (inclusive) and end (non-inclusive).

Exceptions are taken into account.

Parameters:
aRangeStartThe (inclusive) date to start searching.
aRangeEndThe (exclusive) date to end searching.
aMaxCountThe maximum number of occurrences to return
aCountThe number of occurrences returned.
Returns:
The array of occurrences.

Return the chronologically previous occurrence after aTime.

This takes exceptions and EXDATE/RDATEs into account.

Parameters:
aTimeThe (exclusive) date to start searching.
Returns:
The previous occurrence, or null if there is none.
void calIRecurrenceInfo::getRecurrenceItems ( out unsigned long  aCount,
[array, size_is(aCount), retval] out calIRecurrenceItem  aItems 
)
void calIRecurrenceInfo::modifyException ( in calIItemBase  anItem,
in boolean  aTakeOverOwnership 
)

Modify an a particular occurrence with the given exception proxy item.

If the recurrenceId isn't an already existing exception item, a new exception is added. Otherwise, the existing exception is modified.

The item's parentItem must be equal to this RecurrenceInfo's item. <-- XXX check this, compare by calendar/id only

Parameters:
anItemexceptional/overridden item
aTakeOverOwnershipwhether the recurrence info object can take over the item or needs to clone it
void calIRecurrenceInfo::onStartDateChange ( in calIDateTime  aNewStartTime,
in calIDateTime  aOldStartTime 
)

The start date of an item is directly referenced by parts of calIRecurrenceInfo, thus changing the former without adjusting the latter would break the internal structure.

This method provides the necessary functionality. There's no need to call it manually after writing to the start date of an item, since it's called automatically in the appropriate setter of an item.

Removes an exception item for the given recurrence ID, if any exist.

This is a shortcut to appending or removing a single negative date assertion.

aRecurrenceId needs to be a normal recurrence id, it may not be RDATE.

void calIRecurrenceInfo::setRecurrenceItems ( in unsigned long  aCount,
[array, size_is(aCount)] in calIRecurrenceItem  aItems 
)

Member Data Documentation

isFinite is true if the recurrence items specify a finite number of occurrences.

This is useful for UI and for possibly other users.

Definition at line 96 of file calIRecurrenceInfo.idl.

Definition at line 54 of file calIRecurrenceInfo.idl.

Definition at line 64 of file calIRecurrenceInfo.idl.


The documentation for this interface was generated from the following file: