ETimeTicketFacade.h

Go to the documentation of this file.

#ifndef EM_CARDFACADEETIMETICKETFACADE_H
#define EM_CARDFACADEETIMETICKETFACADE_H

#include <list>
#include <vector>
#include <string>
#include <stdint.h>
#include "appcore/cardfacade/ECardFacadeDefines.h"

class EMoneyData;

namespace EM
{
    namespace PT
    {
        class EDataCollection;
        class EAplRequest;
    }

    namespace CardFacade
    {
        class DLL_API ETimeTicketFacade
        {
            public:
                typedef std::list<unsigned long> ZoneList;
                typedef ZoneList::iterator ZoneListIter;
                typedef ZoneList::const_iterator ZoneListConstIter;

                ETimeTicketFacade();
                virtual ~ETimeTicketFacade();

                virtual bool GetTariffTicketNumber( unsigned char ticketIndex, unsigned short &tariffTicketNumber ) = 0;
                virtual bool SetTariffTicketNumber( unsigned char ticketIndex, unsigned short tariffTicketNumber ) = 0;

                virtual bool GetTicketTariffProfile( unsigned char ticketIndex, unsigned char &tariffProfile ) = 0;
                virtual bool SetTicketTariffProfile( unsigned char ticketIndex, unsigned char tariffProfile ) = 0;

                virtual bool GetTicketCustomerProfile( unsigned char ticketIndex, unsigned char &customerProfile ) = 0;
                virtual bool SetTicketCustomerProfile( unsigned char ticketIndex, unsigned char customerProfile ) = 0;

                virtual bool GetTimeTicketsCount( short &timeTicketsCount ) = 0;
                virtual bool SetTimeTicketsCount( short timeTicketsCount ) = 0;

                virtual bool GetAvailableTimeTicketSlots( short &timeTicketSlots ) = 0;

                virtual bool GetValidityStartTime( unsigned char ticketIndex, unsigned long &validityStartTime ) = 0;
                virtual bool SetValidityStartTime( unsigned char ticketIndex, unsigned long validityFrom ) = 0;

                virtual bool GetValidityEndTime( unsigned char ticketIndex, unsigned long &validityEndTime ) = 0;
                virtual bool SetValidityEndTime( unsigned char ticketIndex, unsigned long validityTo ) = 0;

                virtual bool GetProvider( unsigned char ticketIndex, short &provider ) = 0;
                virtual bool SetProvider( unsigned char ticketIndex, short provider ) = 0;

                virtual bool GetTimeTicketNumber( unsigned char ticketIndex, unsigned short &timeTicketNumber ) = 0;
                virtual bool SetTimeTicketNumber( unsigned char ticketIndex, unsigned short timeTicketNumber ) = 0;

                virtual bool GetTimeTicketPreviousNumber( unsigned char ticketIndex, unsigned short &timeTicketNumber ) = 0;
                virtual bool SetTimeTicketPreviousNumber( unsigned char ticketIndex, unsigned short timeTicketNumber ) = 0;

                virtual bool GetPriceListRowNumber( unsigned char ticketIndex, unsigned short &priceListRowNumber ) = 0;
                virtual bool SetPriceListRowNumber( unsigned char ticketIndex, unsigned short priceListRowNumber ) = 0;

                virtual bool GetAvailableJourneyCount( unsigned char ticketIndex, unsigned short &availableJourneyCount ) = 0;
                virtual bool SetAvailableJourneyCount( unsigned char ticketIndex, unsigned short availableJourneyCount ) = 0;

                virtual bool GetJourneyCount( unsigned short ticketIndex, unsigned short &journeyCount ) = 0;
                virtual bool SetJourneyCount( unsigned char ticketIndex, unsigned short journeyCount ) = 0;

                virtual bool GetTicketType( unsigned char ticketIndex, ECardFacadeDefines::TimeTicketType &ticketType ) = 0;
                virtual bool SetTicketType( unsigned char ticketIndex, ECardFacadeDefines::TimeTicketType ticketType ) = 0;

                virtual bool SetZoneSize( unsigned char ticketIndex, unsigned char zoneSize ) = 0;

                virtual bool GetCheckInZone( unsigned char ticketIndex, unsigned short &checkinZone ) = 0;
                virtual bool SetCheckInZone( unsigned char ticketIndex, unsigned short checkinZone ) = 0;

                virtual bool GetCheckOutZone( unsigned char ticketIndex, unsigned short &checkoutZone ) = 0;
                virtual bool SetCheckOutZone( unsigned char ticketIndex, unsigned short checkOutZone ) = 0;

                virtual bool GetUrbanTransportIdentificationNumber( unsigned char ticketIndex, long &urbanTransportIdentificationNumber ) = 0;
                virtual bool SetUrbanTransportIdentificationNumber( unsigned char ticketIndex, long urbanTransport ) = 0;

                virtual bool GetPrice( unsigned char ticketIndex, EMoneyData &price ) = 0;
                virtual bool SetPrice( unsigned char ticketIndex, const EMoneyData &price ) = 0;

                virtual bool GetPriceUnit( unsigned char ticketIndex, unsigned char &priceUnit ) = 0;
                virtual bool SetPriceUnit( unsigned char ticketIndex, unsigned char priceUnit ) = 0;

                virtual bool IsTimeTicketValid( unsigned char ticketIndex, bool &valid ) = 0;
                virtual bool SetTimeTicketValid( unsigned char ticketIndex, bool valid ) = 0;

