1 /****************************************************************************

     2 **

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

     4 ** All rights reserved.

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

     6 **

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

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

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

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

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

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

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

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

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

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

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

    23 **

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

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

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

    27 **

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

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

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #include "qcontactremoverequest.h"

    43 #include "qcontactrequests_p.h"

    44 

    45 QTM_BEGIN_NAMESPACE

    46 

    47 /*!

    48   \class QContactRemoveRequest

    49   \brief The QContactRemoveRequest class allows a client to asynchronously

    50     request that certain contacts be removed from a contacts store.

    51 

    52   For a QContactRemoveRequest, the resultsUpdated() signal will be emitted when

    53   the individual item errors (which may be retrieved by calling errorMap()) are updated, or if the overall

    54   operation error (which may be retrieved by calling error()) is updated.

    55 

    56   Please see the class documentation of QContactAbstractRequest for more information about

    57   the usage of request classes and ownership semantics.

    58 

    59   \ingroup contacts-requests

    60  */

    61 

    62 /*! Constructs a new contact remove request whose parent is the specified \a parent */

    63 QContactRemoveRequest::QContactRemoveRequest(QObject* parent)

    64     : QContactAbstractRequest(new QContactRemoveRequestPrivate, parent)

    65 {

    66 }

    67 

    68 /*! Frees any memory used by this request */

    69 QContactRemoveRequest::~QContactRemoveRequest()

    70 {

    71     QContactAbstractRequestPrivate::notifyEngine(this);

    72 }

    73 

    74 /*!

    75   Sets the id of the contact which will be removed to \a contactId.

    76   Equivalent to calling:

    77   \code

    78       setContactIds(QList<QContactLocalId>() << contactIds);

    79   \endcode

    80  */

    81 void QContactRemoveRequest::setContactId(const QContactLocalId& contactId)

    82 {

    83     Q_D(QContactRemoveRequest);

    84     QMutexLocker ml(&d->m_mutex);

    85     d->m_contactIds.clear();

    86     d->m_contactIds.append(contactId);

    87 }

    88 

    89 /*! Sets the list of ids of contacts which will be removed to \a contactIds */

    90 void QContactRemoveRequest::setContactIds(const QList<QContactLocalId>& contactIds)

    91 {

    92     Q_D(QContactRemoveRequest);

    93     QMutexLocker ml(&d->m_mutex);

    94     d->m_contactIds = contactIds;

    95 }

    96 

    97 /*! Returns the list of ids of contacts which will be removed */

    98 QList<QContactLocalId> QContactRemoveRequest::contactIds() const

    99 {

   100     Q_D(const QContactRemoveRequest);

   101     QMutexLocker ml(&d->m_mutex);

   102     return d->m_contactIds;

   103 }

   104 

   105 /*! Returns the map of input contact list indices to errors which occurred */

   106 QMap<int, QContactManager::Error> QContactRemoveRequest::errorMap() const

   107 {

   108     Q_D(const QContactRemoveRequest);

   109     QMutexLocker ml(&d->m_mutex);

   110     return d->m_errors;

   111 }

   112 

   113 #include "moc_qcontactremoverequest.cpp"

   114 

   115 QTM_END_NAMESPACE