Modularity::SPI::Report Class Reference

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

#include <Report.h>

Inheritance diagram for Modularity::SPI::Report:

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) Supported only with ACCM_REPORT and X_REPORT.
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.
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.
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.
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.
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.
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.
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.
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.
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.
SPILIBRARY_API string	GetAccumlateStartDate () const
	Get date and time report started to accumlate.
SPILIBRARY_API SPI_RET_VAL	ResetAccumlateReport () const
	Reset the accumlated report queried.
SPILIBRARY_API std::vector < AcquiredBrandInfo >	GetAcquiredBrandsInformation () const
	Reset the accumlated report queried.
SPILIBRARY_API SPI_RET_VAL	ResetEntityVersion ()
	Reset AshraitEMV entity version to get full set of parameters from SHVA.
SPILIBRARY_API SPI_RET_VAL	SetUIDSuffix (std::string UidSuffix)
	Set 4 last digits of AshraitEMV Transaction UID.
SPILIBRARY_API std::vector < std::string >	GetQueriedTransactions () const
	Get transactions Queried. Supports only AshraitEMV.
SPILIBRARY_API std::vector < std::string >	GetCanceledTransactions () const
	Get transactions that declined after authorization. Supports only AshraitEMV.
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.
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.
APIHandle	GetReportHandle () const
	Reserved for internal useage.
Multi Retailer
Special operations using AshraitEMV
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.
SPILIBRARY_API std::vector < std::string >	GetQueriedSubRetailers () const
	Get all subretailers Queried. Supports only AshraitEMV.
SPILIBRARY_API void	SetSubRetailer (string SubRetailer)
	Set sub retailer for the report execution. This operation is valid only for MINI_SETTLEMENT_REPORT.
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 requiered operations for Reports.

Examples:

CPP_Examples.cpp.

Definition at line 30 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 string Modularity::SPI::Report::GetAccumlateStartDate

(

)

const

Get date and time report started to accumlate.

Returns

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

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 std::vector<AcquiredBrandInfo> Modularity::SPI::Report::GetAcquiredBrandsInformation

(

)

const

Reset the accumlated report queried.

Returns

A vector of acquiers

SPILIBRARY_API std::vector<std::string> Modularity::SPI::Report::GetCanceledTransactions

(

)

const

Get transactions that declined after authorization. Supports only AshraitEMV.

Returns

A vector of transaction UID's (AshraitEMV)

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 std::vector<EndOfDayReportInfo> Modularity::SPI::Report::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.

Returns

A vector of reports information

See Also

Service::DoReport()

SPILIBRARY_API std::vector<std::string> Modularity::SPI::Report::GetQueriedSubRetailers

(

)

const

Get all subretailers Queried. Supports only AshraitEMV.

Returns

A vector of sub retailers (AshraitEMV) to use with SetSubRetailerFor()

SPILIBRARY_API std::vector<std::string> Modularity::SPI::Report::GetQueriedTransactions

(

)

const

Get transactions Queried. Supports only AshraitEMV.

Returns

A vector of transaction UID's (AshraitEMV)

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

Get total amount of all regular transaction (not refund) Supported only with ACCM_REPORT and 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 Supported only with ACCM_REPORT and 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::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.

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 Supported only with ACCM_REPORT and 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::GetTotalCancellationsUsd	(	AmountType &	OutputAmount,
		CounterType &	OutputCounter
	)		const

Get total amount of all cancel transaction in USD Supported only with ACCM_REPORT and 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 Supported only with ACCM_REPORT and 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::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.

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 Supported only with ACCM_REPORT and 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::GetTotalRefundsUsd	(	AmountType &	OutputAmount,
		CounterType &	OutputCounter
	)		const

Get total amount of all refund transaction in USD Supported only with ACCM_REPORT and 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::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.

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::ResetAccumlateReport

(

)

const

Reset the accumlated report queried.

Returns

SPI_SUCESS if operation is premitted.

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::ResetEntityVersion

(

)

Reset AshraitEMV entity version to get full set of parameters from SHVA.

Returns

SPI_SUCESS if operation is premitted SPI_FAIL otherwise.

See Also

Service::EndOfDay()

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

Parameters

[in]

ACK

Number

Returns

SPI_SUCESS if operation is premitted SPI_FAIL otherwise.

See Also

Service::DoReport()

SPILIBRARY_API void Modularity::SPI::Report::SetSubRetailer

(

string

SubRetailer

)

Set sub retailer for the report execution. This operation is valid only for MINI_SETTLEMENT_REPORT.

Returns

this Report object as ptr

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

Returns

this Report object as ptr

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Report::SetUIDSuffix

(

std::string

UidSuffix

)

Set 4 last digits of AshraitEMV Transaction UID.

Parameters

[in]

UidSuffix

is the 4 last digit of UID.

Returns

SPI_SUCESS if operation is premitted SPI_FAIL otherwise.

See Also

Service::DoReport()

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