pjs/calendar/base/public/calIOperation.idl

80 строки
2.9 KiB
Plaintext
Executable File

/* ***** 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 Sun Microsystems code.
*
* The Initial Developer of the Original Code is
* Sun Microsystems, Inc.
* Portions created by the Initial Developer are Copyright (C) 2007
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Daniel Boelzle <daniel.boelzle@sun.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 "nsIVariant.idl"
[scriptable, uuid(B96C2997-7AAA-4619-AD48-B7EBD9236C93)]
interface calIOperation : nsISupports
{
/**
* Id for easy management of pending requests.
*/
readonly attribute AUTF8String id;
/**
* Determines whether the request is pending, i.e. has not been completed.
*/
readonly attribute boolean isPending;
/**
* Status of the request, e.g. NS_OK while pending or after successful
* completion, or NS_ERROR_FAILED when failed.
*/
readonly attribute nsIVariant status;
/**
* Cancels a pending request and changes status.
* @param aStatus operation status to be set;
* defaults to calIErrors.OPERATION_CANCELLED if null
*/
void cancel(in nsIVariant aStatus);
};
[scriptable, uuid(1FA39726-63D2-440c-A464-296D2822B9DA)]
interface calIGenericOperationListener : nsISupports
{
/**
* Generic callback receiving result.
* Results may appear in multiple calls, i.e. callees have to collect
* until isPending is false.
*
* @param aOperation operation object
* @param aResult result or null in case of an error
*/
void onResult(in calIOperation aOperation, in nsIVariant aResult);
};