Akonadi::Entity Class Reference

#include <entity.h>

Inheritance diagram for Akonadi::Entity:

Public Types
enum	CreateOption { AddIfMissing }
typedef qint64	Id

Public Member Functions
void	addAttribute (Attribute *attribute)
Attribute *	attribute (const QByteArray &name) const
template<typename T >
T *	attribute (CreateOption option)
template<typename T >
T *	attribute () const
Attribute::List	attributes () const
void	clearAttributes ()
bool	hasAttribute (const QByteArray &name) const
template<typename T >
bool	hasAttribute () const
Id	id () const
bool	isValid () const
bool	operator!= (const Entity &other) const
bool	operator< (const Entity &other) const
Entity &	operator= (const Entity &other)
bool	operator== (const Entity &other) const
Collection	parentCollection () const
Collection &	parentCollection ()
QString	remoteId () const
QString	remoteRevision () const
void	removeAttribute (const QByteArray &name)
template<typename T >
void	removeAttribute ()
void	setId (Id identifier)
void	setParentCollection (const Collection &parent)
void	setRemoteId (const QString &id)
void	setRemoteRevision (const QString &revision)

Protected Member Functions
	Entity (const Entity &other)
	~Entity ()

Detailed Description

The base class for Item and Collection.

Entity is the common base class for Item and Collection that provides unique IDs and attributes handling.

This class is not meant to be used directly, use Item or Collection instead.

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Definition at line 59 of file entity.h.

Member Typedef Documentation

typedef qint64 Akonadi::Entity::Id

Describes the unique id type.

Definition at line 65 of file entity.h.

Member Enumeration Documentation

enum Akonadi::Entity::CreateOption

Describes the options that can be passed to access attributes.

Enumerator
AddIfMissing	Creates the attribute if it is missing.

Definition at line 204 of file entity.h.

Constructor & Destructor Documentation

Entity::Entity ( const Entity &  other )

protected

Creates an entity from an other entity.

Definition at line 53 of file entity.cpp.

Entity::~Entity ( )

protected

Destroys the entity.

Definition at line 63 of file entity.cpp.

Member Function Documentation

void Entity::addAttribute

(

Attribute *

attribute

)

Adds an attribute to the entity.

If an attribute of the same type name already exists, it is deleted and replaced with the new one.

Parameters

attribute

The new attribute.

Note

The entity takes the ownership of the attribute.

Definition at line 126 of file entity.cpp.

Attribute * Entity::attribute

(

const QByteArray &

name

)

const

Returns the attribute of the given type name if available, 0 otherwise.

Definition at line 165 of file entity.cpp.

template<typename T >

T* Akonadi::Entity::attribute ( CreateOption  option )

inline

Returns the attribute of the requested type.

If the entity has no attribute of that type yet, a new one is created and added to the entity.

Parameters

option

The create options.

Definition at line 215 of file entity.h.

template<typename T >

T* Akonadi::Entity::attribute ( ) const

inline

Returns the attribute of the requested type or 0 if it is not available.

Definition at line 237 of file entity.h.

Attribute::List Entity::attributes

(

)

const

Returns a list of all attributes of the entity.

Definition at line 151 of file entity.cpp.

void Akonadi::Entity::clearAttributes

(

)

Removes and deletes all attributes of the entity.

Definition at line 156 of file entity.cpp.

bool Entity::hasAttribute

(

const QByteArray &

name

)

const

Returns true if the entity has an attribute of the given type name, false otherwise.

Definition at line 146 of file entity.cpp.

template<typename T >

bool Akonadi::Entity::hasAttribute ( ) const

inline

Returns whether the entity has an attribute of the requested type.

Definition at line 263 of file entity.h.

Entity::Id Entity::id

(

)

const

Returns the unique identifier of the entity.

Definition at line 72 of file entity.cpp.

bool Entity::isValid

(

)

const

Returns whether the entity is valid.

Definition at line 97 of file entity.cpp.

bool Akonadi::Entity::operator!=

(

const Entity &

other

)

const

Returns whether the entity's id does not equal the id of the other entity.

Definition at line 107 of file entity.cpp.

bool Akonadi::Entity::operator<

(

const Entity &

other

)

const

For use with containers only.

Since

4.8

Definition at line 121 of file entity.cpp.

Entity & Entity::operator=

(

const Entity &

other

)

Assigns the other to this entity and returns a reference to this entity.

Parameters

other

the entity to assign

Definition at line 112 of file entity.cpp.

bool Entity::operator==

(

const Entity &

other

)

const

Returns whether the entity's id equals the id of the other entity.

Definition at line 102 of file entity.cpp.

Collection Entity::parentCollection

(

)

const

Returns the parent collection of this object.

Note

This will of course only return a useful value if it was explictly retrieved from the Akonadi server.

Since

4.4

Definition at line 186 of file entity.cpp.

Collection & Entity::parentCollection

(

)

Returns a reference to the parent collection of this object.

Note

This will of course only return a useful value if it was explictly retrieved from the Akonadi server.

Since

4.4

Definition at line 178 of file entity.cpp.

QString Entity::remoteId

(

)

const

Returns the remote id of the entity.

Definition at line 82 of file entity.cpp.

QString Entity::remoteRevision

(

)

const

Returns the remote revision of the entity.

Note

This method is supposed to be used by resources only.

Since

4.5

Definition at line 92 of file entity.cpp.

void Entity::removeAttribute

(

const QByteArray &

name

)

Removes and deletes the attribute of the given type name.

Definition at line 140 of file entity.cpp.

template<typename T >

void Akonadi::Entity::removeAttribute ( )

inline

Removes and deletes the attribute of the requested type.

Definition at line 254 of file entity.h.

void Entity::setId

(

Id

identifier

)

Sets the unique identifier of the entity.

Definition at line 67 of file entity.cpp.

void Entity::setParentCollection

(

const Collection &

parent

)

Set the parent collection of this object.

Note

Calling this method has no immediate effect for the object itself, such as being moved to another collection. It is mainly relevant to provide a context for RID-based operations inside resources.

Parameters

parent

The parent collection.

Since

4.4

Definition at line 195 of file entity.cpp.

void Entity::setRemoteId

(

const QString &

id

)

Sets the remote id of the entity.

Definition at line 77 of file entity.cpp.

void Entity::setRemoteRevision

(

const QString &

revision

)

Sets the remote revision of the entity.

Parameters

revision

the entity's remote revision The remote revision can be used by resources to store some revision information of the backend to detect changes there.

Note

This method is supposed to be used by resources only.

Since

4.5

Definition at line 87 of file entity.cpp.

---

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

• entity.h
• entity.cpp