src/contacts/requests/qcontactrelationshipremoverequest.cpp
changeset 0 876b1a06bc25
equal deleted inserted replaced
-1:000000000000 0:876b1a06bc25
       
     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 "qcontactrelationshipremoverequest.h"
       
    43 #include "qcontactrequests_p.h"
       
    44 
       
    45 QTM_BEGIN_NAMESPACE
       
    46 
       
    47 /*!
       
    48   \class QContactRelationshipRemoveRequest
       
    49 
       
    50   \brief The QContactRelationshipRemoveRequest class allows a client
       
    51   to asynchronously request that certain relationships be removed from
       
    52   a contacts store.
       
    53 
       
    54   For a QContactRelationshipRemoveRequest, the resultsUpdated() signal will be emitted when
       
    55   the individual item errors (which may be retrieved by calling errorMap()) are updated, or if the overall
       
    56   operation error (which may be retrieved by calling error()) is updated.
       
    57 
       
    58   Please see the class documentation of QContactAbstractRequest for more information about
       
    59   the usage of request classes and ownership semantics.
       
    60 
       
    61   \ingroup contacts-requests
       
    62  */
       
    63 
       
    64 /*! Constructs a new relationship remove request whose parent is the specified \a parent */
       
    65 QContactRelationshipRemoveRequest::QContactRelationshipRemoveRequest(QObject* parent)
       
    66     : QContactAbstractRequest(new QContactRelationshipRemoveRequestPrivate, parent)
       
    67 {
       
    68 }
       
    69 
       
    70 
       
    71 /*! Frees any memory used by this request */
       
    72 QContactRelationshipRemoveRequest::~QContactRelationshipRemoveRequest()
       
    73 {
       
    74     QContactAbstractRequestPrivate::notifyEngine(this);
       
    75 }
       
    76 
       
    77 /*!
       
    78   Sets the relationship which will be removed to \a relationship.
       
    79   Equivalent to calling:
       
    80   \code
       
    81       setRelationships(QList<QContactRelationship>() << relationship);
       
    82   \endcode
       
    83  */
       
    84 void QContactRelationshipRemoveRequest::setRelationship(const QContactRelationship& relationship)
       
    85 {
       
    86     Q_D(QContactRelationshipRemoveRequest);
       
    87     QMutexLocker ml(&d->m_mutex);
       
    88     d->m_relationships.clear();
       
    89     d->m_relationships.append(relationship);
       
    90 }
       
    91 
       
    92 /*! Sets the list of relationships which will be removed to \a relationships */
       
    93 void QContactRelationshipRemoveRequest::setRelationships(const QList<QContactRelationship>& relationships)
       
    94 {
       
    95     Q_D(QContactRelationshipRemoveRequest);
       
    96     QMutexLocker ml(&d->m_mutex);
       
    97     d->m_relationships = relationships;
       
    98 }
       
    99 
       
   100 /*! Returns the list of relationships which will be removed */
       
   101 QList<QContactRelationship> QContactRelationshipRemoveRequest::relationships() const
       
   102 {
       
   103     Q_D(const QContactRelationshipRemoveRequest);
       
   104     QMutexLocker ml(&d->m_mutex);
       
   105     return d->m_relationships;
       
   106 }
       
   107 
       
   108 /*! Returns the map of input contact list indices to errors which occurred */
       
   109 QMap<int, QContactManager::Error> QContactRelationshipRemoveRequest::errorMap() const
       
   110 {
       
   111     Q_D(const QContactRelationshipRemoveRequest);
       
   112     QMutexLocker ml(&d->m_mutex);
       
   113     return d->m_errors;
       
   114 }
       
   115 
       
   116 #include "moc_qcontactrelationshipremoverequest.cpp"
       
   117 
       
   118 QTM_END_NAMESPACE