                virtual bool GetRestrictDayOfWeek( unsigned char ticketIndex, unsigned char &restrictDayOfWeek ) = 0;
                virtual bool SetRestrictDayOfWeek( unsigned char ticketIndex, unsigned char restrictDayOfWeek ) = 0;

                virtual bool GetPaymentType( unsigned char ticketIndex, unsigned char& paymentType ) = 0;
                virtual bool SetPaymentType( unsigned char ticketIndex, unsigned char paymentType ) = 0;

                virtual bool GetCountryCode( unsigned char ticketIndex, unsigned short &countryCodeInBCD ) = 0;
                virtual bool SetCountryCode( unsigned char ticketIndex, unsigned short countryCodeInBCD ) = 0;

                virtual bool GetNetworkCode( unsigned char ticketIndex, unsigned short &networkCodeInBCD ) = 0;
                virtual bool SetNetworkCode( unsigned char ticketIndex, unsigned short networkCodeInBCD ) = 0;

                virtual bool GetZoneList( unsigned char ticketIndex, ZoneList &zoneList ) = 0;
                virtual bool SetZoneList( unsigned char ticketIndex, const ZoneList &zoneList ) = 0;

                virtual bool GetZoneBitCollection(unsigned char ticketIndex, std::vector<unsigned char> &bitCollection) = 0;
                virtual bool SetZoneBitCollection(unsigned char ticketIndex, const std::vector<unsigned char> &bitCollection) = 0;

                virtual bool GetRouteNumber( unsigned char ticketIndex, unsigned short &routeNumber ) = 0;
                virtual bool SetRouteNumber( unsigned char ticketIndex, unsigned short routeNumber ) = 0;

                virtual bool GetActivationFlag( unsigned char ticketIndex, bool &activationFlag ) = 0;
                virtual bool SetActivationFlag( unsigned char ticketIndex, bool activationFlag ) = 0;

                virtual bool GetDeviceSNR( unsigned char ticketIndex, unsigned long &snr ) = 0;
                virtual bool SetDeviceSNR( unsigned char ticketIndex, unsigned long snr ) = 0;

                virtual bool GetDriverNumber( unsigned char ticketIndex, unsigned long &driverNumber ) = 0;
                virtual bool SetDriverNumber( unsigned char ticketIndex, unsigned long driverNumber ) = 0;

                virtual bool IsHourTimeTicket( unsigned char ticketIndex, bool &hourTimeTicketFlag ) = 0;
                
                virtual bool SetUrbanTransportFlag( unsigned char ticketIndex, bool isUrbanTransportEnabled ) = 0;
                virtual bool SetSubUrbanTransportFlag(unsigned char ticketIndex, bool isSuburbanTransportEnabled ) = 0;

                virtual bool GetFileNumber( unsigned char ticketIndex, unsigned long &fileNumber ) = 0;
                virtual bool SetFileNumber( unsigned char ticketIndex, unsigned long fileNumber ) = 0;

                virtual bool GetCouponRestrictCode( const unsigned char ticketIndex, unsigned char &couponRestrictCode ) = 0;
                virtual bool SetCouponRestrictCode( const unsigned char ticketIndex, const unsigned char couponRestrictCode ) = 0;

                virtual bool GetCouponKilometers( const unsigned char ticketIndex, unsigned char &couponKilometers ) = 0;
                virtual bool SetCouponKilometers( const unsigned char ticketIndex, const unsigned char couponKilometers ) = 0;

                virtual bool GetRestrictLineType( const unsigned char ticketIndex, unsigned char &couponRestrictLineType ) = 0;
                virtual bool SetRestrictLineType( const unsigned char ticketIndex, const unsigned char couponRestrictLineType ) = 0;

                virtual bool GetFlagIsIdsCoupon( const unsigned char ticketIndex, bool &isIdsCoupon ) = 0;
                virtual bool SetFlagIsIdsCoupon( const unsigned char ticketIndex, const bool isIdsCoupon ) = 0;

                virtual bool GetFlagIsBaggageTicket( const unsigned char ticketIndex, bool &baggageTicket ) = 0;
                virtual bool SetFlagIsBaggageTicket( const unsigned char ticketIndex, bool baggageTicket ) = 0;

                virtual bool GetIndexOfPairedTimeTicket( const unsigned char ticketIndex, unsigned char &indexOfPairedTimeTicket ) = 0;

                virtual bool IsTimeTicketFeatureEnabled( ECardFacadeDefines::TimeTicketFeatures feature, unsigned char ticketIndex, bool &enabled ) = 0;

                virtual void Clear();

                virtual bool IsModifiedData();

                virtual bool AddDataToWriteRequest( EM::PT::EDataCollection *writeRequest );
                virtual bool AddDataTypeToReadRequest( PT::EAplRequest *readRequest ) = 0;

                virtual void Init();

                bool IsCardFeatureEnabled( ECardFacadeDefines::TimeTicketCardFeatures feature, bool &enabled );

                virtual unsigned short GetRequiredDataReadOperation() const = 0;

                virtual bool CreateSnapshotData( const unsigned char ticketIndex, std::string &data );
                virtual bool FillFromSnapshot( const unsigned char ticketIndex, const std::string &data );

            protected:
                //FIXME: JBR these methods are also in EOneWayTicketFacade and EPurceFacade, so they should probably be in some ancestor class
                virtual int  GetCurrencyCoeficient( const unsigned char priceUnit ) const;
                virtual long ConvertPriceToCardCoeficient( const EMoneyData &price, const unsigned char priceUnit ) const;

                void SetCardFeature( uint64_t features );
            private:

                class DataClass;
                DataClass *d;

        };
    }
}

#endif