qtmobility/src/contacts/qcontactabstractrequest.cpp
changeset 1 2b40d63a9c3d
child 4 90517678cc4f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qtmobility/src/contacts/qcontactabstractrequest.cpp	Fri Apr 16 15:51:22 2010 +0300
@@ -0,0 +1,261 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+#include "qcontactabstractrequest.h"
+#include "qcontactabstractrequest_p.h"
+#include "qcontactmanager.h"
+#include "qcontactmanager_p.h"
+#include "qcontactmanagerengine.h"
+
+
+QTM_BEGIN_NAMESPACE
+/*!
+  \class QContactAbstractRequest
+
+  \brief The QContactAbstractRequest class provides a mechanism for
+  asynchronous requests to be made of a manager if it supports them.
+
+  \ingroup contacts-main
+
+  It allows a client to asynchronously request some functionality of a
+  particular QContactManager.
+ */
+
+/*!
+  \fn QContactAbstractRequest::stateChanged(QContactAbstractRequest::State newState)
+  This signal is emitted when the state of the request is changed.  The new state of
+  the request will be contained in \a newState.
+ */
+
+
+/*!
+  \fn QContactAbstractRequest::resultsAvailable()
+  This signal is emitted when new results are available.  Results can include
+  the operation error which may be accessed via error(), or derived-class-specific
+  results which are accessible through the derived class API.
+
+  \sa error()
+ */
+
+/*!
+  \enum QContactAbstractRequest::RequestType
+  Enumerates the various possible types of asynchronous requests
+  \value InvalidRequest An invalid request
+  \value ContactFetchRequest A request to fetch a list of contacts
+  \value ContactLocalIdFetchRequest A request to fetch a list of local contact ids
+  \value ContactRemoveRequest A request to remove a list of contacts
+  \value ContactSaveRequest A request to save a list of contacts
+  \value DetailDefinitionFetchRequest A request to fetch a collection of detail definitions
+  \value DetailDefinitionRemoveRequest A request to remove a list of detail definitions
+  \value DetailDefinitionSaveRequest A request to save a list of detail definitions
+  \value RelationshipFetchRequest A request to fetch relationships between contacts
+  \value RelationshipRemoveRequest A request to remove any relationships which match the request criteria
+  \value RelationshipSaveRequest A request to save a list of relationships
+ */
+
+/*!
+  \enum QContactAbstractRequest::State
+  Enumerates the various states that a request may be in at any given time
+  \value InactiveState Operation not yet started
+  \value ActiveState Operation started, not yet finished
+  \value CanceledState Operation is finished due to cancellation
+  \value FinishedState Operation successfully completed
+ */
+
+/*!
+  \fn QContactAbstractRequest::QContactAbstractRequest()
+  Constructs a new, invalid asynchronous request
+ */
+
+/*! Constructs a new request from the given request data \a otherd */
+QContactAbstractRequest::QContactAbstractRequest(QContactAbstractRequestPrivate* otherd)
+    : d_ptr(otherd)
+{
+}
+
+/*! Cleans up the memory used by this request */
+QContactAbstractRequest::~QContactAbstractRequest()
+{
+    if (d_ptr) {
+        QContactManagerEngine *engine = QContactManagerData::engine(d_ptr->m_manager);
+        if (engine) {
+            engine->requestDestroyed(this);
+        }
+
+        delete d_ptr;
+    }
+}
+
+/*!
+  Returns true if the request is in the \c QContactAbstractRequest::InactiveState state; otherwise, returns false
+
+  \sa state()
+ */
+bool QContactAbstractRequest::isInactive() const
+{
+    return (d_ptr->m_state == QContactAbstractRequest::InactiveState);
+}
+
+/*!
+  Returns true if the request is in the \c QContactAbstractRequest::ActiveState state; otherwise, returns false
+
+  \sa state()
+ */
+bool QContactAbstractRequest::isActive() const
+{
+    return (d_ptr->m_state == QContactAbstractRequest::ActiveState);
+}
+
+/*!
+  Returns true if the request is in the \c QContactAbstractRequest::FinishedState; otherwise, returns false
+
+  \sa state()
+ */
+bool QContactAbstractRequest::isFinished() const
+{
+    return (d_ptr->m_state == QContactAbstractRequest::FinishedState);
+}
+
+/*!
+  Returns true if the request is in the \c QContactAbstractRequest::CanceledState; otherwise, returns false
+
+  \sa state()
+ */
+bool QContactAbstractRequest::isCanceled() const
+{
+    return (d_ptr->m_state == QContactAbstractRequest::CanceledState);
+}
+
+/*! Returns the overall error of the most recent asynchronous operation */
+QContactManager::Error QContactAbstractRequest::error() const
+{
+    return d_ptr->m_error;
+}
+
+/*!
+  \internal
+  Returns the list of errors which occurred during the most recent asynchronous operation.  Each individual error in the list corresponds to a result in the result list.
+ */
+QList<QContactManager::Error> QContactAbstractRequest::errors() const
+{
+    return QList<QContactManager::Error>();
+}
+
+/*!
+  Returns the type of this asynchronous request
+ */
+QContactAbstractRequest::RequestType QContactAbstractRequest::type() const
+{
+    return d_ptr->type();
+}
+
+/*!
+  Returns the current state of the request.
+ */
+QContactAbstractRequest::State QContactAbstractRequest::state() const
+{
+    return d_ptr->m_state;
+}
+
+/*! Returns a pointer to the manager of which this request instance requests operations */
+QContactManager* QContactAbstractRequest::manager() const
+{
+    return d_ptr->m_manager;
+}
+
+/*! Sets the manager of which this request instance requests operations to \a manager */
+void QContactAbstractRequest::setManager(QContactManager* manager)
+{
+    d_ptr->m_manager = manager;
+}
+
+/*! Attempts to start the request.  Returns false if the request is not in the \c QContactAbstractRequest::Inactive, \c QContactAbstractRequest::Finished or \c QContactAbstractRequest::Cancelled states,
+    or if the request was unable to be performed by the manager engine; otherwise returns true. */
+bool QContactAbstractRequest::start()
+{
+    QContactManagerEngine *engine = QContactManagerData::engine(d_ptr->m_manager);
+    if (engine && (d_ptr->m_state == QContactAbstractRequest::CanceledState
+                   || d_ptr->m_state == QContactAbstractRequest::FinishedState
+                   || d_ptr->m_state == QContactAbstractRequest::InactiveState)) {
+        return engine->startRequest(this);
+    }
+
+    return false; // unable to start operation; another operation already in progress or no engine.
+}
+
+/*! Attempts to cancel the request.  Returns false if the request is not in the \c QContactAbstractRequest::Active state,
+    or if the request is unable to be cancelled by the manager engine; otherwise returns true. */
+bool QContactAbstractRequest::cancel()
+{
+    QContactManagerEngine *engine = QContactManagerData::engine(d_ptr->m_manager);
+    if (engine && state() == QContactAbstractRequest::ActiveState) {
+        return engine->cancelRequest(this);
+    }
+
+    return false; // unable to cancel operation; not in progress or no engine.
+}
+
+/*! Blocks until the request has been completed by the manager engine, or until \a msecs milliseconds has elapsed.
+    If \a msecs is zero, this function will block indefinitely.
+    Returns true if the request was cancelled or completed successfully within the given period, otherwise false.
+    Some backends are unable to support this operation safely, and will return false immediately.
+ */
+bool QContactAbstractRequest::waitForFinished(int msecs)
+{
+    QContactManagerEngine *engine = QContactManagerData::engine(d_ptr->m_manager);
+    if (engine) {
+        switch (d_ptr->m_state) {
+        case QContactAbstractRequest::ActiveState:
+            return engine->waitForRequestFinished(this, msecs);
+        case QContactAbstractRequest::CanceledState:
+        case QContactAbstractRequest::FinishedState:
+            return true;
+        default:
+            return false;
+        }
+    }
+
+    return false; // unable to wait for operation; not in progress or no engine.
+}
+
+#include "moc_qcontactabstractrequest.cpp"
+
+QTM_END_NAMESPACE