scheduler.h

/*
    This file is part of libkcal.
 
    Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@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 KCAL_SCHEDULER_H
#define KCAL_SCHEDULER_H
 
#include <tqstring.h>
#include <tqptrlist.h>
 
#include "libkcal_export.h"
 
namespace KCal {
 
class IncidenceBase;
class Event;
class Calendar;
class ICalFormat;
class FreeBusyCache;

class ScheduleMessage
{
  public:
    enum Status { PublishNew, PublishUpdate, Obsolete, RequestNew,
                  RequestUpdate, Unknown };

    ScheduleMessage( IncidenceBase *, int method, Status status );
    ~ScheduleMessage() {};

    IncidenceBase *event() { return mIncidence; }
    int method() { return mMethod; }
    Status status() { return mStatus; }
    TQString error() { return mError; }

    static TQString statusName( Status status );
 
  private:
    IncidenceBase *mIncidence;
    int mMethod;
    Status mStatus;
    TQString mError;
 
    class Private;
    Private *d;
};

class LIBKCAL_EXPORT Scheduler
{
  public:
    enum Method { Publish,Request,Refresh,Cancel,Add,Reply,Counter,
                  Declinecounter,NoMethod };

    Scheduler( Calendar *calendar );
    virtual ~Scheduler();

    virtual bool publish( IncidenceBase *incidence,
                          const TQString &recipients ) = 0;
    virtual bool performTransaction( IncidenceBase *incidence,
                                     Method method ) = 0;
    virtual bool performTransaction( IncidenceBase *incidence, Method method,
                                     const TQString &recipients ) = 0;
    virtual TQPtrList<ScheduleMessage> retrieveTransactions() = 0;

    bool acceptTransaction( IncidenceBase *, Method method,
                            ScheduleMessage::Status status,
                            const TQString& attendee = TQString() );

    static TQString methodName( Method );
    static TQString translatedMethodName( Method );
 
    virtual bool deleteTransaction( IncidenceBase *incidence );

    virtual TQString freeBusyDir() = 0;

    void setFreeBusyCache( FreeBusyCache * );
    FreeBusyCache *freeBusyCache() const;
 
  protected:
    bool acceptPublish( IncidenceBase *, ScheduleMessage::Status status,
                        Method method );
    bool acceptRequest( IncidenceBase *, ScheduleMessage::Status status,
                        const TQString & attendee );
    bool acceptAdd( IncidenceBase *, ScheduleMessage::Status status );
    TDE_DEPRECATED bool acceptCancel( IncidenceBase *, ScheduleMessage::Status status );
    bool acceptCancel( IncidenceBase *, ScheduleMessage::Status status,
                       const TQString & attendee );
    bool acceptDeclineCounter( IncidenceBase *,
                               ScheduleMessage::Status status );
    bool acceptReply( IncidenceBase *, ScheduleMessage::Status status,
                      Method method );
    bool acceptRefresh( IncidenceBase *, ScheduleMessage::Status status );
    bool acceptCounter( IncidenceBase *, ScheduleMessage::Status status );
    bool acceptFreeBusy( IncidenceBase *, Method method );
 
    Calendar *mCalendar;
    ICalFormat *mFormat;
 
  private:
    class Private;
    Private *d;
};
 
}
 
#endif