com.kount.ris

Class Inquiry

java.lang.Object

com.kount.ris.Request

com.kount.ris.Inquiry

public class Inquiry
extends Request

RIS initial inquiry class.

Contains specific methods for setting various inquiry properties

Version:

$Id$

Author:

Kount <custserv@kount.com>

Field Summary

Fields inherited from class com.kount.ris.Request

closeOnFinish, logger, params

Constructor Summary

Constructors

Constructor and Description
Inquiry() Class constructor.

Method Summary

Modifier and Type	Method and Description
Inquiry	setAnid(String anid) Set the anid.
Inquiry	setBillingAddress(Address address) Set the billing address.
Inquiry	setBillingPhoneNumber(String billingPhoneNumber) Set the billing phone number.
Inquiry	setCart(Collection<CartItem> cart) Set the shopping cart.
Inquiry	setCash(long cash) Set cash amount of any feasible goods.
Inquiry	setCurrency(CurrencyType currency) Deprecated. Version 4.3.5. Use method com.kount.ris.Inquiry.setCurrency(String currency) : Inquiry.
Inquiry	setCurrency(String currency) Set the three character ISO-4217 currency code.
Inquiry	setCustomerName(String customerName) Set the name of the client or company.
Inquiry	setDateOfBirth(String dob) Set the date of birth in the format YYYY-MM-DD.
Inquiry	setEmail(String email) Set the email address of the client.
Inquiry	setEpoch(long timeStamp) Set the timestamp (in seconds) since the UNIX epoch for when the UNIQ value was set.
Inquiry	setGender(char gender) Set the gender.
Inquiry	setIpAddress(String ipAddress) Set the IP address.
Inquiry	setMode(InquiryMode mode) Set the request mode.
Inquiry	setName(String name) Set the name of the company.
Inquiry	setShippingAddress(Address address) Set the shipping address.
Inquiry	setShippingEmail(String shippingEmail) Set the shipping email.
Inquiry	setShippingName(String shippingName) Set the shipping name.
Inquiry	setShippingPhoneNumber(String shippingPhoneNumber) Set the shipping phone number.
Inquiry	setShippingType(ShippingType shippingType) Set shipment type.
Inquiry	setTotal(long total) Set the total amount in lowest possible denomination of currency.
Inquiry	setUniqueCustomerId(String uniqueCustomerId) Set the unique ID or cookie set by merchant.
Inquiry	setUserAgent(String userAgent) Set the user agent string of the client.
Inquiry	setUserDefinedField(String label, String value) Set a user defined field.
Inquiry	setWebsite(String site) Set the website.

Methods inherited from class com.kount.ris.Request

getParams, isSetKhashPaymentEncoding, setAuthorizationStatus, setAvsAddressReply, setAvsZipReply, setCloseOnFinish, setCvvReply, setKcCustomerId, setKhashPaymentEncoding, setKhashPaymentEncoding, setMerchantAcknowledgment, setMerchantId, setOrderNumber, setParm, setPayment, setPayment, setPaymentMasked, setSessionId, setVersion, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Inquiry

public Inquiry()

Class constructor. Sets the RIS mode to "Inquiry" ("Q"), sets currency to "USD", and sets the Java SDK identifier. The mode and currency can be adjusted by called setMode() and setCurrency methods respectively.

Method Detail

setCash

public Inquiry setCash(long cash)

Set cash amount of any feasible goods.

Parameters:

cash - int Cash amount of any feasible goods

Returns:

this

setDateOfBirth

public Inquiry setDateOfBirth(String dob)

Set the date of birth in the format YYYY-MM-DD.

Parameters:

dob - Date of birth

Returns:

this

setGender

public Inquiry setGender(char gender)

Set the gender. Either M(ale) of F(emale).

Acceptable values: 'M' or 'F'

Parameters:

gender - Gender

Returns:

this

setUserDefinedField

public Inquiry setUserDefinedField(String label,
                                   String value)

Set a user defined field.

Parameters:

