com.avalara.avatax.services.tax
Class SearchTaxHistoryResult

java.lang.Object
  extended by com.avalara.avatax.services.tax.BaseResult
      extended by com.avalara.avatax.services.tax.SearchTaxHistoryResult
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ReconcileTaxHistoryResult

public class SearchTaxHistoryResult
extends BaseResult
implements java.io.Serializable

Result data returned from TaxSvcSoap.reconcileTaxHistory(com.avalara.avatax.services.tax.ReconcileTaxHistoryRequest). This class encapsulates the data and methods used by ReconcileTaxHistoryResult.

See Also:
ReconcileTaxHistoryRequest, Serialized Form

Constructor Summary
SearchTaxHistoryResult()
          Initializes a new instance of the class.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Determines whether the specified Object is equal to the current Object.
static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Axis Custom Deserializer; this method is used internally by the adapter and not intended to be used by external implementation code.
 ArrayOfGetTaxResult getGetTaxResults()
          Gets zero or more GetTaxResult summaries matching search criteria.
 java.lang.String getLastDocId()
          Indicates the last Document Code (GetTaxResult.getDocId()) the results list.
static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Axis Custom Serializer; this method is used internally by the adapter and not intended to be used by external implementation code.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return Axis type metadata object; this method is used internally by the adapter and not intended to be used by external implementation code.
 int hashCode()
          Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
 void setGetTaxResults(ArrayOfGetTaxResult getTaxResults)
          Sets zero or more GetTaxResult summaries matching search criteria.
 void setLastDocId(java.lang.String lastDocId)
          Indicates the last Document Code (GetTaxResult.getDocId()) the results list.
 
Methods inherited from class com.avalara.avatax.services.tax.BaseResult
getMessages, getResultCode, getTransactionId, setMessages, setResultCode, setTransactionId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchTaxHistoryResult

public SearchTaxHistoryResult()
Initializes a new instance of the class.

Method Detail

getGetTaxResults

public ArrayOfGetTaxResult getGetTaxResults()
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:
 [Java]
 ReconcileTaxHistoryResult result = new taxSvc.reconcileTaxHistory(request);
 ArrayOfGetTaxResult resultArr = result.getGetTaxResults();
 int numTaxResults = (resultArr == null ||
         resultArr.getGetTaxResult() == null ? 0 :
         resultArr.getGetTaxResult().length);
 for (int i = 0 ; i < numTaxResults; i++)
 {
      GetTaxResult taxResult = resultArr.getGetTaxResult(i);
      ...
 }

 

Returns:
getTaxResults

setGetTaxResults

public void setGetTaxResults(ArrayOfGetTaxResult getTaxResults)
Sets 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:
 [Java]
 ReconcileTaxHistoryResult result = new taxSvc.reconcileTaxHistory(request);
 ArrayOfGetTaxResult resultArr = result.getGetTaxResults();
 int numTaxResults = (resultArr == null ||
         resultArr.getGetTaxResult() == null ? 0 :
         resultArr.getGetTaxResult().length);
 for (int i = 0 ; i < numTaxResults; i++)
 {
      GetTaxResult taxResult = resultArr.getGetTaxResult(i);
      ...
 }

 

Parameters:
getTaxResults -

getLastDocId

public java.lang.String 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.

Returns:
lastDocId
See Also:
ReconcileTaxHistoryResult

setLastDocId

public void setLastDocId(java.lang.String lastDocId)
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.

Parameters:
lastDocId -
See Also:
ReconcileTaxHistoryResult

equals

public boolean equals(java.lang.Object obj)
Determines whether the specified Object is equal to the current Object. Note: In current implementation all Java Strings members of the two objects must be exactly alike, including in case, for equal to return true.

Overrides:
equals in class BaseResult
Parameters:
obj -
Returns:
true or false, indicating if the two objects are equal.

hashCode

public int hashCode()
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Overrides:
hashCode in class BaseResult
Returns:
hash code for this GetTaxRequest object
See Also:
Object.hashCode()

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return Axis type metadata object; this method is used internally by the adapter and not intended to be used by external implementation code.

Returns:
Type Description

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Axis Custom Serializer; this method is used internally by the adapter and not intended to be used by external implementation code.

Parameters:
mechType -
_javaType -
_xmlType -
Returns:
Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Axis Custom Deserializer; this method is used internally by the adapter and not intended to be used by external implementation code.

Parameters:
mechType -
_javaType -
_xmlType -
Returns:
Deserializer