Akonadi::SearchCreateJob Class Reference

#include <searchcreatejob.h>

Inheritance diagram for Akonadi::SearchCreateJob:

Public Member Functions
	SearchCreateJob (const QString &name, const QString &query, QObject *parent=0)
	~SearchCreateJob ()
Collection	createdCollection () const
void	setQueryLanguage (const QString &queryLanguage)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
virtual bool	doKill ()
void	emitWriteFinished ()
virtual bool	removeSubjob (KJob *job)

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)

Detailed Description

Job that creates a virtual/search collection in the Akonadi storage.

This job creates so called virtual or search collections, which don't contain real data, but references to items that match a given search query.

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;
  }

  qDebug() << "Created search folder successfully";
  const Collection searchCollection = job->createdCollection();
  ...
}

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 60 of file searchcreatejob.h.

Constructor & Destructor Documentation

SearchCreateJob::SearchCreateJob	(	const QString &	name,
		const QString &	query,
		QObject *	parent = 0
	)

Creates a search create job.

Parameters

name	The name of the search collection.
query	The search query (format not defined yet).
parent	The parent object.

Definition at line 45 of file searchcreatejob.cpp.

SearchCreateJob::~SearchCreateJob

(

)

Destroys the search create job.

Definition at line 54 of file searchcreatejob.cpp.

Member Function Documentation

Akonadi::Collection SearchCreateJob::createdCollection

(

)

const

Returns the newly created search collection once the job finished successfully.

Returns an invalid collection if the job has not yet finished or failed.

Since

4.4

Definition at line 81 of file searchcreatejob.cpp.

void SearchCreateJob::doHandleResponse ( const QByteArray &  tag, const QByteArray &  data  )

protectedvirtual

Reimplemented from Akonadi::Job.

Reimplemented from Akonadi::Job.

Definition at line 87 of file searchcreatejob.cpp.

void SearchCreateJob::doStart ( )

protectedvirtual

Reimplemented from Akonadi::Job.

Implements Akonadi::Job.

Definition at line 64 of file searchcreatejob.cpp.

void SearchCreateJob::setQueryLanguage

(

const QString &

queryLanguage

)

Sets the query language.

Parameters

queryLanguage

The query language used.

Since

4.6

Definition at line 58 of file searchcreatejob.cpp.

---

The documentation for this class was generated from the following files:

• searchcreatejob.h
• searchcreatejob.cpp