297827 - need calIDuration

Status: RESOLVED FIXED

(Calendar :: Internal Components, defect)

Description

[Stuart Parmenter]

We need a calIDuration for expressing things that aren't really dates.  We also
need them for alarms which need to be able to express ical duration strings...

Comment 1

[Stuart Parmenter]

Attachment: patch to add calIDuration and to start using it

Comment 2

[Stuart Parmenter]

in calEvent.js's duration getter it should be:
  |return this.endDate.subtract(this.startDate);|
instead of whats in the patch

Comment 3

[Mike Shaver (:shaver emeritus)]

Comment on attachment 186392 [details] [diff] [review]
patch to add calIDuration and to start using it

>+  // Subtract two dates and return a duration
>+  calIDuration subtractDate (in calIDateTime aOtherDate);

It's not clear from this name or comment which way the subtraction
happens.  How would you feel about

// Compute the time from this dateTime to otherDT and return it as
// a calIDuration.  The duration will be negative if otherDT is
// before this.
calIDuration durationUntil(in calIDateTime otherDT);

?

>+  /**
>+   * This object as either an iCalendar DURATION string
>+   */
>+  readonly attribute ACString icalString;
>+};

...an iCalendar DURATION string or...?


>+    nsCOMPtr<calIDuration> result(do_CreateInstance("@mozilla.org/calendar/duration;1"));

OOM check?  (You could also just call |new| here, since it's a closed system,
if you wanted.)

r=shaver

Comment 4

[Stuart Parmenter]

Attachment: Updated with shaver's comments and new functions

I added the comments/oom checks you suggested shaver.  I left the method as
subtractDate but commented it better.

I also added an addDuration method on calIDuration that would add two durations
together and normalize the result.  I've also added a normalize function to the
interface just incase anyone wants it.

I added an attribute |inSeconds| that you can get/set the duration in seconds
with.

Someone should check my math in SetInSeconds() to make sure its right as well.

Comment 5

[Vladimir Vukicevic [:vlad] [:vladv] (needinfo me, slow to respond)]

Comment on attachment 186407 [details] [diff] [review]
Updated with shaver's comments and new functions

r=me, go go go

Comment 6

[Mike Shaver (:shaver emeritus)]

Comment on attachment 186407 [details] [diff] [review]
Updated with shaver's comments and new functions

2r=shaver, thx