VirtueMart  3.2.14.9808
Public Member Functions | Private Attributes | List of all members
SearchTaxHistoryResult Class Reference

Public Member Functions

 getTaxResults ()
 
 getLastDocId ()
 
 getTransactionId ()
 
 getResultCode ()
 
 getMessages ()
 

Private Attributes

 $GetTaxResults
 
 $LastDocId
 
 $TransactionId
 
 $ResultCode = 'Success'
 
 $Messages = array()
 

Member Function Documentation

SearchTaxHistoryResult::getLastDocId ( )

Indicates the last Document Code (GetTaxResult#getDocId) the results list.

If getGetTaxResults is not empty, then this LastDocId should be passed to the next ReconcileTaxHistoryRequest. If getGetTaxResults is empty, then this LastDocId can be passed to ReconcileTaxHistoryRequest with the request's ReconcileTaxHistoryRequest#isReconciled flag set to true in order to reconcile all documents up to and including the LastDocId.

See also
ReconcileTaxHistoryResult
Returns
string
SearchTaxHistoryResult::getMessages ( )

Accessor

Returns
array
SearchTaxHistoryResult::getResultCode ( )

Accessor

Returns
string
SearchTaxHistoryResult::getTaxResults ( )

Gets zero or more GetTaxResult summaries matching search criteria.

If LastDocId was not specified by the ReconcileTaxHistoryRequest, then this is the first set of records that need reconciliation. If LastDocId was specified, the collection represents the next set of records after LastDocId. If the collection is empty, then all records have been reconciled and the result's LastDocId will be set to the last record of the last result set.
The GetTaxResults are returned in an Axis wrapper ArrayOfGetTaxResult, which has a raw GetTaxResult[] array accessible via its ArrayOfGetTaxResult#getGetTaxResult method.

Example:
$result = $taxSvc->reconcileTaxHistory($request);
foreach($result->getTaxResults() as $taxResult)
{
     ...
}
 
See also
GetTaxResult
Returns
array
SearchTaxHistoryResult::getTransactionId ( )

Accessor

Returns
string

Member Data Documentation

SearchTaxHistoryResult::$GetTaxResults
private
SearchTaxHistoryResult::$LastDocId
private
SearchTaxHistoryResult::$Messages = array()
private
SearchTaxHistoryResult::$ResultCode = 'Success'
private
SearchTaxHistoryResult::$TransactionId
private

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