/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Mobility Components.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QCONTACTABSTRACTREQUEST_H

#define QCONTACTABSTRACTREQUEST_H

#include "qcontactmanager.h"

#include <QObject>

QTM_BEGIN_NAMESPACE

class QContactManagerEngine;

class QContactAbstractRequestPrivate;

class Q_CONTACTS_EXPORT QContactAbstractRequest : public QObject

{

    Q_OBJECT

public:

    QContactAbstractRequest() {}

    virtual ~QContactAbstractRequest();

    QList<QContactManager::Error> Q_DECL_DEPRECATED errors() const; // deprecated, removed in week 3.  see leaf classes for detailed error reporting.

    enum State {

        InactiveState = 0,   // operation not yet started

        ActiveState,         // operation started, not yet finished

        CanceledState,       // operation is finished due to cancellation

        FinishedState        // operation either completed successfully or failed.  No further results will become available.

    };

    State state() const; // replaces status()

    bool isInactive() const;

    bool isActive() const;

    bool isFinished() const;

    bool isCanceled() const;

    QContactManager::Error error() const;

    enum RequestType {

        InvalidRequest = 0,

        ContactFetchRequest,

        ContactLocalIdFetchRequest,

        ContactRemoveRequest,

        ContactSaveRequest,

        DetailDefinitionFetchRequest,

        DetailDefinitionRemoveRequest,

        DetailDefinitionSaveRequest,

        RelationshipFetchRequest,

        RelationshipRemoveRequest,

        RelationshipSaveRequest

    };

    RequestType type() const;

    /* Which manager we want to perform the asynchronous request */

    QContactManager* manager() const;

    void setManager(QContactManager* manager);

public Q_SLOTS:

    /* Verbs */

    bool start();

    bool cancel();

    /* waiting for stuff */

    bool waitForFinished(int msecs = 0);

Q_SIGNALS:

    void stateChanged(QContactAbstractRequest::State newState);

    void resultsAvailable();

protected:

    QContactAbstractRequest(QContactAbstractRequestPrivate* otherd);

    QContactAbstractRequestPrivate* d_ptr;

private:

    Q_DISABLE_COPY(QContactAbstractRequest)

    friend class QContactManagerEngine;

};

QTM_END_NAMESPACE

#endif