Class: SVProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/SVClient/SVProperties.rb

Overview

Overview

This class contains values of parameters required to perform transactions with QwikCilver Server. Create an instance of this class, Populate the necessary parameters and pass it as a parameter to GCWebPos.initlibrary() method.

GCWebPos.initlibrary() method returns an instance of this class which contains values of parameters provided by QwikCilver Server. The values contained in the returned object MUST be provided to each operation that needs to be performed with the QwikCilver Server

Instance Method Summary collapse

Constructor Details

#initialize(src = nil) ⇒ SVProperties

Returns a new instance of SVProperties.



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

def initialize(src = nil)
  @parameters = Hash.new
  setvalue(@@CONNECTION_TIMEOUT, @@DEFAULT_CONNECTION_TIMEOUT)
  setvalue(@@TRANSACTION_TIMEOUT, @@DEFAULT_CONNECTION_TIMEOUT)
  setvalue(SVTags::TERMINAL_APP_VERSION, '0101')
  update(src) if (src != nil)
  setvalue(@@SVTYPE, SVType::WEBPOS_GIFTCARD)
end

Instance Method Details

#getacquirerid ⇒ Object

return string - the acquirerId



128
129
130
 
# File 'lib/SVClient/SVProperties.rb', line 128

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

#getconnectiontimeout ⇒ Object

return

String - the Connection Timeout



99
100
101
 
# File 'lib/SVClient/SVProperties.rb', line 99

def getconnectiontimeout()
  return getvalue(@@CONNECTION_TIMEOUT)
end

#getcurrentbatchnumber ⇒ Object

return

String - The Current Batch Number



240
241
242
 
# File 'lib/SVClient/SVProperties.rb', line 240

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

#geterrorcode ⇒ Object

return

Fixnum - The return value which indicates SUCESS or FAILURE



300
301
302
 
# File 'lib/SVClient/SVProperties.rb', line 300

def geterrorcode()
  return getvalue(@@ERROR_CODE)
end

#geterrormessage ⇒ Object

return

String - The Error message



312
313
314
 
# File 'lib/SVClient/SVProperties.rb', line 312

def geterrormessage()
  return getvalue(@@ERROR_MESSAGE)
end

#getforwardingentityid ⇒ Object

return

String - the Forwarding Entity ID



57
58
59
 
# File 'lib/SVClient/SVProperties.rb', line 57

def getforwardingentityid
  return getvalue(SVTags::FORWARDING_ENTITY_ID)
end

#getforwardingentitypassword ⇒ Object

return

String - The ForwardingEntityPassword



71
72
73
 
# File 'lib/SVClient/SVProperties.rb', line 71

def getforwardingentitypassword
  return getvalue(SVTags::FORWARDING_ENTITY_PASSWORD)
end

#getmerchantname ⇒ Object

return

String - The Merchant Name



288
289
290
 
# File 'lib/SVClient/SVProperties.rb', line 288

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

#getmerchantoutletname ⇒ Object

return

String - The Merchant Outlet Name



192
193
194
 
# File 'lib/SVClient/SVProperties.rb', line 192

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

#getorganizationname ⇒ Object

return

String - The Organization Name



204
205
206
 
# File 'lib/SVClient/SVProperties.rb', line 204

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

#getpassword ⇒ Object

return

String - the password



155
156
157
 
# File 'lib/SVClient/SVProperties.rb', line 155

def getpassword()
  return getvalue(SVTags::PASSWORD)
end

#getposentrymode ⇒ Object

return

String - The Pos Entry Mode



276
277
278
 
# File 'lib/SVClient/SVProperties.rb', line 276

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

#getposname ⇒ Object

return

String - The Pos Name



216
217
218
 
# File 'lib/SVClient/SVProperties.rb', line 216

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

#getpostypeid ⇒ Object

return

String - The Pos Type ID



264
265
266
 
# File 'lib/SVClient/SVProperties.rb', line 264

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

#getserverurl ⇒ Object

return

String - The Server URL



85
86
87
 
# File 'lib/SVClient/SVProperties.rb', line 85

def getserverurl
  return getvalue(@@SERVER_URL)
end

#getsvtype ⇒ Object 



326
327
328
 
# File 'lib/SVClient/SVProperties.rb', line 326

def getsvtype()  
  return getvalue(@@SVTYPE)
end

#getterminalappversion ⇒ Object

return

String - The Terminal App Version



180
181
182
 
# File 'lib/SVClient/SVProperties.rb', line 180

def getterminalappversion()
  return getvalue(SVTags::TERMINAL_APP_VERSION)
end

#getterminalid ⇒ Object

return

String - The Terminal ID



168
169
170
 
# File 'lib/SVClient/SVProperties.rb', line 168

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

#gettrackdata ⇒ Object

return

String - The Track Data



228
229
230
 
# File 'lib/SVClient/SVProperties.rb', line 228

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

#gettransactionid ⇒ Object

return

String - The Transaction ID



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

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

#gettransactiontimeout ⇒ Object

return

String - The TransactionTimeout



114
115
116
 
# File 'lib/SVClient/SVProperties.rb', line 114

def gettransactiontimeout()
  return getvalue(@@TRANSACTION_TIMEOUT)
end

#getusername ⇒ Object

return

String - The username



142
143
144
 
# File 'lib/SVClient/SVProperties.rb', line 142

def getusername()
  return getvalue(SVTags::USER_ID)
end

#setacquirerid(value) ⇒ Object

The value for this is pre-assigned by QwikCilver and provided to the Caller

param

String - Acquirer Id



136
137
138
 
# File 'lib/SVClient/SVProperties.rb', line 136

def setacquirerid(value)
  setvalue(SVTags::ACQUIRER_ID, value)