label - The name of the user defined field

value - The value of the user defined field

Returns:

this

setMode

public Inquiry setMode(InquiryMode mode)

Set the request mode.

Acceptable values are: "Q", "P", "W", "J"

Parameters:

mode - Mode of the request

Returns:

this

setCurrency

public Inquiry setCurrency(CurrencyType currency)

Deprecated. Version 4.3.5. Use method com.kount.ris.Inquiry.setCurrency(String currency) : Inquiry.

Set the currency.

Parameters:

currency - Type of currency

Returns:

this

setCurrency

public Inquiry setCurrency(String currency)

Set the three character ISO-4217 currency code.

Parameters:

currency - Currency code, eg, USD, EUR...

Returns:

this

setTotal

public Inquiry setTotal(long total)

Set the total amount in lowest possible denomination of currency.

Parameters:

total - Transaction amount in lowest possible denomination of given currency

Returns:

this

setEmail

public Inquiry setEmail(String email)

Set the email address of the client.

Parameters:

email - Email address of the client

Returns:

this

setCustomerName

public Inquiry setCustomerName(String customerName)

Set the name of the client or company.

Parameters:

customerName - Name of the client or company

Returns:

this

setBillingAddress

public Inquiry setBillingAddress(Address address)

Set the billing address.

Parameters:

address - The billing address

Returns:

this

setShippingAddress

public Inquiry setShippingAddress(Address address)

Set the shipping address.

Parameters:

address - Shipping address

Returns:

this

setBillingPhoneNumber

public Inquiry setBillingPhoneNumber(String billingPhoneNumber)

Set the billing phone number.

Parameters:

billingPhoneNumber - Billing phone number

Returns:

this

setShippingPhoneNumber

public Inquiry setShippingPhoneNumber(String shippingPhoneNumber)

Set the shipping phone number.

Parameters:

shippingPhoneNumber - Shipping phone number

Returns:

this

setShippingName

public Inquiry setShippingName(String shippingName)

Set the shipping name.

Parameters:

shippingName - Shipping name

Returns:

this

setShippingEmail

public Inquiry setShippingEmail(String shippingEmail)

Set the shipping email.

Parameters:

shippingEmail - Shipping email

Returns:

this

setUniqueCustomerId

public Inquiry setUniqueCustomerId(String uniqueCustomerId)

Set the unique ID or cookie set by merchant.

Parameters:

uniqueCustomerId - Customer-unique ID or cookie set by merchant.

Returns:

this

setIpAddress

public Inquiry setIpAddress(String ipAddress)

Set the IP address.

Parameters:

ipAddress - IP Address of the client

Returns:

this

setUserAgent

public Inquiry setUserAgent(String userAgent)

Set the user agent string of the client.

Parameters:

userAgent - Useragent string of the client

Returns:

this

setEpoch

public Inquiry setEpoch(long timeStamp)

Set the timestamp (in seconds) since the UNIX epoch for when the UNIQ value was set.

Parameters:

timeStamp - The timestamp

Returns:

this

setShippingType

public Inquiry setShippingType(ShippingType shippingType)

Set shipment type.

Accepted values: "SD" - Same Day, "ND" - Next Day, "2D" - Second Day, "ST" - Standard

Parameters:

shippingType - Ship type

Returns:

this

setAnid

public Inquiry setAnid(String anid)

Set the anid.

Automatic Number Identification (ANI) submitted with order. If the ANI cannot be determined, merchant must pass 0123456789 as the ANID. This field is only valid for MODE=P RIS submissions.

Parameters:

anid - Anid of the client

Returns:

this

setName

public Inquiry setName(String name)

Set the name of the company.

Parameters:

name - Name of the company

Returns:

this

setWebsite

public Inquiry setWebsite(String site)

Set the website.

Parameters:

site - the website

Returns:

this

setCart

public Inquiry setCart(Collection<CartItem> cart)

Set the shopping cart.

Parameters:

cart - Collection of CartItems in the shopping cart

Returns:

this