Class: SVResponse

Inherits:
SVQcsData show all
Defined in:
lib/SVClient/SVResponse.rb

Overview

Overview

Class that contains the response data received from QwikCilver Server for all SVClient Operations.

SVRequest.execute() method returns an SVResponse object.

Call SVResponse.geterrorcode() method to determine if SVRequest.execute() method completed successfully or failed.

  1. if return value of SVResponse.geterrorcode() is equal to SVStatus.SUCCESS then read the desired attributes/properties using the appropriate getters

  2. if return value of SVResponse.geterrorcode() is not equal to SVStatus.SUCCESS then get the detailed error message by calling SVResponse.getErrorMessage()

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SVQcsData

#getdate, #getvalue, #getvalueasfloat, #getvalueasint, #printparams, #setvalue

Constructor Details

#initialize(resultcode, message = nil, httpresponse = nil) ⇒ SVResponse

Returns a new instance of SVResponse.



48
49
50
51
52
53
 
# File 'lib/SVClient/SVResponse.rb', line 48

def initialize(resultcode, message = nil, httpresponse = nil)
  super()
  @errorcode = resultcode
  @errormessage = message
  parsehttpresponse(httpresponse) if (httpresponse != nil)
end

Class Method Details

.getparams ⇒ Object 



1031
1032
1033
 
# File 'lib/SVClient/SVResponse.rb', line 1031

def self.getparams() 
  return @@params
end

Instance Method Details

#getacquirerid ⇒ Object 



1029
 
# File 'lib/SVClient/SVResponse.rb', line 1029

def getacquirerid()  return getvalue(SVTags::ACQUIRER_ID) end

#getactivationamount ⇒ Object

Method for getting the Activation Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Activation Amount returns null if execute method returns an error or if response does not contain the value



396
397
398
 
# File 'lib/SVClient/SVResponse.rb', line 396

def getactivationamount()
  return getvalueasfloat(SVTags::ACTIVATION_AMOUNT)
end

#getactivationcount ⇒ Object

Method for getting the Activation Count. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Bignum - the Activation Count returns null if execute method returns an error or if response does not contain the value



409
410
411
 
# File 'lib/SVClient/SVResponse.rb', line 409

def getactivationcount()
  return getvalueasint(SVTags::ACTIVATION_COUNT)
end

#getaddress1 ⇒ Object

Method for getting the Address1. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Address1 returns null if execute method returns an error or if response does not contain the value



759
760
761
 
# File 'lib/SVClient/SVResponse.rb', line 759

def getaddress1()
  return getvalue(SVTags::ADDRESS1)
end

#getaddress2 ⇒ Object

Method for getting the Address2. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Address2 returns null if execute method returns an error or if response does not contain the value



772
773
774
 
# File 'lib/SVClient/SVResponse.rb', line 772

def getaddress2()
  return getvalue(SVTags::ADDRESS2)
end

#getalternatephonenumber ⇒ Object

Method for getting the Alternate Phone Number. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Alternate Phone Number returns null if execute method returns an error or if response does not contain the value



850
851
852
 
# File 'lib/SVClient/SVResponse.rb', line 850

def getalternatephonenumber()
  return getvalue(SVTags::PHONE_ALTERNATE)
end

#getamount ⇒ Object

Method for getting the amount used in an operation on a card. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

double - the amount specified for this operation returns null if execute method returns an error or if response does not contain the value



265
266
267
 
# File 'lib/SVClient/SVResponse.rb', line 265

def getamount()
  return getvalueasfloat(SVTags::AMOUNT)
end

#getanniversary ⇒ Object

Method for getting the Anniversary Date. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Anniversary Date returns null if execute method returns an error or if response does not contain the value



889
890
891
 
# File 'lib/SVClient/SVResponse.rb', line 889

def getanniversary()
  return getvalue(SVTags::ANNIVERSARY)
end

#getapprovalcode ⇒ Object

Method for getting the Approval Code. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the approval code. returns null if execute method returns an error or if response does not contain the value



174
175
176
 
# File 'lib/SVClient/SVResponse.rb', line 174

def getapprovalcode()
  return getvalue(SVTags::APPROVAL_CODE)
