gecko-dev/calendar/base/public/calIRecurrenceRule.idl

/* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Oracle Corporation code.
 *
 * The Initial Developer of the Original Code is
 *  Oracle Corporation
 * Portions created by the Initial Developer are Copyright (C) 2004
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

#include "calIRecurrenceItem.idl"

interface calIItemBase;
interface calIDateTime;

// an interface implementing a RRULE

[scriptable, uuid(c8a953ac-0864-4128-ab3f-b5ba8473fa53)]
interface calIRecurrenceRule : calIRecurrenceItem
{
  //
  // rule-based recurrence
  //

  // null/"", "SECONDLY", "MINUTELY", "HOURLY", "DAILY", "WEEKLY",
  // "MONTHLY", "YEARLY"
  attribute AUTF8String type;

  // repeat every N of type
  attribute long interval;

  // These two are mutually exclusive; whichever is set
  // invalidates the other.  It's only valid to read the one
  // that was set; the other will throw NS_ERROR_FAILURE.  Use
  // isByCount to figure out whether count or endDate is valid.
  // Setting count to -1 or endDate to null indicates infinite
  // recurrence.
  attribute long count;
  attribute calIDateTime endDate;

  // if this isn't infinite recurrence, this flag indicates whether
  // it was set by count or not
  readonly attribute boolean isByCount;

  // the components defining the recurrence
  // "BYSECOND", "BYMINUTE", "BYHOUR", "BYDAY",
  // "BYMONTHDAY", "BYYEARDAY", "BYWEEKNO", "BYMONTH",
  // "BYSETPOS"
  void getComponent (in AUTF8String aComponentType,
                     out unsigned long aCount, [array,size_is(aCount),retval] out short aValues);
  void setComponent (in AUTF8String aComponentType,
                     in unsigned long aCount, [array,size_is(aCount)] in short aValues);

};