end

#setconnectiontimeout(timeout) ⇒ Object

Set the Time Out value (in seconds) used for connections to QwikCilver Server. The value for this should have been pre-approved by QwikCilver

param

String - The Time Out value (in seconds) used for connections to QwikCilver Server



108
109
110
 
# File 'lib/SVClient/SVProperties.rb', line 108

def setconnectiontimeout(timeout)
  setvalue(@@CONNECTION_TIMEOUT, timeout)
end

#setcurrentbatchnumber(value) ⇒ Object

param

String - Current Batch Number



246
247
248
 
# File 'lib/SVClient/SVProperties.rb', line 246

def setcurrentbatchnumber(value)
  setvalue(SVTags::CURRENT_BATCH_NUMBER, value)
end

#seterrorcode(value) ⇒ Object

param

Fixnum - Error code



306
307
308
 
# File 'lib/SVClient/SVProperties.rb', line 306

def seterrorcode(value)
  setvalue(@@ERROR_CODE, value)
end

#seterrormessage(value) ⇒ Object

param

String - Error message



318
319
320
 
# File 'lib/SVClient/SVProperties.rb', line 318

def seterrormessage(value)
  setvalue(@@ERROR_MESSAGE, value)
end

#setforwardingentityid(value) ⇒ Object

The value for this is pre-assigned by QwikCilver and provided to the Caller

param

String - Forwarding entity ID



65
66
67
 
# File 'lib/SVClient/SVProperties.rb', line 65

def setforwardingentityid(value)
  setvalue(SVTags::FORWARDING_ENTITY_ID, value)
end

#setforwardingentitypassword(value) ⇒ Object

The value for this is pre-assigned by QwikCilver and provided to the Caller

param

String - Forwarding Entity Password



79
80
81
 
# File 'lib/SVClient/SVProperties.rb', line 79

def setforwardingentitypassword(value)
  setvalue(SVTags::FORWARDING_ENTITY_PASSWORD, value)
end

#setmerchantname(value) ⇒ Object

param

String - Merchant Name



294
295
296
 
# File 'lib/SVClient/SVProperties.rb', line 294

def setmerchantname(value)
  setvalue(SVTags::MERCHANT_NAME, value)
end

#setmerchantoutletname(value) ⇒ Object

param

String - Merchant Outlet Name



198
199
200
 
# File 'lib/SVClient/SVProperties.rb', line 198

def setmerchantoutletname(value)
  setvalue(SVTags::MERCHANT_OUTLET_NAME, value)
end

#setorganizationname(value) ⇒ Object

param

String - Organization Name



210
211
212
 
# File 'lib/SVClient/SVProperties.rb', line 210

def setorganizationname(value)
  setvalue(SVTags::ORGANIZATION_NAME, value)
end

#setpassword(value) ⇒ Object

param

String - password



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

def setpassword(value)
  setvalue(SVTags::PASSWORD, value)
end

#setposentrymode(value) ⇒ Object

param

String - POS Entry Mode



282
283
284
 
# File 'lib/SVClient/SVProperties.rb', line 282

def setposentrymode(value)
  setvalue(SVTags::POS_ENTRY_MODE, value)
end

#setposname(value) ⇒ Object

param

String - Pos Name



222
223
224
 
# File 'lib/SVClient/SVProperties.rb', line 222

def setposname(value)
  setvalue(SVTags::POS_NAME, value)
end

#setpostypeid(value) ⇒ Object

param

String - POS Type ID



270
271
272
 
# File 'lib/SVClient/SVProperties.rb', line 270

def setpostypeid(value)
  setvalue(SVTags::POS_TYPE_ID, value)
end

#setserverurl(value) ⇒ Object

The value for this is pre-assigned by QwikCilver and provided to the Caller

param

String - Server URL



93
94
95
 
# File 'lib/SVClient/SVProperties.rb', line 93

def setserverurl(value)
  setvalue(@@SERVER_URL, value)
end

#setsvtype(type) ⇒ Object 



322
323
324
 
# File 'lib/SVClient/SVProperties.rb', line 322

def setsvtype(type)  
  setvalue(@@SVTYPE, type)
end

#setterminalappversion(value) ⇒ Object

param

String - The Terminal App Version



186
187
188
 
# File 'lib/SVClient/SVProperties.rb', line 186

def setterminalappversion(value)
  setvalue(SVTags::TERMINAL_APP_VERSION, value)
end

#setterminalid(value) ⇒ Object

param

String - Terminal ID



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

def setterminalid(value)
  setvalue(SVTags::TERMINAL_ID, value)
end

#settrackdata(value) ⇒ Object

param

String - Track Data



234
235
236
 
# File 'lib/SVClient/SVProperties.rb', line 234

def settrackdata(value)
  setvalue(SVTags::TRACK_DATA, value)
end

#settransactionid(transactionId) ⇒ Object

param

String - Transaction ID



258
259
260
 
# File 'lib/SVClient/SVProperties.rb', line 258

def settransactionid(transactionId)
  setvalue(SVTags::TRANSACTION_ID, transactionId)
end

#settransactiontimeout(timeout) ⇒ Object

Set the Time Out value (in seconds) used for connections to QwikCilver Server. The value for this should have been pre-approved by QwikCilver

param

String - The Time Out value (in seconds) used for connections to QwikCilver Server



123
124
125
 
# File 'lib/SVClient/SVProperties.rb', line 123

def settransactiontimeout(timeout)
  setvalue(@@TRANSACTION_TIMEOUT, timeout)
end

#setusername(value) ⇒ Object

param

String - username



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

def setusername(value)
  setvalue(SVTags::USER_ID, value)
end