end

#getarea ⇒ Object

Method for getting the Area. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Area returns null if execute method returns an error or if response does not contain the value



785
786
787
 
# File 'lib/SVClient/SVResponse.rb', line 785

def getarea()
  return getvalue(SVTags::AREA)
end

#getcancelactivationamount ⇒ Object

Method for getting the Cancel Activation Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Cancel Activation Amount returns null if execute method returns an error or if response does not contain the value



448
449
450
 
# File 'lib/SVClient/SVResponse.rb', line 448

def getcancelactivationamount()
  return getvalueasfloat(SVTags::CANCEL_ACTIVATION_AMOUNT)
end

#getcancelactivationcount ⇒ Object

Method for getting the Cancel Activation Count. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Bignum - the Cancel Activation Count returns null if execute method returns an error or if response does not contain the value



461
462
463
 
# File 'lib/SVClient/SVResponse.rb', line 461

def getcancelactivationcount()
  return getvalueasint(SVTags::CANCEL_ACTIVATION_COUNT)
end

#getcancelloadamount ⇒ Object

Method for getting the Cancel Load Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Cancel Load amount returns null if execute method returns an error or if response does not contain the value



500
501
502
 
# File 'lib/SVClient/SVResponse.rb', line 500

def getcancelloadamount()
  return getvalueasfloat(SVTags::CANCEL_LOAD_AMOUNT)
end

#getcancelloadcount ⇒ Object

Method for getting the Cancel Load Count. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Bignum - the Cancel Load Count returns null if execute method returns an error or if response does not contain the value



513
514
515
 
# File 'lib/SVClient/SVResponse.rb', line 513

def getcancelloadcount()
  return getvalueasint(SVTags::CANCEL_LOAD_COUNT)
end

#getcancelredeemamount ⇒ Object

Method for getting the Cancel Redeem Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Cancel Redeem amount returns null if execute method returns an error or if response does not contain the value



552
553
554
 
# File 'lib/SVClient/SVResponse.rb', line 552

def getcancelredeemamount()
  return getvalueasfloat(SVTags::CANCEL_REDEEM_AMOUNT)
end

#getcancelredeemcount ⇒ Object

Method for getting the Cancel Redeem Count. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Bignum - the Cancel Redeem Count returns null if execute method returns an error or if response does not contain the value



565
566
567
 
# File 'lib/SVClient/SVResponse.rb', line 565

def getcancelredeemcount()
  return getvalueasint(SVTags::CANCEL_REDEEM_COUNT)
end

#getcardbalance ⇒ Object

Method for getting the balance amount on a card. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

Float - the balance amount for the given card returns null if execute method returns an error or if response does not contain the value



252
253
254
 
# File 'lib/SVClient/SVResponse.rb', line 252

def getcardbalance()
  return getvalueasfloat(SVTags::CARD_BALANCE)
end

#getcardcurrencysymbol ⇒ Object

Method for getting the card currency. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the currency symbol returns null if execute method returns an error or if response does not contain the value



629
630
631
 
# File 'lib/SVClient/SVResponse.rb', line 629

def getcardcurrencysymbol()
  return getvalue(SVTags::CARD_CURRENCY_SYMBOL)
end

#getcardexpiry ⇒ Object

Method for getting the expiry date of the card. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

Date - the value for Expiry returns null if execute method returns an error or if response does not contain the value



226
227
228
 
# File 'lib/SVClient/SVResponse.rb', line 226

def getcardexpiry()
  return getvalue(SVTags::EXPIRY)
end

#getcardexpirydate ⇒ Object

Method for getting the Card Expiry Date. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Card Expiry Date returns null if execute method returns an error or if response does not contain the value



980
981
982
 
# File 'lib/SVClient/SVResponse.rb', line 980

def getcardexpirydate()
  return getvalue(SVTags::CARD_EXPIRY_DATE)
end

#getcardholdername ⇒ Object

Method for getting the Card Holder Name. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Card Holder Name returns null if execute method returns an error or if response does not contain the value



668
669
670
 
# File 'lib/SVClient/SVResponse.rb', line 668

def getcardholdername()
  return getvalue(SVTags::CARD_HOLDER_NAME)
