ParseAggregate Method

Parses the aggregate returned from another component's GetDetailAggregate method.

Syntax

fdmsdetailrecord.parseAggregate(aggregate, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method takes the XML aggregate returned from the FDMSRetail or FDMSECommerce class, parses it, and then fills all the properties of the FDMSDetailRecord class. While normally you can pass the results of the GetDetailAggregate method call directly to the FDMSSettle class, sometimes it is necessary to adjust the contents of the XML aggregate first.

For example, to add a gratuity to a charge:

  FDMSDetailRecord.ParseAggregate(FDMSRetail.GetDetailAggregate())
  FDMSDetailRecord.Gratuity = "500"
  FDMSDetailRecord.TransactionAmount = FDMSDetailRecord.TransactionAmount + FDMSDetailRecord.Gratuity
  FDMSSettle.DetailAggregate(0) = FDMSDetailRecord.GetDetailAggregate()