ETicketIssueLogicDefines.h

Go to the documentation of this file.

#ifndef EISSUELOGICDEFINES_H
#define EISSUELOGICDEFINES_H

#include <string>

#include "core/common/eplatform.h"

namespace EM
{
    namespace TicketIssueLogic
    {
        extern const char *E_CANCELATION_MODULE_NAME;
        extern const char *E_CARD_ACTIVATION_MODULE_NAME;
        extern const char *E_COMBINED_TICKET_MODULE_NAME;
        extern const char *E_COMMON_FUNCTIONALITY_MODUL_NAME;
        extern const char *E_COMMON_FUNCTIONALITY_MODUL_COMBINED_TICKET_NAME;
        extern const char *E_REGION_CARD_MODULE_NAME;
        extern const char *E_CREDIT_RECHARGE_MODULE_NAME;
        extern const char *E_INTERCHANGE_MODULE_NAME;
        extern const char *E_ONE_WAY_TICKET_MODULE_NAME;
        extern const char *E_PRINT_MODULE_NAME;
        extern const char *E_PRINT_MODULE_COMBINED_TICKET_NAME;
        extern const char *E_STATISTIC_MODULE_NAME;
        extern const char *E_STATISTIC_MODULE_COMBINED_TICKET_NAME;
        extern const char *E_TIME_TICKET_MODULE_NAME;
        extern const char *E_CROSS_TRANSFER_MODULE_NAME;
        extern const char *E_ZONE_MODULE_NAME;
        extern const char *E_TIME_TICKET_ACTIVATION_MODULE;
        extern const char *E_CHECKIN_CHECKOUT_MODULE;
        extern const char *E_CALCULATE_PRICE_MODULE;
        extern const char *E_TRIP_SECTION_MODULE_NAME;
        extern const char *E_WALLET_MODULE_NAME;
        extern const char *E_ALTERNATIVE_TRIP_MODULE_NAME;
        extern const char *E_OUTPUT_DATA_TRIP_MODULE_NAME;
        extern const char *TRIP_SECTION_POST_PROCESS_MODULE_NAME;
        extern const char *VALID_TICKET_ACCEPTANCE_MODULE_NAME;
        extern const char *CASH_PRICE_ROUNDING_MODULE_NAME;

        extern const long E_NETWORK_CODE_MASK;
        extern const long MIN_CARD_PROVIDER_NUMBER;
        extern const long MAX_CARD_PROVIDER_NUMBER;

        extern const long CAPPING_RESET_TIME_HOURS;

        class DLL_API EIssueLogicDefines
        {
        public:

            enum ReturnValues
            {
                Ok                                              = 0,
                BadInputData                                    = 1,
                CalculatePriceError                             = 2,
                NullTariff                                      = 3,
                NullTariffGroup                                 = 4,
                NullTariffData                                  = 5,
                PrinterTemplateNotFound                         = 6,
                DontPrint                                       = 7,
                PrintError                                      = 8,
                WriteStatisticError                             = 9,
                BadOutputStatisticData                          = 10,
                WrongInputParameters                            = 11,
                CardBlocked                                     = 12,
                CardNotSell                                     = 13,
                InvalidCard                                     = 14,
                NoEmployeeCard                                  = 15,
                NoEmployeeTariff                                = 16,
                ModuleNotFound                                  = 17,
                BadPaymentType                                  = 18,
                NullWriteRequest                                = 19,
                ErrorIssueTicket                                = 20,
                ErrorIssueTicketRestricted                      = 21,
                ErrorIssueTicketCaseLow                         = 22,
                ValidTicket                                     = 23,
                OtherCard                                       = 24,
                ValueUnderLimit                                 = 25,
                ValueOverLimit                                  = 26,
                BadPurseCardData                                = 27,
                MaxPurseBalanceExceeded                         = 28,
                ErrorInitModules                                = 29,
                ErrorActivateCardNoSpaceOnCard                  = 30,
                ErrorInactiveCard                               = 31,
                ErrorInvalidTransportSection                    = 32,
                ErrorCancelationTicket                          = 33,
                NotFoldOfValue                                  = 34,
                BadCommonCardData                               = 35,
                NoSpaceOnCard                                   = 36,
                ErrorWhileFillingNewTimeTicket                  = 37,
                ErrorCancelTimeTicket                           = 38,
                StornoDisabled                                  = 39,
                TimeTicketNotFound                              = 40,
                TimeTicketNotValid                              = 41,
                BadServiceCardData                              = 42,
                ErrorProcessServiceData                         = 43,
                AuditorCheckIn                                  = 44,
                AuditorCheckOut                                 = 45,
                BadTimeTicketCardData                           = 46,
                BadUserInputData                                = 47,
                ErrorPrepareOutputStatisticData                 = 48,
                ErrorPrepareOutputPreIssueData                  = 49,
                ErrorPrepareOutputPostIssueData                 = 50,
                ErrorPrepareTicketOutputData                    = 51,
                RestrictedZones                                 = 52,
                PassNumberRequired                              = 53,
                ErrorPreparePrintData                           = 54,
                ErrorCreateRequest                              = 55,
                ErrorInvalidCardDiscount                        = 56,
                ErrorCardValidityExpired                        = 57,
                BadOneWayTicketCardData                         = 58,
                ErrorInvalidPurse                               = 59,
                ErrorBuyTicketForOwnerFirst                     = 60,
                ErrorInvalidTariffToCard                        = 61,
                ErrorIssueOnPortableWallet                      = 62,
                ErrorParsingFile                                = 63,
                ErrorProcessingCheckOut                         = 64,
                ValidCheckOut                                   = 65,
                FellowTravelersCanAlsoDoTransfer                = 66,
                ErrorActivateTimeTicket                         = 67,
                ErrorInvalidUrbanTranportNumber                 = 68,
                RestrictedCheckInOutSystem                      = 69,
                ErrorPrepareCardTicketIndex                     = 70,
                NullInternalPointer                             = 71, // error TicketIssueLogic initialization. Core member is NULL
                ErrorOtherCompanyAuditor                        = 72,
                CannotCancelOwnersTicketWithFellowTravelers     = 73,
                NoValidTimeTicket                               = 74, //OWT autoissue is forbidden in input data, and no valid TT was found on the card
                ExceededMaximumInterchangeTime                  = 75,
                ErrorDisallowedCardCompanyForJourney            = 76,
                TimeValidOneWayTicketToOverwrite                = 77,
                ErrorDisallowedCardCompanyForCreditRecharge     = 78,
                ErrorIssueTicketOnLastStop                      = 79,
                BuySurchargeForSpatiallyInvalidTimeTicket       = 80,
                ErrorTooManyPassengers                          = 81,
                ErrorAdditionalSynchronousRead                  = 82,
                ErrorDiscountMismatch                           = 83,
                ErrorDiscountExpiredOverAge                     = 84,
                BadLogCardData                                  = 85,
                ErrorPostProcessBywayTripSection                = 86,
                NoAuditorCardOnAuditorOperation                 = 87,
                UnsupportedOperation                            = 88,
                ErrorCreateFile                                 = 89,
                InsufficientTicketTimeValidityForSelectedTrip   = 90,
                ErrorPostProcessRemoveSectionOnBorderOfZonation = 91,
                ErrorDisallowedCardForJourney                   = 92,
                RestrictedCashCreditRecharge                    = 93,
                PrintErrorObstacleInPrinterTray                 = 94,
                DisallowedCardPaymentOnBusStopInForeignCountry  = 95,
                ErrorTimeTicketExceedsCardValidity              = 96,
                DifferentAreaForFellowTravellerAndTicketOwner   = 97,
                BadCappingCardData                              = 98,
                UnsupportedCardMediumForInterchangableTicket    = 99,
                DomesticIssueForbidden                          = 100,
                ErrorCashPriceRounding                          = 101,

                UnitTestErrorOffset                             = 1000
            };

            /*
                toto je v datainpute ako enum, len to je v zlom hlavickovom subore
            */
            enum PaymentType
            {
                PaymentUndefined                                = -1,
                PaymentCash                                     = 0,
                PaymentChipCard                                 = 1,
                PaymentBankCard                                 = 2,
                PaymentInvoice                                  = 3,
                PaymentMarker                                   = 5,
                PaymentCorrectionEvent                          = 9,
                PaymentViaInternet                              = 10,
                PaymentCoiner                                   = 11,
                PaymentCoupon                                   = 12,
                PaymentAggregationEMVCard                       = 13,
                PaymentAggregationAccountTD                     = 14,
                PaymentQrCode                                   = 15,
                PaymentOther
            };

            static std::string PaymentTypeToString( const PaymentType paymentType );