end

#getcardnumber ⇒ Object

Method for getting the Card Number. This method will return a valid value only if execute method returns SUCCESS This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - The cardNumber, returns null if execute method returns an error or if response does not contain the value.



86
87
88
 
# File 'lib/SVClient/SVResponse.rb', line 86

def getcardnumber()
  return getvalue(SVTags::CARD_NUMBER)
end

#getcardpin ⇒ Object

Method for getting the Card Pin. This method will return a valid value only if execute method returns SUCCESS This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - The Card Pin, returns null if execute method returns an error or if response does not contain the value.



98
99
100
 
# File 'lib/SVClient/SVResponse.rb', line 98

def getcardpin()
  return getvalue(SVTags::CARD_PIN)
end

#getcardprogramgroupname ⇒ Object

Method for getting the Card Program Group Name. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

String - the Card Program Group Name. returns null if execute method returns an error or if response does not contain the value



304
305
306
 
# File 'lib/SVClient/SVResponse.rb', line 304

def getcardprogramgroupname()
  return getvalue(SVTags::CARD_PROGRAM_GROUP_NAME)
end

#getcardstatus ⇒ Object

Method for getting the Card Status. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Card Status returns null if execute method returns an error or if response does not contain the value



954
955
956
 
# File 'lib/SVClient/SVResponse.rb', line 954

def getcardstatus()
  return getvalue(SVTags::CARD_STATUS)
end

#getcardtype ⇒ Object

Method for getting the Card Type. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

String - the Card Type. returns null if execute method returns an error or if response does not contain the value



278
279
280
 
# File 'lib/SVClient/SVResponse.rb', line 278

def getcardtype()
  return getvalue(SVTags::CARD_TYPE)
end

#getcity ⇒ Object

Method for getting the City. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the City returns null if execute method returns an error or if response does not contain the value



798
799
800
 
# File 'lib/SVClient/SVResponse.rb', line 798

def getcity()
  return getvalue(SVTags::CITY)
end

#getcorporatename ⇒ Object

Method for getting the Corporate Name. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

String - the Corporate Name. returns null if execute method returns an error or if response does not contain the value



291
292
293
 
# File 'lib/SVClient/SVResponse.rb', line 291

def getcorporatename()
  return getvalue(SVTags::CORPORATE_NAME)
end

#getcountry ⇒ Object

Method for getting the Country. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Country returns null if execute method returns an error or if response does not contain the value



824
825
826
 
# File 'lib/SVClient/SVResponse.rb', line 824

def getcountry()
  return getvalue(SVTags::COUNTRY)
end

#getcurrencyconversionrate ⇒ Object

Method for getting the currency conversion rate. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the currency conversion rate returns null if execute method returns an error or if response does not contain the value



642
643
644
 
# File 'lib/SVClient/SVResponse.rb', line 642

def getcurrencyconversionrate()
  return getvalue(SVTags::CURRENCY_CONVERSION_RATE)
end

#getcurrencyconvertedamount ⇒ Object

Method for getting the currency converted amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the currency converted amount returns null if execute method returns an error or if response does not contain the value



655
656
657
 
# File 'lib/SVClient/SVResponse.rb', line 655

def getcurrencyconvertedamount()
  return getvalue(SVTags::CURRENCY_CONVERTED_AMOUNT)
end

#getcurrentbatchnumber ⇒ Object

Method for getting the Current Batch Number. This method will return a valid value only if execute method returns SUCCESS This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

Fixnum - The Current Batch Number, returns null if execute method returns an error or if response does not contain the value.



110
111
112
 
# File 'lib/SVClient/SVResponse.rb', line 110

def getcurrentbatchnumber()
  return getvalue(SVTags::CURRENT_BATCH_NUMBER)
end

#getcustomervalidationforredemption ⇒ Object

Method for getting the Customer Validation For Redemption. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Customer Validation For Redemption returns null if execute method returns an error or if response does not contain the value



993
994
995
 
# File 'lib/SVClient/SVResponse.rb', line 993

def getcustomervalidationforredemption()
  return getvalue(SVTags::CUSTOMER_VALIDATION_FOR_REDEMPTION)
end

