#include <persistentsearchattribute.h>

Inheritance diagram for Akonadi::PersistentSearchAttribute:

Public Member Functions
	PersistentSearchAttribute ()

	~PersistentSearchAttribute ()

QString	queryLanguage () const

QString	queryString () const

void	setQueryLanguage (const QString &language)

void	setQueryString (const QString &query)

Public Member Functions inherited from Akonadi::Attribute
virtual	~Attribute ()

virtual Attribute *	clone () const =0

virtual void	deserialize (const QByteArray &data)=0

virtual QByteArray	serialized () const =0

virtual QByteArray	type () const =0

Additional Inherited Members
Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * >	List

Detailed Description

An attribute to store query properties of persistent search collections.

This attribute is attached to persistent search collections automatically when creating a new persistent search with SearchCreateJob. Later on the search query can be changed by modifying this attribute of the persistent search collection with an CollectionModifyJob.

Example:

const QString name = "My search folder";
const QString query = "...";
Akonadi::SearchCreateJob *job = new Akonadi::SearchCreateJob( name, query );
connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) );
MyClass::jobFinished( KJob *job )
{
  if ( job->error() ) {
    qDebug() << "Error occurred";
    return;
  }
  const Collection searchCollection = job->createdCollection();
  ...
  // now let's change the query
  if ( searchCollection.hasAttribute<Akonadi::PersistentSearchAttribute>() ) {
    Akonadi::PersistentSearchAttribute *attribute = searchCollection.attribute<Akonadi::PersistentSearchAttribute>();
    attribute->setQueryString( "... another query string ..." );
    Akonadi::CollectionModifyJob *modifyJob = new Akonadi::CollectionModifyJob( searchCollection );
    connect( modifyJob, SIGNAL( result( KJob* ) ), SLOT( modifyFinished( KJob* ) ) );
  }
  ...
}