calendar/base/public/calIWeekInfoService.idl
author Gervase Markham <gerv@gerv.net>
Wed, 30 May 2012 17:48:24 +0100
changeset 12286 84ac3c71109811da751f0ef2d72108075938f094
parent 372 7c0bfdcda6731e77303f3c47b01736aaa93d5534
child 34762 c537c44e9aa8d077f3703fba7ece37a94bf7c3b5
permissions -rw-r--r--
Bug 757018 - upgrade license to MPL 2.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface calIDateTime;

/**
 * This interface will calculate a week title from a given datetime. This
 * will depends on the users preferences. 
 * Extensions might override the default implementation, in order to
 * generate week titles aimed at special cases (like weeknumbers for a
 * schoolyear)
 */
[scriptable, uuid(650fd33b-ebf4-46fa-b9ca-dd80b2451498)]
interface calIWeekInfoService: nsISupports
{
    /**
     * Return the week title. It's meant to be displayed.
     * (Usually, will return a weeknumber, but might return a string like Q1W4)
     *
     * @param dateTime
     *            The dateTime to get the weektitle for
     * @returns
     *            A string, representing the week title. Will usually be the
     *            week number. Every week (7 days) should get a different string,
     *            but the switch from one week to the next isn't necessarily
     *            on sunday.
     */
    AString getWeekTitle(in calIDateTime dateTime);

    /**
     * Gets the first day of a week of a passed day under consideration 
     * of the preference setting "calendar.week.start"
     *
     * @param aDate     The dateTime to get get the start of the week for
     * @return          A dateTime-object denoting the first day of the week
     */
    calIDateTime getStartOfWeek(in calIDateTime dateTime);

    /**
     * Gets the last day of a week of a passed day under consideration
     * of the preference setting "calendar.week.start"
     *
     * @param aDate     The dateTime to get get the last day of the week for
     * @return          A dateTime-object denoting the last day of the week
     */
    calIDateTime getEndOfWeek(in calIDateTime dateTime);
};