EOneWayTicketFacade.h

Go to the documentation of this file.

#ifndef EM_CARDFACADEEONEWAYTICKETFACADE_H
#define EM_CARDFACADEEONEWAYTICKETFACADE_H

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

class EMoneyData;

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

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

            EOneWayTicketFacade();
            virtual ~EOneWayTicketFacade();

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

            virtual bool GetSummaryPrice( EMoneyData &price ) = 0;
            virtual bool SetSummaryPrice( const EMoneyData &price ) = 0;

            virtual bool GetFlagWasPurchased( unsigned char ticketIndex, char &wasPurchased ) = 0;
            virtual bool SetFlagWasPurchased( unsigned char ticketIndex, char wasPurchased ) = 0;

            virtual bool GetFlagWasInterchange( unsigned char ticketIndex, char &flagWasInterchange ) = 0;
            virtual bool SetFlagWasInterchange( unsigned char ticketIndex, char wasInterchange ) = 0;

            virtual bool GetProtectNumber( unsigned char ticketIndex, long &protectNumber ) = 0;
            virtual bool SetProtectNumber( unsigned char ticketIndex, long protectNumber ) = 0;

            virtual bool GetTicketCount( unsigned char ticketIndex, long &ticketCount ) = 0;
            virtual bool SetTicketCount( unsigned char ticketIndex, long ticketCount ) = 0;

            virtual bool GetLineNumber( unsigned char ticketIndex, long &lineNumber ) = 0;
            virtual bool SetLineNumber( unsigned char ticketIndex, long lineNumber ) = 0;

            virtual bool GetTripNumber( unsigned char ticketIndex, long &tripNumber ) = 0;
            virtual bool SetTripNumber( unsigned char ticketIndex, long tripNumber ) = 0;

            virtual bool GetTimeTicketFlag( unsigned char ticketIndex, bool &timeTicketFlag ) = 0;
            virtual bool SetTimeTicketFlag( unsigned char ticketIndex, bool isTimeTicketUsed ) = 0;

            virtual bool GetTariffTicketNumber( unsigned char ticketIndex, long &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 GetTimeTicketNumber( unsigned char ticketIndex, long &timeTicketNumber ) = 0;
            virtual bool SetTimeTicketNumber( unsigned char ticketIndex, unsigned short timeTicketNumber ) = 0;

            virtual bool GetDiscountType( unsigned char ticketIndex, short &discountType ) = 0;
            virtual bool SetDiscountType( unsigned char ticketIndex, unsigned short discountType ) = 0;

            virtual bool GetTimeValidityStart( unsigned char ticketIndex, unsigned long &validityStartTime ) = 0;
            virtual bool GetTimeValidityEnd(unsigned char ticketIndex, unsigned long &validityEndTime ) = 0;
            virtual bool SetTimeValidity( unsigned char ticketIndex, unsigned long validityStartTime, unsigned long validityEndTime ) = 0;

            virtual bool GetCheckOutBusStop( unsigned char ticketIndex, long &checkoutBusStop ) = 0;
            virtual bool SetCheckOutBusStop( unsigned char ticketIndex, long checkOutBusStop ) = 0;

            virtual bool GetCheckInBusStop( unsigned char ticketIndex, long &checkinBusStop ) = 0;
            virtual bool SetCheckInBusStop( unsigned char ticketIndex, long checkInBusStop ) = 0;

            virtual bool GetCheckOutBusStopID( unsigned char ticketIndex, long &checkoutBusStopID ) = 0;
            virtual bool SetCheckOutBusStopID( unsigned char ticketIndex, long checkOutBusStopID ) = 0;

            virtual bool GetCheckInBusStopID( unsigned char ticketIndex, long &checkinBusStopID ) = 0;
            virtual bool SetCheckInBusStopID( unsigned char ticketIndex, long checkInBusStopID ) = 0;

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

            virtual bool GetWasCheckOut( unsigned char ticketIndex, bool &wasCheckout ) = 0;
            virtual bool SetWasCheckout( unsigned char ticketIndex, bool wasCheckOut ) = 0;

            virtual bool GetCompanyNumber( unsigned char ticketIndex, long &companyNumber ) = 0;
            virtual bool SetCompanyNumber( unsigned char ticketIndex, long companyNumber ) = 0;

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

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

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

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

            virtual bool SetPaymentMeans( unsigned char ticketIndex, unsigned char paymentMeans ) = 0;
            virtual bool GetPaymentMeans( unsigned char ticketIndex, unsigned char &paymentMeans ) = 0;

            virtual bool SetPaymentMode( unsigned char ticketIndex, unsigned char paymentMode ) = 0;
            virtual bool GetPaymentMode( unsigned char ticketIndex, unsigned char &paymentMode ) = 0;

            virtual bool SetVehicleClass( unsigned char ticketIndex, unsigned char vehicleClass ) = 0;
            virtual bool GetVehicleClass( unsigned char ticketIndex, unsigned char &vehicleClass ) = 0;

            virtual bool SetSeatReservation( unsigned char ticketIndex, unsigned char seatReservation ) = 0;
            virtual bool GetSeatReservation( unsigned char ticketIndex, unsigned char &seatReservation ) = 0;

            virtual bool SetZoneSize( unsigned char zoneSize ) = 0;

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

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

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

            virtual bool GetZoneAmount( unsigned char ticketIndex, unsigned char &zoneAmount ) = 0;
            virtual bool SetZoneAmount( unsigned char ticketIndex, const unsigned char zoneAmount ) = 0;

            virtual bool GetEndOfJourney( unsigned char ticketIndex, unsigned long &endOfJourney ) = 0;
            virtual bool SetEndOfJourney( unsigned char ticketIndex, const unsigned long endOfJourney ) = 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 GetTicketNumber( unsigned char ticketIndex, unsigned long &ticketNumber ) = 0;
            virtual bool SetTicketNumber( unsigned char ticketIndex, unsigned long ticketNumber ) = 0;

            virtual bool GetTicketCounter( unsigned char ticketIndex, unsigned short &ticketCounter ) = 0;
            virtual bool SetTicketCounter( unsigned char ticketIndex, unsigned short ticketCounter ) = 0;

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

            virtual bool GetFlagExplicitlySelected( unsigned char ticketIndex, bool &explicitlySelected ) = 0;
            virtual bool SetFlagExplicitlySelected( unsigned char ticketIndex, bool explicitlySelected ) = 0;

            virtual bool GetPositionCountOnOWTCollection( unsigned char &positionCountOnOWTCollection ) = 0;

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

            virtual bool IsTransportSectionValid( bool &transportSectionValidity );

            virtual bool GetOneWayTicketValidityStatus( const unsigned char ticketIndex, bool &valid ) const = 0;
            virtual bool SetOneWayTicketValidityStatus( const unsigned char ticketIndex, const bool valid ) = 0;

            virtual bool GetJourneyCounter( const unsigned char ticketIndex, unsigned long &journeyCounter  ) const = 0;
            virtual bool SetJourneyCounter( const unsigned char ticketIndex, const unsigned long journeyCounter ) = 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::OneWayTicketCardFeaturesEnum 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 );

            virtual unsigned long GetFellowTravellerTicketCountCardLimit() const = 0;

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

            void SetCardFeature( uint64_t features );

        private:

            class DataClass;
            DataClass *d;

        };
    }
}

#endif