#getdateatserver ⇒ Object

Method for getting the date at QwikCilver Server. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

Date - the date at QwikCilver Server returns null if execute method returns an error or if response does not contain the value



239
240
241
 
# File 'lib/SVClient/SVResponse.rb', line 239

def getdateatserver()
  return getdate(SVTags::DATE_AT_SERVER, SVUtils::QC_SERVER_DATE_FORMAT)
end

#getdob ⇒ Object

Method for getting the Date Of Birth. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Date Of Birth returns null if execute method returns an error or if response does not contain the value



876
877
878
 
# File 'lib/SVClient/SVResponse.rb', line 876

def getdob()
  return getvalue(SVTags::DOB)
end

#getearnedvalue ⇒ Object

Method for getting the Earned Value. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Earned Value returns null if execute method returns an error or if response does not contain the value



733
734
735
 
# File 'lib/SVClient/SVResponse.rb', line 733

def getearnedvalue()
  return getvalue(SVTags::EARNED_VALUE)
end

#getemail ⇒ Object

Method for getting the Email. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Email returns null if execute method returns an error or if response does not contain the value



863
864
865
 
# File 'lib/SVClient/SVResponse.rb', line 863

def getemail()
  return getvalue(SVTags::EMAIL)
end

#getembossingrecord ⇒ Object

Method for getting the EmbossingFileRecord. EmbossingFileRecord contains multiple tracks with trackdata in each track This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

String - EmbossingFileRecord contains multiple tracks with trackdata in each track returns null if execute method returns an error or if response does not contain the value



370
371
372
 
# File 'lib/SVClient/SVResponse.rb', line 370

def getembossingrecord()
  return getvalue(SVTags::EMBOSSING_RECORD)
end

#getemployeeid ⇒ Object

Method for getting the Employee Id. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Employee Id returns null if execute method returns an error or if response does not contain the value



681
682
683
 
# File 'lib/SVClient/SVResponse.rb', line 681

def getemployeeid()
  return getvalue(SVTags::EMPLOYEE_ID)
end

#getenrolledsince ⇒ Object

Method for getting the Enrolled Since. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Enrolled Since returns null if execute method returns an error or if response does not contain the value



941
942
943
 
# File 'lib/SVClient/SVResponse.rb', line 941

def getenrolledsince()
  return getvalue(SVTags::ENROLLED_SINCE)
end

#getenrolledstore ⇒ Object

Method for getting the Enrolled Store. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Enrolled Store returns null if execute method returns an error or if response does not contain the value



928
929
930
 
# File 'lib/SVClient/SVResponse.rb', line 928

def getenrolledstore()
  return getvalue(SVTags::ENROLLED_STORE)
end

#geterrorcode ⇒ Object

Method for getting the status of @link SVRequest.execute() method.

return

int - The error code returns SVStatus.SUCCESS (zero) if the execution of SVRequest.execute() method is successful.

returns a non-zero integer value if there is any failure in the execution of SVRequest.execute() method.



62
63
64
65
66
67
68
 
# File 'lib/SVClient/SVResponse.rb', line 62

def geterrorcode() 
  if(@errorcode.is_a? Integer)
    return @errorcode
  else 
    return @errorcode[0].to_i
  end
end

#geterrormessage ⇒ Object

Method for getting the error message if the execute method returns failure.

return

String - The error message



74
75
76
 
# File 'lib/SVClient/SVResponse.rb', line 74

def geterrormessage() 
  return @errormessage
end

#getfirstname ⇒ Object

Method for getting the First Name. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the First Name. returns null if execute method returns an error or if response does not contain the value



200
201
202
 
# File 'lib/SVClient/SVResponse.rb', line 200

def getfirstname()
  return getvalue(SVTags::FIRST_NAME)
end

#getgender ⇒ Object

Method for getting the Gender. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Gender returns null if execute method returns an error or if response does not contain the value



902
903
904
 
# File 'lib/SVClient/SVResponse.rb', line 902

def getgender()
  return getvalue(SVTags::GENDER)
end

#getgiftrecenttransactions ⇒ Object

Method for getting the Last N Transactions. This method will return an array of SVGiftRecentTransactions objects which has that last N transactions data. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

