contactsearchjob.h

/*
    This file is part of Akonadi Contact.

    Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_CONTACTSEARCHJOB_H
#define AKONADI_CONTACTSEARCHJOB_H

#include "akonadi-contact_export.h"

#include <akonadi/item.h>
#include <akonadi/itemsearchjob.h>
#include <kabc/addressee.h>

namespace Akonadi {

class AKONADI_CONTACT_EXPORT ContactSearchJob : public ItemSearchJob
{
  Q_OBJECT

  public:
    explicit ContactSearchJob( QObject *parent = 0 );

    ~ContactSearchJob();

    enum Criterion {
      Name,       
      Email,      
      NickName,   
      NameOrEmail, 
      ContactUid   
    };

    enum Match {
      ExactMatch,      
      StartsWithMatch, 
      ContainsMatch,    
      ContainsWordBoundaryMatch 
    };

    void setQuery( Criterion criterion, const QString &value );

    void setQuery( Criterion criterion, const QString &value, Match match );

    void setLimit( int limit );

    KABC::Addressee::List contacts() const;

  private:
    //@cond PRIVATE
    class Private;
    Private* const d;
    //@endcond
};

}

#endif