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