SPI  1.2404.0
Secured Payment Interface
Public Member Functions | List of all members
Modularity::SPI::CibusReport Class Reference

This class contains all the input data and output data of Cibus transactions, including the methods inherited from class Transaction. All data in this class is reachable through various methods which define the behaivor of the operation. More...

#include <CibusReport.h>

Inheritance diagram for Modularity::SPI::CibusReport:
Modularity::SPI::Report

Public Member Functions

virtual SPILIBRARY_API ~CibusReport ()
 Class desrstructor.
 
APIHandle GetCibusHandle () const
 Handle get - reserved for internal useage.
 
Cibus Pre execute info

Those methods can be called before Cibus report is executed.

SPILIBRARY_API CibusReport (Cibus::CibusReportType ReportType)
 Class constructor. Do report of the specified type. More...
 
Post execute info

Those methods can be called after transaction is executed.

SPILIBRARY_API std::vector< Cibus::Company > GetCompanies () const
 Get Companies after DoReport executed. More...
 
- Public Member Functions inherited from Modularity::SPI::Report
SPILIBRARY_API Report (ReportType Type)
 Report constructor. More...
 
SPILIBRARY_API string GetDate () const
 Get date and time report was created. More...
 
SPILIBRARY_API SPI_RET_VAL GetPrintableString (std::string &OutputResult) const
 Get printable string of the report created. This string come in ASCII from the service processor during end of day process. Currently supported only with Z_REPORT. This function is depracted. Please use GetZReportString(). More...
 
SPILIBRARY_API SPI_RET_VAL SetZReportFormat (ZReportFormat Format)
 Set the format of the ZReport. The call to this method is elective. Deafult format called by the manufacture when registering the retailer to the processor. More...
 
SPILIBRARY_API SPI_RET_VAL GetZReportString (std::string &OutputResult) const
 Get the ZReport created by EndOfDay() or DoReport() as configured in SetZReportFormat(). This method is the new alternative to GetPrintableString() More...
 
SPILIBRARY_API std::string GetACKNumber () const
 Get ACK (batch) number from the processor. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotal (AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all regular transaction (not refund) Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalRefunds (AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all refund transaction Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalCancellations (AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all cancel transaction Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalBySolek (Ashrait::Solek Solek, std::string &OutputSolekName, AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all regular transaction (not refund) by Solek Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalRefundBySolek (Ashrait::Solek Solek, std::string &OutputSolekName, AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all refund transaction by Solek Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalUsd (AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all regular transaction (not refund) in USD Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalRefundsUsd (AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all refund transaction in USD Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalCancellationsUsd (AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all cancel transaction in USD Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalBySolekUsd (Ashrait::Solek Solek, std::string &OutputSolekName, AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all regular transaction (not refund) by Solek in USD Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API SPI_RET_VAL GetTotalRefundBySolekUsd (Ashrait::Solek Solek, std::string &OutputSolekName, AmountType &OutputAmount, CounterType &OutputCounter) const
 Get total amount of all refund transaction by Solek in USD Supported only with ACCM_REPORT and X_REPORT. More...
 
SPILIBRARY_API string GetAccumlateStartDate () const
 Get date and time report started to accumlate. More...
 
SPILIBRARY_API SPI_RET_VAL ResetAccumlateReport () const
 Reset the accumlated report queried. More...
 
SPILIBRARY_API std::vector< AcquiredBrandInfo > GetAcquiredBrandsInformation () const
 Reset the accumlated report queried. More...
 
SPILIBRARY_API SPI_RET_VAL ResetEntityVersion ()
 Reset AshraitEMV entity version to get full set of parameters from SHVA. More...
 
SPILIBRARY_API SPI_RET_VAL SetUIDSuffix (std::string UidSuffix)
 Set 4 last digits of AshraitEMV Transaction UID.
More...
 
SPILIBRARY_API std::vector< std::string > GetQueriedTransactions () const
 Get transactions Queried. Supports only AshraitEMV. More...
 
SPILIBRARY_API std::vector< std::string > GetCanceledTransactions () const
 Get transactions that declined after authorization. Supports only AshraitEMV. More...
 
SPILIBRARY_API std::vector< EndOfDayReportInfo > GetQueriedReports () const
 Get all End Of Day reports on AshraitService. Should be used with ReportType::QUERY_REPORTS This method works only remoted Ashrait running on Agamento. More...
 
SPILIBRARY_API SPI_RET_VAL SetACKNumber (std::string ACKNumber)
 Set ACK Number to query that End Of Day report on AshraitService. Should be used with ReportType::QUERY_REPORTS This method works only remoted Ashrait running on Agamento. More...
 
APIHandle GetReportHandle () const
 Reserved for internal useage.
 
SPILIBRARY_API Report * SetSubRetailerFor (string SubRetailer)
 Set sub retailer for the next method execution on the object. The string setted is only relevant for the next call. For convenience the called object is returned as pointer to concat the execution. More...
 
SPILIBRARY_API std::vector< std::string > GetQueriedSubRetailers () const
 Get all subretailers Queried. Supports only AshraitEMV. More...
 
SPILIBRARY_API void SetSubRetailer (string SubRetailer)
 Set sub retailer for the report execution. This operation is valid only for MINI_SETTLEMENT_REPORT. More...
 
SPILIBRARY_API void SetSilent ()
 Silent execution on remote service. This operation is valid only for MINI_SETTLEMENT_REPORT.
 
virtual SPILIBRARY_API ~Report ()
 DTOR.
 

Detailed Description

This class contains all the input data and output data of Cibus transactions, including the methods inherited from class Transaction. All data in this class is reachable through various methods which define the behaivor of the operation.

Definition at line 32 of file CibusReport.h.

Constructor & Destructor Documentation

◆ CibusReport()

SPILIBRARY_API Modularity::SPI::CibusReport::CibusReport ( Cibus::CibusReportType  ReportType)

Class constructor. Do report of the specified type.

Parameters
[in]ReportTypetype of report to execute

Member Function Documentation

◆ GetCompanies()

SPILIBRARY_API std::vector<Cibus::Company> Modularity::SPI::CibusReport::GetCompanies ( ) const

Get Companies after DoReport executed.

Returns
vector of companies loaded from cibus

The documentation for this class was generated from the following file: