ITicket.h

//------------------------------------------------------------------------------
//
// Copyright (c) 2012 Glympse Inc.  All rights reserved.
//
//------------------------------------------------------------------------------

#ifndef ITICKET_H__GLYMPSE__
#define ITICKET_H__GLYMPSE__

namespace Glympse 
{
     
/*O*public**/ struct ITicket : public IEventSink, public IComparable
{
    public: virtual GString getId() = 0;
    
    public: virtual bool isWatching() = 0;
    
    public: virtual bool isMine() = 0;
    
    public: virtual bool isSibling() = 0;
    
    public: virtual GPrimitive getVisibility() = 0;
    
    public: virtual bool isVisible() = 0;

    public: virtual GString getCode() = 0;

    public: virtual GString getReference() = 0;

    public: virtual int32 getState() = 0;
    
    public: virtual GAppProfile getOwner() = 0;
    
    public: virtual GUser getUser() = 0;

    public: virtual bool isActive() = 0;
    
    public: virtual bool isCompleted() = 0;
    
    public: virtual GArray<GInvite>::ptr getInvites() = 0;
        
    public: virtual int64 getDuration() = 0;
    
    public: virtual int64 getStartTime() = 0;
    
    public: virtual int64 getExpireTime() = 0;
    
    public: virtual GString getMessage() = 0;
    
    public: virtual GPlace getDestination() = 0;
    
    public: virtual GTrack getTrack() = 0;
    
    public: virtual void updateEta(int64 eta) = 0;
    
    public: virtual int64 getEta() = 0;
    
    public: virtual void updateRoute(const GTrack& route) = 0;
    
    public: virtual GTrack getRoute() = 0;
    
    public: virtual GTravelMode getTravelMode() = 0;
    
    public: virtual GInvite findInviteByCode(const GString& code) = 0;

    public: virtual GInvite findInviteByAddress(const GString& address) = 0;

    public: virtual GInvite findInviteByType(int32 type) = 0;
    
    public: virtual bool canAddInvite(const GInvite& invite) = 0;

    public: virtual bool addInvite(const GInvite& invite) = 0;
    
    public: virtual bool deleteInvite(const GInvite& invite) = 0;
    
    public: virtual bool isSomeoneWatching() = 0;
    
    public: virtual void setRequestEndTime(int64 endTime) = 0;

    public: virtual GTicket getRequestTicket() = 0;

    public: virtual void setRequestNoReply(bool requestNoReply) = 0;

    public: virtual bool getRequestNoReply() = 0;

    public: virtual void setRequestScenario(const GString& requestScenario) = 0;

    public: virtual GString getRequestScenario() = 0;

    public: virtual bool setVisibility(const GString& visibility, const GString& context) = 0;

    public: virtual bool modify(int64 remaining, const GString& message, const GPlace& destination) = 0;
    
    public: virtual bool extend(int64 interval) = 0;

    public: virtual void setName(const GString& name) = 0;

    public: virtual GString getName() = 0;

    public: virtual bool clear(bool message, bool destination) = 0;
    
    public: virtual bool expire() = 0;

    public: virtual bool appendData(int64 partnerId, const GString& name, const GPrimitive& value) = 0;
    
    public: virtual GPrimitive getProperty(int64 partnerId, const GString& name) = 0;
    
    public: virtual GDataRow getPropertyData(int64 partnerId, const GString& name) = 0;
    
    public: virtual GEnumeration<GLong>::ptr getPartnerIds() = 0;
    
    public: virtual GMap<GString, GDataRow>::ptr getPartnerData(int64 partnerId) = 0;
    
    public: virtual bool own() = 0;
    
    public: virtual void setOwnership(const GString& providerId, const GPrimitive& providerData) = 0;
    
    public: virtual bool deleteTicket() = 0;
    
    public: virtual GTicket clone() = 0;            
};
    
}

#endif // !ITICKET_H__GLYMPSE__