Report.h

Go to the documentation of this file.

#ifndef __REPORT__H_
#define __REPORT__H_


#include "SPIDEF.h"
#include "types.def"
#include <string>
#include <vector>

using std::string;

namespace Modularity {

    namespace SPI {
        class  Report
        {
            APIHandle ReportHandle; 
        public:

            SPILIBRARY_API Report(ReportType Type);



            SPILIBRARY_API string GetDate() const;

            SPILIBRARY_API SPI_RET_VAL GetPrintableString(std::string & OutputResult) const;

            SPILIBRARY_API SPI_RET_VAL SetZReportFormat(ZReportFormat Format) ;

            SPILIBRARY_API SPI_RET_VAL GetZReportString(std::string & OutputResult) const;

            SPILIBRARY_API std::string GetACKNumber() const;

            SPILIBRARY_API SPI_RET_VAL GetTotal(AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API SPI_RET_VAL GetTotalRefunds(AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API SPI_RET_VAL GetTotalCancellations(AmountType & OutputAmount, CounterType & OutputCounter) const ;

            SPILIBRARY_API SPI_RET_VAL GetTotalBySolek(Ashrait::Solek Solek, std::string & OutputSolekName, AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API SPI_RET_VAL GetTotalRefundBySolek(Ashrait::Solek Solek,std::string & OutputSolekName, AmountType & OutputAmount, CounterType & OutputCounter) const;


            SPILIBRARY_API SPI_RET_VAL GetTotalUsd(AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API SPI_RET_VAL GetTotalRefundsUsd(AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API SPI_RET_VAL GetTotalCancellationsUsd(AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API SPI_RET_VAL GetTotalBySolekUsd(Ashrait::Solek Solek, std::string & OutputSolekName, AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API SPI_RET_VAL GetTotalRefundBySolekUsd(Ashrait::Solek Solek, std::string & OutputSolekName, AmountType & OutputAmount, CounterType & OutputCounter) const;

            SPILIBRARY_API string GetAccumlateStartDate() const;

            SPILIBRARY_API SPI_RET_VAL ResetAccumlateReport() const;


            SPILIBRARY_API std::vector<AcquiredBrandInfo>   GetAcquiredBrandsInformation() const;


            SPILIBRARY_API SPI_RET_VAL ResetEntityVersion();

            SPILIBRARY_API SPI_RET_VAL SetUIDSuffix(std::string UidSuffix);


            SPILIBRARY_API std::vector<std::string> GetQueriedTransactions() const;

            SPILIBRARY_API std::vector<std::string> GetCanceledTransactions() const;

            SPILIBRARY_API std::vector<EndOfDayReportInfo>  GetQueriedReports() const;

            SPILIBRARY_API SPI_RET_VAL SetACKNumber(std::string ACKNumber);
 

            SPILIBRARY_API Report* SetSubRetailerFor(string SubRetailer);

            SPILIBRARY_API std::vector<std::string> GetQueriedSubRetailers() const;

            SPILIBRARY_API void SetSubRetailer(string SubRetailer);

            SPILIBRARY_API void SetSilent();


            SPILIBRARY_API virtual ~Report();


            APIHandle GetReportHandle() const;
        };

    }

}

#endif