Array(SVGiftRecentTransactions) - the Last N Transactions data. returns null if execute method returns an error or if response does not contain the value



1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/SVClient/SVResponse.rb', line 1044

def getgiftrecenttransactions()
  recenttransactions = getvalue(SVTags::RECENT_TRANSACTIONS)
  if (recenttransactions[0] != nil)
    parsedrecenttransactions = SVUtils::parsegiftrecenttransactions(recenttransactions)   
  end
  return parsedrecenttransactions
end

#getinvoicenumber ⇒ Object

Method for getting the Invoice Number specified for an operation on a card. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

String - the Invoice Number specified for this operation. returns null if execute method returns an error or if response does not contain the value



317
318
319
 
# File 'lib/SVClient/SVResponse.rb', line 317

def getinvoicenumber()
  return getvalue(SVTags::INVOICE_NUMBER)
end

#getlastname ⇒ Object

Method for getting the Last Name. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Last Name. returns null if execute method returns an error or if response does not contain the value



213
214
215
 
# File 'lib/SVClient/SVResponse.rb', line 213

def getlastname()
  return getvalue(SVTags::LAST_NAME)
end

#getmaritalstatus ⇒ Object

Method for getting the Marital Status. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Marital Status returns null if execute method returns an error or if response does not contain the value



915
916
917
 
# File 'lib/SVClient/SVResponse.rb', line 915

def getmaritalstatus()
  return getvalue(SVTags::MARITAL_STATUS)
end

#getmeetsminimumredemptioncriteria ⇒ Object

Method for getting the Meets Minimum Redemption Criteria. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Meets Minimum Redemption Criteria returns null if execute method returns an error or if response does not contain the value



1006
1007
1008
 
# File 'lib/SVClient/SVResponse.rb', line 1006

def getmeetsminimumredemptioncriteria()
  return getvalue(SVTags::MEETS_MINIMUM_REDEMPTION_CRITERIA)
end

#getmerchantname ⇒ Object 



1027
 
# File 'lib/SVClient/SVResponse.rb', line 1027

def getmerchantname()  return getvalue(SVTags::MERCHANT_NAME) end

#getmerchantoutletname ⇒ Object 



1026
 
# File 'lib/SVClient/SVResponse.rb', line 1026

def getmerchantoutletname()  return getvalue(SVTags::MERCHANT_OUTLET_NAME) end

#getnewbatchnumber ⇒ Object

Method for getting the new batch number. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

Bignum - the new batch number returns null if execute method returns an error or if response does not contain the value



578
579
580
 
# File 'lib/SVClient/SVResponse.rb', line 578

def getnewbatchnumber()
  return getvalueasint(SVTags::NEW_BATCH_NUMBER)
end

#getorganizationname ⇒ Object 



1028
 
# File 'lib/SVClient/SVResponse.rb', line 1028

def getorganizationname()  return getvalue(SVTags::ORGANIZATION_NAME) end

#getoutstandingbalance ⇒ Object

Method for getting the Outstanding Balance. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Outstanding Balance returns null if execute method returns an error or if response does not contain the value



967
968
969
 
# File 'lib/SVClient/SVResponse.rb', line 967

def getoutstandingbalance()
  return getvalue(SVTags::OUTSTANDING_BALANCE)
end

#getphonenumber ⇒ Object

Method for getting the Phone Number. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Phone Number returns null if execute method returns an error or if response does not contain the value



161
162
163
 
# File 'lib/SVClient/SVResponse.rb', line 161

def getphonenumber()
  return getvalue(SVTags::PHONE_NUMBER)
end

#getpincode ⇒ Object

Method for getting the PinCode. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the PinCode returns null if execute method returns an error or if response does not contain the value



837
838
839
 
# File 'lib/SVClient/SVResponse.rb', line 837

def getpincode()
  return getvalue(SVTags::PIN_CODE)
end

#getposentrymode ⇒ Object 



1025
 
# File 'lib/SVClient/SVResponse.rb', line 1025

def getposentrymode()  return getvalue(SVTags::POS_ENTRY_MODE) end

#getposname ⇒ Object 



1023
 
# File 'lib/SVClient/SVResponse.rb', line 1023

def getposname()  return getvalue(SVTags::POS_NAME) end

#getpostypeid ⇒ Object 



1024
 
# File 'lib/SVClient/SVResponse.rb', line 1024

def getpostypeid()  return getvalue(SVTags::POS_TYPE_ID) end

#getpreviousbalance ⇒ Object

Method for getting the previous balance. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the previous balance returns null if execute method returns an error or if response does not contain the value



590
591
592
 
# File 'lib/SVClient/SVResponse.rb', line 590

def getpreviousbalance()
  return getvalue(SVTags::PREV_BALANCE)
end

#getpromotionalvalue ⇒ Object

Method for getting the promotional value. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the promotional value returns null if execute method returns an error or if response does not contain the value



603
604
605
 
# File 'lib/SVClient/SVResponse.rb', line 603

def getpromotionalvalue()
  return getvalue(SVTags::PROMOTIONAL_VALUE)
end

#getreadyforredemption ⇒ Object

Method for getting the Ready For Redemption. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Ready For Redemption returns null if execute method returns an error or if response does not contain the value



1019
1020
1021
 
# File 'lib/SVClient/SVResponse.rb', line 1019

def getreadyforredemption()
  return getvalue(SVTags::READY_FOR_REDEMPTION)
end

#getredeemamount ⇒ Object

Method for getting the Redeem Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Redeem amount returns null if execute method returns an error or if response does not contain the value



526
527
528
 
# File 'lib/SVClient/SVResponse.rb', line 526

def getredeemamount()
  return getvalueasfloat(SVTags::REDEEM_AMOUNT)
end

#getredeemcount ⇒ Object

Method for getting the Redeem Count. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Bignum - the Redeem Count returns null if execute method returns an error or if response does not contain the value



539
540
541
 
# File 'lib/SVClient/SVResponse.rb', line 539

def getredeemcount()
  return getvalueasint(SVTags::REDEEM_COUNT)
end

#getredemptionamount ⇒ Object

Method for getting the Redemption Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Redemption Amount returns null if execute method returns an error or if response does not contain the value



435
436
437
 
# File 'lib/SVClient/SVResponse.rb', line 435

def getredemptionamount()
  return getvalueasfloat(SVTags::REDEEM_AMOUNT)
end

#getredemptioncount ⇒ Object

Method for getting the Redemption Count. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Redemption Count returns null if execute method returns an error or if response does not contain the value



422
423
424
 
# File 'lib/SVClient/SVResponse.rb', line 422

def getredemptioncount()
  return getvalueasfloat(SVTags::REDEEM_COUNT)
end

#getreloadamount ⇒ Object

Method for getting the Reload Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the Reload amount returns null if execute method returns an error or if response does not contain the value



474
475
476
 
# File 'lib/SVClient/SVResponse.rb', line 474

def getreloadamount()
  return getvalueasfloat(SVTags::RELOAD_AMOUNT)
end

#getreloadcount ⇒ Object

Method for getting the Reload Count. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Bignum - the Reload Count returns null if execute method returns an error or if response does not contain the value



487
488
489
 
# File 'lib/SVClient/SVResponse.rb', line 487

def getreloadcount()
  return getvalueasint(SVTags::RELOAD_COUNT)
end

#getsalutation ⇒ Object

Method for getting the Salutation. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Salutation returns null if execute method returns an error or if response does not contain the value



746
747
748
 
# File 'lib/SVClient/SVResponse.rb', line 746

def getsalutation()
  return getvalue(SVTags::SALUTATION)
end

#getsettlementdate ⇒ Object

Method for getting the Settlement Date. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Date - the Settlement Date. returns null if execute method returns an error or if response does not contain the value



383
384
385
 
# File 'lib/SVClient/SVResponse.rb', line 383

def getsettlementdate()
  return getvalue(SVTags::SETTLEMENT_DATE, SVUtils.QC_SERVER_DATE_FORMAT)
end

#getstate ⇒ Object

Method for getting the State. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the State returns null if execute method returns an error or if response does not contain the value



811
812
813
 
# File 'lib/SVClient/SVResponse.rb', line 811

