calendar/base/public/calIRelation.idl
author Gervase Markham <gerv@gerv.net>
Wed, 30 May 2012 17:48:24 +0100
changeset 12286 84ac3c71109811da751f0ef2d72108075938f094
parent 3010 bab2dcc9b4dee6b3ee80dbda90bbae0433c76ba9
child 13660 e552b849d52747201cdd39bd68447722635c19bd
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 calIIcalProperty;
interface calIItemBase;

[scriptable,uuid(44a4eda2-539e-11de-a9ee-cc1556d89593)]
interface calIRelation : nsISupports
{
    /**
     * The type of the relation between the items:
     * PARENT
     * CHILD
     * SIBLING
     */
    attribute AUTF8String relType;

    /**
     * The id of the related item
     **/

    attribute AUTF8String relId;

    /**
     * The calIIcalProperty corresponding to this object.  Can be used for
     * serializing/unserializing from ics files.
     */

    attribute calIIcalProperty icalProperty;

    /**
     * For accessing additional parameters, such as x-params.
     */
    AUTF8String getParameter(in AString name);
    void setParameter(in AString name, in AUTF8String value);
    void deleteParameter(in AString name);

    /**
     * Clone this calIRelation instance into a new object.
     */
    calIRelation clone();
};