src/contacts/requests/qcontactlocalidfetchrequest.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 "qcontactlocalidfetchrequest.h"
       
    43 #include "qcontactrequests_p.h"
       
    44 
       
    45 QTM_BEGIN_NAMESPACE
       
    46 
       
    47 /*!
       
    48   \class QContactLocalIdFetchRequest
       
    49   \brief The QContactLocalIdFetchRequest class allows a client to asynchronously
       
    50     request a list of contact ids from a contacts store manager.
       
    51 
       
    52 
       
    53   For a QContactLocalIdFetchRequest, the resultsAvailable() signal will be emitted when the resultant
       
    54   manager-local contact ids (which may be retrieved by calling ids()), 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 contact id fetch request whose parent is the specified \a parent */
       
    64 QContactLocalIdFetchRequest::QContactLocalIdFetchRequest(QObject* parent)
       
    65     : QContactAbstractRequest(new QContactLocalIdFetchRequestPrivate, parent)
       
    66 {
       
    67 }
       
    68 
       
    69 /*! Frees any memory used by this request */
       
    70 QContactLocalIdFetchRequest::~QContactLocalIdFetchRequest()
       
    71 {
       
    72     QContactAbstractRequestPrivate::notifyEngine(this);
       
    73 }
       
    74 
       
    75 /*! Sets the filter which will be used to select the contacts whose ids will be returned to \a filter */
       
    76 void QContactLocalIdFetchRequest::setFilter(const QContactFilter& filter)
       
    77 {
       
    78     Q_D(QContactLocalIdFetchRequest);
       
    79     QMutexLocker ml(&d->m_mutex);
       
    80     d->m_filter = filter;
       
    81 }
       
    82 
       
    83 /*! Sets the future sort ordering of the result of the request to \a sorting.  This function only has
       
    84     effect on the result if called prior to calling \c start() */
       
    85 void QContactLocalIdFetchRequest::setSorting(const QList<QContactSortOrder>& sorting)
       
    86 {
       
    87     Q_D(QContactLocalIdFetchRequest);
       
    88     QMutexLocker ml(&d->m_mutex);
       
    89     d->m_sorting = sorting;
       
    90 }
       
    91 
       
    92 /*! Returns the filter which will be used to select the contacts whose ids will be returned */
       
    93 QContactFilter QContactLocalIdFetchRequest::filter() const
       
    94 {
       
    95     Q_D(const QContactLocalIdFetchRequest);
       
    96     QMutexLocker ml(&d->m_mutex);
       
    97     return d->m_filter;
       
    98 }
       
    99 
       
   100 /*! Returns the sort ordering which will be used to sort the result */
       
   101 QList<QContactSortOrder> QContactLocalIdFetchRequest::sorting() const
       
   102 {
       
   103     Q_D(const QContactLocalIdFetchRequest);
       
   104     QMutexLocker ml(&d->m_mutex);
       
   105     return d->m_sorting;
       
   106 }
       
   107 
       
   108 /*! Returns the list of ids of contacts which matched the request */
       
   109 QList<QContactLocalId> QContactLocalIdFetchRequest::ids() const
       
   110 {
       
   111     Q_D(const QContactLocalIdFetchRequest);
       
   112     QMutexLocker ml(&d->m_mutex);
       
   113     return d->m_ids;
       
   114 }
       
   115 
       
   116 #include "moc_qcontactlocalidfetchrequest.cpp"
       
   117 
       
   118 QTM_END_NAMESPACE