def getstate()
  return getvalue(SVTags::STATE)
end

#getsvconvertedamount ⇒ Object

Method for getting the SV Converted Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the SV Converted Amount returns null if execute method returns an error or if response does not contain the value



707
708
709
 
# File 'lib/SVClient/SVResponse.rb', line 707

def getsvconvertedamount()
  return getvalue(SVTags::SV_CONVERTED_AMOUNT)
end

#getsvtype ⇒ Object

Method for getting the SVType. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the SVType returns null if execute method returns an error or if response does not contain the value



694
695
696
 
# File 'lib/SVClient/SVResponse.rb', line 694

def getsvtype()
  return getvalue(SVTags::SV_TYPE)
end

#getterminalid ⇒ Object

Method for getting the Terminal ID. This method will return a valid value only if execute method returns SUCCESS This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Terminal Id returns null if execute method returns an error



135
136
137
 
# File 'lib/SVClient/SVResponse.rb', line 135

def getterminalid()
  return getvalue(SVTags::TERMINAL_ID)
end

#gettrackdata ⇒ Object

Method for getting the Track Data. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Track Data returns null if execute method returns an error or if response does not contain the value



148
149
150
 
# File 'lib/SVClient/SVResponse.rb', line 148

def gettrackdata()
  return getvalue(SVTags::TRACK_DATA)
end

#gettransactionamount ⇒ Object

Method for getting the Transaction Amount. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the Transaction Amount returns null if execute method returns an error or if response does not contain the value



720
721
722
 
# File 'lib/SVClient/SVResponse.rb', line 720

def gettransactionamount()
  return getvalue(SVTags::XACTION_AMOUNT)
end

#gettransactionamountconvertedvalue ⇒ Object

Method for getting the transaction amount converted value. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the transaction amount converted value returns null if execute method returns an error or if response does not contain the value



616
617
618
 
# File 'lib/SVClient/SVResponse.rb', line 616

def gettransactionamountconvertedvalue()
  return getvalue(SVTags::TRANSACTION_AMOUNT_CONVERTED_VALUE)
end

#gettransactionid ⇒ Object

Method for getting the Transaction ID. This method will return a valid value only if execute method returns SUCCESS This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

Fixnum - The transaction ID, returns null if execute method returns an error or if response does not contain the value.



122
123
124
 
# File 'lib/SVClient/SVResponse.rb', line 122

def gettransactionid()
  return getvalueasint(SVTags::TRANSACTION_ID)
end

#gettransactiontypeid ⇒ Object

Method for getting the Transaction Type ID. This method will return a valid value only if execute method returns SUCCESS. This method will return null

  1. if execute method returns an error or

  2. if response does not contain a value

return

String - the transaction type id. returns null if execute method returns an error or if response does not contain the value



187
188
189
 
# File 'lib/SVClient/SVResponse.rb', line 187

def gettransactiontypeid()
  return getvalue(SVTags::TRANSACTION_TYPE_ID)
end

#gettransfercardbalance ⇒ Object

Method for getting the balance amount on a transfer card. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Float - the balance amount returns null if execute method returns an error or if response does not contain the value



356
357
358
 
# File 'lib/SVClient/SVResponse.rb', line 356

def gettransfercardbalance()
  return getvalueasfloat(SVTags::TRANSFER_CARD_BALANCE)
end

#gettransfercardexpiry ⇒ Object

Method for getting the Transfer Card Expiry date. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

Date - the Transfer Card Expiry date. returns null if execute method returns an error or if response does not contain the value



343
344
345
 
# File 'lib/SVClient/SVResponse.rb', line 343

def gettransfercardexpiry()
  return getvalue(SVTags::TRANSFER_CARD_EXPIRY)
end

#gettransfercardnumber ⇒ Object

Method for getting the Transfer Card Number. This method will return a valid value only if execute method returns SUCCESS. This method will return null if execute method returns an error or if response does not contain a value

return

String - the Transfer Card Number. returns null if execute method returns an error or if response does not contain the value



330
331
332
 
# File 'lib/SVClient/SVResponse.rb', line 330

def gettransfercardnumber()
  return getvalue(SVTags::TRANSFER_CARD_NUMBER)
end