            enum OperationType
            {
                OperationUndefined                              = -1,
                OperationSell                                   = 0,
                OperationCancel                                 = 1,
                OperationCreditRecharge                         = 2,
                OperationCancelCreditRecharge                   = 3,
                // UNUSED                                       = 4,
                OperationTimeTicketSell                         = 5,
                OperationTimeTicketCancel                       = 6,
                OperationAuditor                                = 7,
                OperationSurchargeSell                          = 8,
                OperationCoinerOverfall                         = 9,
                OperationAdditionalTariffAreaSurcharge          = 10,
                OperationForbiddenCard                          = 11,
                /*
                 * TerminalSell - selling ticket on stationary terminal (SelfServiceValidator, PreSale terminal, automatic vending machine)
                 * Very similar to OperationSell, but it has not specified line, trip or bus stops
                 */
                OperationTerminalSell                           = 12,
                OperationUnpaidExpense                          = 13,
                OperationPriceCalculation                       = 14,
                OperationTimeTicketPriceCalculation             = 15,
                /*
                 * TicketRegistration - Redmine task 1890 - selling registration ticket is very similar operation as OperationSell. Only one exception. This ticket will not be written on card.
                 *
                 * This operation is set from application based on tariff templateID 'RegistrationTicket'( ETarifa::RegistrationTicket )
                 */
                OperationTicketRegistration                     = 16
            };

            static std::string OperationTypeToString( const OperationType operationType );

            enum CardWriteOperations
            {
                CardWriteNothing                                = 0x00,
                CardWriteAuditor                                = 0x01,
                CardWriteOneWayTickets                          = 0x02,
                CardWriteWallet                                 = 0x04,
                CardWriteTimeTickets                            = 0x08
            };

            enum ModuleFamily
            {
                FamilyUndefinedModules                          = -1,
                FamilyPrintModules                              = 0,
                FamilyStatisticModules                          = 1,
                FamilyCommonModules                             = 2,
                FamilyOneWayTicketModules                       = 3,
                FamilyTimeTicketModules                         = 4,
                FamilyCreditRechargeModules                     = 5,
                FamilyInterchangeModules                        = 6,
                FamilyCancelationModules                        = 7,
                FamilyCardActivationModules                     = 8,
                FamilyCombinedTicketModules                     = 9,
                FamilyTimeTicketSellModules                     = 10,
                FamilyServiceModules                            = 11,
                FamilyCrossTransferModules                      = 12,
                FamilyZoneModules                               = 13,
                FamilyTimeTicketActivationModules               = 14,
                FamilyCheckinCheckoutModules                    = 15,
                // UNUSED VALUE (16)
                FamilyCalculatePriceModules                     = 17,
                FamilyRegionCardModules                         = 18,
                FamilyTripSectionModules                        = 19,
                FamilyWalletModules                             = 20,
                // UNUSED VALUE (21)
                FamilyAlternativeTripModules                    = 22,
                FamilyOutputDataModules                         = 23,
                FamilyTripSectionPostProcessModules             = 24,
                FamilyValidTicketAcceptanceModules              = 25,
                FamilyCashPriceRoundingModules                  = 26,
                FamilyCount                                     = 27 // had to be always last with biggest number
            };

            enum IssueType
            {
                IssueUndefined                                  = -1,
                IssueAuto                                       = 0,
                IssueManual                                     = 1
            };

            enum TripSectionType
            {
                TripSectionUndefined                            = -1,
                TripSectionOnTimeTicket                         = 0,
                TripSectionOnCash                               = 2,
                TripSectionAdditionalZonesCharged               = 3, // special section created for additinal zones after trip (after checkout bus stop) that will be charged
                TripSectionAdditionalZonesFree                  = 4, // special section created for additinal zones after trip (after checkout bus stop) that are covered by time ticket, thus will not be charged
                TripSectionKilometersFree                       = 5  // special section created for free kilometers. For example 'one bus stop section' on border of zonation
            };

            enum PreparePrintType
            {
                ProcessLastTicket                               = 0,
                ProcessAllTickets                               = 1
            };

            enum TransferForAllTicketsOnCard
            {
                TransferForAllTicketsAsk                        = 0,
                TransferForAllTicketsOn                         = 1,
                TransferForAllTicketsOff                        = 2
            };

            enum ProlongTicketsTimeValidity
            {
                ProlongTicketsTimeValidityOff                   = 0,
                ProlongTicketsTimeValidityOwnerOnly             = 1,
                ProlongTicketsTimeValidityAllTickets            = 2
            };

            enum OneWayTicketCardPositioning
            {
                OneWayTicketCardPositioningIncremental           = 0,
                OneWayTicketCardPositioningSeparated             = 1
            };

