Modularity::SPI::Report Class Reference

This class contains all the requiered operations for Reports. More...

#include <Report.h>

Public Member Functions
SPILIBRARY_API	Report (ReportType Type)
	Report constructor.
SPILIBRARY_API string	GetDate () const
	Get date and time report was created.
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().
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.
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()
SPILIBRARY_API std::string	GetACKNumber () const
	Get ACK (batch) number from the processor.
SPILIBRARY_API SPI_RET_VAL	GetTotal (AmountType &OutputAmount, CounterType &OutputCounter) const
	Get total amount of all regular transaction (not refund) Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.
SPILIBRARY_API SPI_RET_VAL	GetTotalRefunds (AmountType &OutputAmount, CounterType &OutputCounter) const
	Get total amount of all refund transaction Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.
SPILIBRARY_API SPI_RET_VAL	GetTotalCancellations (AmountType &OutputAmount, CounterType &OutputCounter) const
	Get total amount of all cancel transaction Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.
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 Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.
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 Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.
APIHandle	GetReportHandle () const
	Reserved for internal useage.

Detailed Description

This class contains all the requiered operations for Reports.

Examples:

CPP_Examples.cpp.

Definition at line 29 of file Report.h.

Constructor & Destructor Documentation

SPILIBRARY_API Modularity::SPI::Report::Report

(

ReportType

Type

)

Report constructor.

Parameters

[in]

Type

is enumerator specifing the type of the constructed report.

Member Function Documentation

SPILIBRARY_API std::string Modularity::SPI::Report::GetACKNumber

(

)

const

Get ACK (batch) number from the processor.

Returns

SPI_SUCESS if operation is premitted.

SPILIBRARY_API string Modularity::SPI::Report::GetDate

(

)

const

Get date and time report was created.

Returns

std::string formmated "dd/mm/yyyy hh:MM" where hh:MM is 24-hours format.

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::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().

Parameters

[out]

OutputResult

is a std::string where the result will be wtitten.

Returns

SPI_SUCESS if operation is premitted.

See Also

Service::EndOfDay()

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::GetTotal	(	AmountType &	OutputAmount,
		CounterType &	OutputCounter
	)		const

Get total amount of all regular transaction (not refund) Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.

Parameters

[out]	OutputAmount	is a number that represents the total amount in money.
[out]	OutputCounter	is a number that represents the number of transaction counted for OutputAmount.

Returns

SPI_SUCESS if operation is premitted.

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

Get total amount of all regular transaction (not refund) by Solek Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.

Parameters

[in]	Solek	is enumerator that represent the Solek.
[out]	OutputSolekName	is std::string with the Solek name in Hebrew UTF-8.
[out]	OutputAmount	is a number that represents the total amount in money.
[out]	OutputCounter	is a number that represents the number of transaction counted for OutputAmount.

Returns

SPI_SUCESS if operation is premitted.

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::GetTotalCancellations	(	AmountType &	OutputAmount,
		CounterType &	OutputCounter
	)		const

Get total amount of all cancel transaction Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.

Parameters

[out]	OutputAmount	is a number that represents the total amount in money.
[out]	OutputCounter	is a number that represents the number of transaction counted for OutputAmount.

Returns

SPI_SUCESS if operation is premitted.

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

Get total amount of all refund transaction by Solek Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.

Parameters

[in]	Solek	is enumerator that represent the Solek.
[out]	OutputSolekName	is std::string with the Solek name in Hebrew UTF-8.
[out]	OutputAmount	is a number that represents the total amount in money.
[out]	OutputCounter	is a number that represents the number of transaction counted for OutputAmount.

Returns

SPI_SUCESS if operation is premitted.

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::GetTotalRefunds	(	AmountType &	OutputAmount,
		CounterType &	OutputCounter
	)		const

Get total amount of all refund transaction Known Issue: should be seperated by currencies. Currently supported only with X_REPORT.

Parameters

[out]	OutputAmount	is a number that represents the total amount in money.
[out]	OutputCounter	is a number that represents the number of transaction counted for OutputAmount.

Returns

SPI_SUCESS if operation is premitted.

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::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()

Parameters

[out]

OutputResult

is a std::string where the result will be wtitten.

Returns

SPI_SUCESS if operation is premitted.

See Also

Service::EndOfDay()

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::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.

Parameters

[out]

OutputResult

is a std::string where the result will be wtitten.

Returns

SPI_SUCESS if operation is premitted.

See Also

Service::EndOfDay()

---

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

• Report.h