• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • Entity
Public Types | Public Member Functions | Protected Member Functions
Akonadi::Entity Class Reference

#include <entity.h>

Inheritance diagram for Akonadi::Entity:
Inheritance graph
[legend]

List of all members.

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
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@kde.org>

Member Typedef Documentation

typedef qint64 Akonadi::Entity::Id

Describes the unique id type.

Definition at line 64 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 195 of file entity.h.


Constructor & Destructor Documentation

Entity::Entity ( const Entity &  other) [protected]

Creates an entity from an other entity.

Definition at line 54 of file entity.cpp.

Entity::~Entity ( ) [protected]

Destroys the entity.

Definition at line 64 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:
attributeThe new attribute.
Note:
The entity takes the ownership of the attribute.

Definition at line 122 of file entity.cpp.

Attribute* Akonadi::Entity::attribute ( const QByteArray &  name) const

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

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:
optionThe create options.

Definition at line 207 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 228 of file entity.h.

Attribute::List Akonadi::Entity::attributes ( ) const

Returns a list of all attributes of the entity.

void Akonadi::Entity::clearAttributes ( )

Removes and deletes all attributes of the entity.

Definition at line 154 of file entity.cpp.

bool Akonadi::Entity::hasAttribute ( const QByteArray &  name) const

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

template<typename T >
bool Akonadi::Entity::hasAttribute ( ) const [inline]

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

Definition at line 254 of file entity.h.

Entity::Id Entity::id ( ) const

Returns the unique identifier of the entity.

Definition at line 73 of file entity.cpp.

bool Entity::isValid ( ) const

Returns whether the entity is valid.

Definition at line 67 of file emailaddressselection.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 108 of file entity.cpp.

Entity& Akonadi::Entity::operator= ( const Entity &  other)

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

bool Akonadi::Entity::operator== ( const Entity &  other) const

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

Collection Akonadi::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
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 175 of file entity.cpp.

QString Entity::remoteId ( ) const

Returns the remote id of the entity.

Definition at line 83 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 93 of file entity.cpp.

void Akonadi::Entity::removeAttribute ( const QByteArray &  name)

Removes and deletes the attribute of the given type name.

template<typename T >
void Akonadi::Entity::removeAttribute ( ) [inline]

Removes and deletes the attribute of the requested type.

Definition at line 245 of file entity.h.

void Entity::setId ( Id  identifier)

Sets the unique identifier of the entity.

Definition at line 68 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:
parentThe parent collection.
Since:
4.4

Definition at line 190 of file entity.cpp.

void Entity::setRemoteId ( const QString &  id)

Sets the remote id of the entity.

Definition at line 78 of file entity.cpp.

void Entity::setRemoteRevision ( const QString &  revision)

Sets the remote revision of the entity.

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 88 of file entity.cpp.


The documentation for this class was generated from the following files:
  • entity.h
  • emailaddressselection.cpp
  • entity.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal