Docs For Class Session

Class Session

Description

Located in /Session.php (line 10)

Variable Summary

SessionConnection $sessionConnection

Method Summary

static Session login (int $merchantAccountCode, String $password, HashMap $config)

Session __construct ([SessionConnection $sessionConnection = null])

CustomerAccount createCustomerAccount ()

CustomerAccount createCustomerAccountExtended (String $code, int $merchantAccountCode, String $firstName, String $lastName, String $middleName, String $title, String $suffix, String $customerAccountType, String $homePhone, String $workPhone, String $cellPhone, String $email, String $street1, String $street2, String $city, String $state, String $zipCode, String $beneficiaryInfo, String $customerAccountGroupCode, String $notes, DateTime $birthDate)

ArrayList findAccountTransaction (int $merchantAccountCode, String $code, String $accountActivityType, DateTime $fromCreateDate, DateTime $toCreateDate, String $customerAccountCode, String $customerAccountName, bool $isActiveCustomerAccount, String $itemCode, String $accountNumber, int $fromAmount, int $toAmount, int $fromBalance, int $toBalance)

ArrayList findCustomerAccount (int $merchantAccountCode, String $code, String $firstName, String $lastName, String $middleName, String $title, String $suffix, bool $isActive, DateTime $fromCreateDate, DateTime $toCreateDate, String $phone, String $email, String $zipCode, String $creditCardNumber, String $bankAccountNumber, int $fromBalance, int $toBalance, String $customerAccountGroupCode)

ArrayList findPaymentOption (int $merchantAccountCode, String $code, bool $isActive, DateTime $fromCreateDate, DateTime $toCreateDate, String $holderName, String $number, String $accessory, String $street1, String $street2, String $city, String $state, String $zipCode, String $paymentOptionType, String $customerAccountCode)

ArrayList findPaymentPlan (int $merchantAccountCode, String $code, DateTime $fromCreateDate, DateTime $toCreateDate, DateTime $fromNextBillingDate, DateTime $toNextBillingDate, DateTime $fromFirstBillingDate, DateTime $toFirstBillingDate, String $status, int $fromAmount, int $toAmount, String $itemCode, String $sellerCode, String $billingCycleCode, String $groupCode1, String $groupCode2, String $groupCode3, String $groupCode4, String $groupCode5, String $groupCode6, String $groupCode7, String $groupCode8, String $customerAccountCode)

CustomerAccount getCustomerAccount (ClientObject $clientObject)

void logout ()

ArrayList queryAccountTransaction (HashMap $parameters)

ArrayList queryCustomerAccount (HashMap $parameters)

ArrayList queryPaymentOption (HashMap $parameters)

ArrayList queryPaymentPlan (HashMap $parameters)

CustomerAccount save (ClientObject $clientObject)

ArrayList saveList (ArrayList $customerAccounts)

Variables

SessionConnection $sessionConnection (line 14)

var: Encapsulates communication logic (RMI vs XML)
access: private

Methods

static method login (line 34)

Performs authentication with the processing server. must begin with login.

Performs authentication with the processing server. Any interaction must begin with login.

return: upon successful login return Session object, otherwise generates exception
access: public

static Session login (int $merchantAccountCode, String $password, HashMap $config)

int $merchantAccountCode: merchantAccountCode merchant account code
String $password: password password
HashMap $config: config configuration map (see SessionConnection for key definitions)

Constructor __construct (line 20)

Instantiates a new session.

Session __construct ([SessionConnection $sessionConnection = null])

SessionConnection $sessionConnection: sessionConnection the session connection

createCustomerAccount (line 413)

Creates new active customer account

return: new customer account
access: public

CustomerAccount createCustomerAccount ()

createCustomerAccountExtended (line 76)

Creates new active customer account with the values specified

return: new customer account
access: public

String $code: code the code
int $merchantAccountCode: merchantAccountCode the merchant account code
String $firstName: firstName the first name
String $lastName: lastName the last name
String $middleName: middleName the middle name
String $title: title the title
String $suffix: suffix the suffix
String $customerAccountType: customerAccountType the customer account type
String $homePhone: homePhone the home phone
String $workPhone: workPhone the work phone
String $cellPhone: cellPhone the cell phone
String $email: email the email
String $street1: street1 the street1
String $street2: street2 the street2
String $city: city the city
String $state: state the state
String $zipCode: zipCode the zip code
String $beneficiaryInfo: beneficiaryInfo the buyer information, if different from CustomerAccount holder
String $customerAccountGroupCode: customerAccountGroupCode the customer account group code
String $notes: notes the notes
DateTime $birthDate: birthDate the birth date

findAccountTransaction (line 338)

findAccountTransaction method.

return: the list< client object>
access: public

int $merchantAccountCode: merchantAccountCode the merchant account code
String $code: code the code
String $accountActivityType: accountActivityType the account activity type
DateTime $fromCreateDate: fromCreateDate the from create date
DateTime $toCreateDate: toCreateDate the to create date
String $customerAccountCode: customerAccountCode the customer account code
String $customerAccountName: customerAccountName the customer account name
bool $isActiveCustomerAccount: isActiveCustomerAccount the is active customer account
String $itemCode: itemCode the item code
String $accountNumber: accountNumber the account number
int $fromAmount: fromAmount the from amount
int $toAmount: toAmount the to amount
int $fromBalance: fromBalance the from balance
int $toBalance: toBalance the to balance

findCustomerAccount (line 172)

Executes a search against CustomerAccount records using specified criteria.

return: list of found CustomerAccounts
access: public

int $merchantAccountCode: merchantAccountCode the merchant account code
String $code: code the code - exact search
String $firstName: firstName the first name - partial search is possible
String $lastName: lastName the last name - partial search is possible
String $middleName: middleName the middle name - exact search
String $title: title the title - exact search
String $suffix: suffix the suffix - exact search
bool $isActive: isActive the is active - exact search
DateTime $fromCreateDate: fromCreateDate the from create date - greater or equal
DateTime $toCreateDate: toCreateDate the to create date - less
String $phone: phone the phone - partial search is possible
String $email: email the email - partial search is possible
String $zipCode: zipCode the zip code - exact search
String $creditCardNumber: creditCardNumber the credit card number - last 4 digits
String $bankAccountNumber: bankAccountNumber the bank account number - last 4 digits
int $fromBalance: fromBalance the from balance - greater or equal
int $toBalance: toBalance the to balance - less than
String $customerAccountGroupCode: customerAccountGroupCode the customer account group code - exact search

findPaymentOption (line 216)

Executes a search against PaymentOption records using specified criteria.

return: list of found PaymentOptions
access: public

int $merchantAccountCode: merchantAccountCode the merchant account code - exact search
String $code: code the code - exact search
bool $isActive: isActive the is active - exact search
DateTime $fromCreateDate: fromCreateDate the from create date - greater or equal
DateTime $toCreateDate: toCreateDate the to create date - less
String $holderName: holderName the holder name - partial search is possible
String $number: number the number - last 4 digits
String $accessory: accessory the accessory - exact search
String $street1: city the city - exact search
String $street2: state the state - exact search
String $city: zipCode the zip code - exact search
String $state: paymentOptionType the payment option type - exact search
String $zipCode: customerAccountCode the customer account code - exact search
String $paymentOptionType: street1 the street1 - exact search
String $customerAccountCode: street2 the street2 - exact search

findPaymentPlan (line 279)

findPaymentPlan method.

return: the list< client object>
access: public

int $merchantAccountCode: merchantAccountCode the merchant account code
String $code: code the code
DateTime $fromCreateDate: fromCreateDate the from create date
DateTime $toCreateDate: toCreateDate the to create date
DateTime $fromNextBillingDate: fromNextBillingDate the from next billing date
DateTime $toNextBillingDate: toNextBillingDate the to next billing date
DateTime $fromFirstBillingDate: fromFirstBillingDate the from first billing date
DateTime $toFirstBillingDate: toFirstBillingDate the to first billing date
String $status: status the status
int $fromAmount: fromAmount the from amount
int $toAmount: toAmount the to amount
String $itemCode: itemCode the item code
String $sellerCode: sellerCode the seller code
String $billingCycleCode: billingCycleCode the billing cycle code
String $groupCode1: groupCode1 the group code1
String $groupCode2: groupCode2 the group code2
String $groupCode3: groupCode3 the group code3
String $groupCode4: groupCode4 the group code4
String $groupCode5: groupCode5 the group code5
String $groupCode6: groupCode6 the group code6
String $groupCode7: groupCode7 the group code7
String $groupCode8: groupCode8 the group code8
String $customerAccountCode: customerAccountCode the customer account code

getCustomerAccount (line 375)

Gets the customer account.

return: the customer account
access: private

CustomerAccount getCustomerAccount (ClientObject $clientObject)

ClientObject $clientObject: clientObject the client object

logout (line 44)

Completes communication session with server by sending logout command.

Completes communication session with server by sending logout command. The session can no longer be used and should be discarded.

access: public

void logout ()

queryAccountTransaction (line 364)

findAccountTransaction method.

return: the list< client object>
access: public

ArrayList queryAccountTransaction (HashMap $parameters)

HashMap $parameters: parameters the parameters

queryCustomerAccount (line 144)

Executes a search against CustomerAccount records using specified criteria.

Executes a search against CustomerAccount records using specified criteria. See parameter names of findCustomerAccount for possible search criterias

return: list of found CustomerAccounts
access: public

ArrayList queryCustomerAccount (HashMap $parameters)

HashMap $parameters: parameters parameters for search

queryPaymentOption (line 244)

Executes a search against PaymentOption records using specified criteria.

Executes a search against PaymentOption records using specified criteria. See parameter names of findPaymentOption for possible search criterias

return: list of found PaymentOptions
access: public

ArrayList queryPaymentOption (HashMap $parameters)

HashMap $parameters: parameters parameters for search

queryPaymentPlan (line 314)

findPaymentPlan method.

return: the list< client object>
access: public

ArrayList queryPaymentPlan (HashMap $parameters)

HashMap $parameters: parameters the parameters

save (line 111)

Saves all changes made to the object and its subobjects

return: CustomerAccount representing either the CustomerAccount that was saved, or CustomerAccount that is an owner of the record that was saved
access: public

CustomerAccount save (ClientObject $clientObject)

ClientObject $clientObject: clientObject the object to be saved

saveList (line 127)

Saves list of CustomerAccount using the mechanism of save method

return: list of CustomerAccounts that were successfully persisted
access: public

ArrayList saveList (ArrayList $customerAccounts)

ArrayList $customerAccounts: customerAccounts CustomerAccounts to be saved

Documentation generated on Thu, 20 Mar 2008 16:22:32 -0400 by phpDocumentor 1.4.0