            enum CICOStatus
            {
                CICOStatusUndefined                              = 0,
                CICOStatusPossibleCheckout                       = 1,
                CICOStatusValidCheckinTicket                     = 2,
                CICOStatusValidCheckoutTicket                    = 3
            };

            enum CardType
            {
                CardTypeWithoutDiscount                          = 1,
                CardTypeHalfChild                                = 2,
                CardTypeFreeOfCharge                             = 3,
                CardTypeStudent                                  = 4,
                CardTypePensionerToSeventyYears                  = 5,
                CardTypePensionerOverSeventyYears                = 6,
                CardTypePupil                                    = 7,
                CardTypePortable                                 = 8,
                CardTypeBulk                                     = 9,
                CardTypeTourist                                  = 10,
                CardTypeSpecial11                                = 11,
                CardTypeSpecial12                                = 12,
                CardTypeEmployee                                 = 13,
                CardTypeSpecial2                                 = 14,
                CardTypeSpecial3                                 = 15,
                CardTypeAdultOverFifteen                         = 16,
                CardTypeAdult                                    = 101,
                CardTypeChild                                    = 102,
                CardTypeStudentToTwentySixYears                  = 103,
                CardTypePensioner                                = 104,
                CardTypeInvalidityPensioner                      = 105,
                CardTypeStaff                                    = 109,
                CardTypeScholar                                  = 119,
                CardTypeJanskyGoldPlaqueHolder                   = 148,
                CardTypeFamilyMemberOverFifteenYears             = 149,
                CardTypePersonOverSixtyFiveYears                 = 150,
                CardTypePersonOverSeventyYears                   = 151,
                CardTypePersonOverEightyYears                    = 152,
                CardTypeZTPLicenseHolder                         = 153,
                CardTypeZTPPLicenseHolder                        = 154,
                CardTypeFamilyMemberFromSixToFifteen             = 155,
                CardTypeFamilyMemberFromFifteenToTwentySix       = 156,
                CardTypeFamilyMemberPensioner                    = 157,
                CardTypeOrganization                             = 162,
                CardTypeAnonym                                   = 163
            };

            enum PeripheralsStatisticEventType
            {
                PeripheralsEventUndefined                        = 0,
                PeripheralsEventAuditorCheckInBlock              = 1,
                PeripheralsEventAuditorCheckOutUnblock           = 2,
                PeripheralsEventDriverManualBlock                = 3,
                PeripheralsEventDriverManualUnblock              = 4,
                PeripheralsEventAutoUnblockOnBusStopArrival      = 5
            };

            /*
             * Detailf for ticket index saved in datastorage, @see ETicketIssueLogicDataStorage::GetCardTicketIndexToUse
             */
            enum TicketIndexDetail
            {
                TicketIndexDetailNoDetail                           = 0,
                TicketIndexDetailNoSpaceOnCardForOWT                = 1,
                TicketIndexDetailOWTWithoutWriteOnCard              = 2,
                TicketIndexDetailFellowTravllerWithoutWriteOnCard   = 3,
                TicketIndexDetailOWTWithoutWriteOnCardOnOBC         = 4,
                TicketIndexDetailDifferentCardAndTariffNetwork      = 5
            };

            enum PriceComputeUnit
            {
                PriceComputeUnitUndefined                        = 0,
                PriceComputeUnitKilometers                       = 1,
                PriceComputeUnitZones                            = 2,
                PriceComputeUnitCount                            = 3
            };

            enum RegionCode
            {
                RegionCodeBratislavaCityCard                     = 0x01,
                // 0x02 - see CityCode
                RegionCodeMartin                                 = 0x04, // multiCARD
                RegionCodeKosiceCityCard                         = 0x08,
                // 0x10 - see CityCode
                RegionCodeBratislava                             = 0x20
            };

            enum CityCode
            {
                // 0x01 - see RegionCode
                CityCodeTrencin                                  = 0x02,
                // 0x04 - see RegionCode
                // 0x08 - see RegionCode
                    CityCodeBratislava                               = 0x10,
                    // 0x20 - see RegionCode
                    CityCodeMartin                                   = 0x80,
                    CityCodeMartinSuburban                           = 0x100
            };

            enum EMVTransactionData
            {
                EMVTransactionDataCardNumber                     = 1,
                EMVTransactionDataCardBranch                     = 2,
                EMVTransactionDataApprovalCode                   = 3,
                EMVTransactionDataSerialNumber                   = 4,
                EMVTransactionDataTerminalId                     = 5,
                EMVTransactionDataInvoiceNumber                  = 6
            };
        };
    }
}

#endif // EISSUELOGICDEFINES_H