collection.h

/*
    Copyright (c) 2006 - 2007 Volker Krause <vkrause@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_COLLECTION_H
#define AKONADI_COLLECTION_H

#include "akonadi_export.h"

#include <akonadi/entity.h>

#include <QtCore/QMetaType>
#include <QtCore/QSharedDataPointer>

class KUrl;

namespace Akonadi {

class CachePolicy;
class CollectionPrivate;
class CollectionStatistics;

class AKONADI_EXPORT Collection : public Entity
{
  public:
    typedef QList<Collection> List;

    enum Right {
      ReadOnly = 0x0,                   
      CanChangeItem = 0x1,              
      CanCreateItem = 0x2,              
      CanDeleteItem = 0x4,              
      CanChangeCollection = 0x8,        
      CanCreateCollection = 0x10,       
      CanDeleteCollection = 0x20,       
      CanLinkItem = 0x40,               
      CanUnlinkItem = 0x80,             
      AllRights = ( CanChangeItem | CanCreateItem | CanDeleteItem |
                   CanChangeCollection | CanCreateCollection | CanDeleteCollection ) 
    };
    Q_DECLARE_FLAGS( Rights, Right )

    
    Collection();

    explicit Collection( Id id );

    ~Collection();

    Collection( const Collection &other );

    static Collection fromUrl( const KUrl &url );

    QString name() const;

    QString displayName() const;

    void setName( const QString &name );

    Rights rights() const;

    void setRights( Rights rights );

    QStringList contentMimeTypes() const;

    void setContentMimeTypes( const QStringList &types );

    AKONADI_DEPRECATED Id parent() const;

    AKONADI_DEPRECATED void setParent( Id parent );

    AKONADI_DEPRECATED void setParent( const Collection &collection );

    AKONADI_DEPRECATED QString parentRemoteId() const;

    AKONADI_DEPRECATED void setParentRemoteId( const QString &identifier );

    static Collection root();

    static QString mimeType();

    static QString virtualMimeType();

    QString resource() const;

    void setResource( const QString &identifier );

    CachePolicy cachePolicy() const;

    void setCachePolicy( const CachePolicy &policy );

    CollectionStatistics statistics() const;

    void setStatistics( const CollectionStatistics &statistics );

    KUrl url() const;

    enum UrlType {
      UrlShort = 0,     
      UrlWithName = 1   
    };

    KUrl url( UrlType type ) const;

    bool isVirtual() const;

    void setVirtual(bool isVirtual);

  private:
    AKONADI_DECLARE_PRIVATE( Collection )
    friend class CollectionFetchJob;
    friend class CollectionModifyJob;
};

}

AKONADI_EXPORT uint qHash( const Akonadi::Collection &collection );
AKONADI_EXPORT QDebug operator<<( QDebug d, const Akonadi::Collection &collection );

Q_DECLARE_METATYPE(Akonadi::Collection)
Q_DECLARE_METATYPE(Akonadi::Collection::List)
Q_DECLARE_OPERATORS_FOR_FLAGS( Akonadi::Collection::Rights )

#endif