Docs For Class PaymentPlan

PaymentPlan __construct ([DateTime $createDate = null], [DateTime $lastInvocingDate = null], [DateTime $lastProcessingDate = null], [String $code = null], [String $sellerCode = null], [int $length = null], [int $value = null], [int $deferredLength = null], [int $deferredValue = null], [int $amount = null], [String $groupCode1 = null], [String $groupCode2 = null], [String $groupCode3 = null], [String $groupCode4 = null], [String $groupCode5 = null], [String $groupCode6 = null], [String $groupCode7 = null], [String $groupCode8 = null], [int $merchantAccountCode = null], [String $type = null], [DateTime $firstBillingDate = null], [String $billingCycleCode = null], [String $itemCode = null], [String $taxCode = null], [PaymentOption $paymentOption = null], [CustomerAccount $customerAccount = null], [int $id = null], [DateTime $lastUpdateDate = null], [DateTime $nextBillingDate = null], [String $status = null])

void add (int $position, int $length, bool $isFreeze)

void addCharge (Charge $charge, int $position)

void cancel ()

Adjustment createAdjustment ()

Adjustment createAdjustmentExtended (String $code, String $notes, String $adjustmentReasonCode)

PaymentPlan createLinkedPaymentPlan ()

PaymentPlan createLinkedPaymentPlanBasic (String $code, int $type, int $amount, String $length)

PaymentPlan createLinkedPaymentPlanExtended (String $code, String $type, int $amount, int $length, PaymentOption $paymentOption, String $sellerCode, String $itemCode, String $taxCode, String $groupCode1, String $groupCode2, String $groupCode3, String $groupCode4, String $groupCode5, String $groupCode6, String $groupCode7, String $groupCode8)

ArrayList createListCharges ([int $size = true])

void decrementChargesListParameters (Charge $charge)

void equals ( $anotherObject)

Adjustment getAdjustment ()

int getAmount ()

String getBillingCycleCode ()

ArrayList getCharges ()

ArrayList getChargesInternal ()

CustomerAccount getCustomerAccount ()

int getDeferredLength ()

int getDeferredValue ()

DateTime getFirstBillingDate ()

String getGroupCode1 ()

String getGroupCode2 ()

String getGroupCode3 ()

String getGroupCode4 ()

String getGroupCode5 ()

String getGroupCode6 ()

String getGroupCode7 ()

String getGroupCode8 ()

String getItemCode ()

DateTime getLastInvocingDate ()

DateTime getLastProcessingDate ()

DateTime getLastUpdateDate ()

int getLength ()

int getLinkAccount ()

PaymentPlan getLinkParentPlan ()

DateTime getNextBillingDate ()

Charge getNextCharge ()

PaymentOption getPaymentOption ()

String getSellerCode ()

String getStatus ()

String getTaxCode ()

String getType ()

int getValue ()

void incrementChargesListParameters (Charge $charge)

void remove (Charge $charge)

void removeIndex (int $position)

void removeRange (int $position, int $length)

void setAdjustment (Adjustment $adjustment)

void setAmount (int $amount)

void setBillingCycleCode (String $billingCycleCode)

void setCharges (ArrayList $charges)

void setCustomerAccount (CustomerAccount $customerAccount)

void setDeferredLength (int $deferredLength)

void setDeferredValue (int $deferredValue)

void setFirstBillingDate (DateTime $firstBillingDate)

void setGroupCode1 (String $groupCode1)

void setGroupCode2 (String $groupCode2)

void setGroupCode3 (String $groupCode3)

void setGroupCode4 (String $groupCode4)

void setGroupCode5 (String $groupCode5)

void setGroupCode6 (String $groupCode6)

void setGroupCode7 (String $groupCode7)

void setGroupCode8 (String $groupCode8)

void setItemCode (String $itemCode)

void setLastInvocingDate (DateTime $lastInvocingDate)

void setLastProcessingDate (DateTime $lastProcessingDate)

void setLastUpdateDate (DateTime $lastUpdateDate)

void setLength (int $length)

void setLinkAccount (int $linkAccount)

void setLinkParentPlan (PaymentPlan $linkParentPlan)

void setNextBillingDate (DateTime $nextBillingDate)

void setPaymentOption (PaymentOption $paymentOption)

void setSellerCode (String $sellerCode)

void setStatus (String $status)

void setTaxCode (String $taxCode)

void setType (String $type)

void setValue (int $value)

void type ()

Variables

Adjustment $adjustment (line 129)

var: The adjustment.
access: private

int $amount (line 41)

var: The amount.
access: private

String $billingCycleCode (line 89)

var: The billing cycle code.
access: private

ArrayList $charges (line 113)

var: The charges.
access: private

CustomerAccount $customerAccount (line 121)

var: The customer account.
access: private

int $deferredLength (line 33)

var: The deferred length.
access: private

int $deferredValue (line 37)

var: The deferred value.
access: private

DateTime $firstBillingDate (line 81)

var: The first billing date.
access: private

String $groupCode1 (line 45)

var: The group code1.
access: private

String $groupCode2 (line 49)

var: The group code2.
access: private

String $groupCode3 (line 53)

var: The group code3.
access: private

String $groupCode4 (line 57)

var: The group code4.
access: private

String $groupCode5 (line 61)

var: The group code5.
access: private

String $groupCode6 (line 65)

var: The group code6.
access: private

String $groupCode7 (line 69)

var: The group code7.
access: private

String $groupCode8 (line 73)

var: The group code8.
access: private

String $itemCode (line 93)

var: The item code.
access: private

DateTime $lastInvocingDate (line 13)

var: The last invocing date.
access: private

DateTime $lastProcessingDate (line 17)

var: The last processing date.
access: private

DateTime $lastUpdateDate (line 101)

var: The last update date.
access: private

int $length (line 25)

var: The length.
access: private

int $linkAccount (line 109)

var: The link account.
access: private

PaymentPlan $linkParentPlan (line 125)

var: The link parent plan.
access: private

DateTime $nextBillingDate (line 85)

var: The next billing date.
access: private

PaymentOption $paymentOption (line 117)

var: The payment option.
access: private

String $sellerCode (line 21)

var: The seller code.
access: private

String $status (line 105)

var: The status.
access: private

String $taxCode (line 97)

var: The tax code.
access: private

String $type (line 77)

var: The type.
access: private

int $value (line 29)

var: The value.
access: private

Inherited Variables

Inherited from ClientObject

ClientObject::$code
ClientObject::$createDate
ClientObject::$id
ClientObject::$merchantAccountCode
ClientObject::$_hashCode

Methods

Constructor __construct (line 164)

Instantiates a new payment plan.

DateTime $createDate: createDate the create date
DateTime $lastInvocingDate: lastInvocingDate the last invocing date
DateTime $lastProcessingDate: lastProcessingDate the last processing date
String $code: code the code
String $sellerCode: sellerCode the seller code
int $length: length the length
int $value: value the value
int $deferredLength: deferredLength the deferred length
int $deferredValue: deferredValue the deferred value
int $amount: amount the amount
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
int $merchantAccountCode: merchantAccountCode the merchant account code
String $type: type the type
DateTime $firstBillingDate: firstBillingDate the first billing date
String $billingCycleCode: billingCycleCode the billing cycle code
String $itemCode: itemCode the item code
String $taxCode: taxCode the tax code
PaymentOption $paymentOption: paymentOption the payment option
CustomerAccount $customerAccount: customerAccount the customer account
int $id: id the id
DateTime $lastUpdateDate: lastUpdateDate the last update date
DateTime $nextBillingDate: nextBillingDate the next billing date
String $status: status the status

add (line 763)

add method.

access: public

void add (int $position, int $length, bool $isFreeze)

int $position: position the position
int $length: length the length
bool $isFreeze: isFreeze the is freeze

addCharge (line 824)

add method.

access: public

void addCharge (Charge $charge, int $position)

Charge $charge: charge the charge
int $position: position the position

cancel (line 788)

Cancel.

access: public

void cancel ()

createAdjustment (line 1033)

createAdjustment method.

return: the adjustment
access: public

Adjustment createAdjustment ()

createAdjustmentExtended (line 871)

createAdjustment method.

return: the adjustment
access: public

Adjustment createAdjustmentExtended (String $code, String $notes, String $adjustmentReasonCode)

String $code: code the code
String $notes: notes the notes
String $adjustmentReasonCode: adjustmentReasonCode the adjustment reason code

createLinkedPaymentPlan (line 1017)

Ìåòîä ñîçäàåò äî÷åðíèé PP.

return: paymentPlan PaymentPlan
access: public

PaymentPlan createLinkedPaymentPlan ()

createLinkedPaymentPlanBasic (line 703)

Ìåòîä ñîçäàåò äî÷åðíèé PaymentPlan.

return: paymentPlan PaymentPlan
access: public

PaymentPlan createLinkedPaymentPlanBasic (String $code, int $type, int $amount, String $length)

String $code: code String
int $type: amount Integer
int $amount: length Integer
String $length: type the type

createLinkedPaymentPlanExtended (line 739)

Creates the linked payment plan extended.

return: the payment plan
access: public

String $code: code the code
String $type: type the type
int $amount: amount the amount
int $length: length the length
PaymentOption $paymentOption: paymentOption the payment option
String $sellerCode: sellerCode the seller code
String $itemCode: itemCode the item code
String $taxCode: taxCode the tax 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

createListCharges (line 529)

Creates the list charges.

return: the list< charge>

ArrayList createListCharges ([int $size = true])

int $size: size the size

decrementChargesListParameters (line 964)

Decrement charges list parameters.

access: private

void decrementChargesListParameters (Charge $charge)

Charge $charge: charge the charge

equals (line 997)

access: public

void equals ( $anotherObject)

$anotherObject

getAdjustment (line 902)

Gets the adjustment.

return: the adjustment
access: public

Adjustment getAdjustment ()

getAmount (line 329)

Gets the amount.

return: Returns the amount
access: public

int getAmount ()

getBillingCycleCode (line 539)

Gets the billing cycle code.

return: Returns the billingCycleCode
access: public

String getBillingCycleCode ()

getCharges (line 605)

Gets the charges.

return: the charges
access: public

ArrayList getCharges ()

getChargesInternal (line 596)

The actual charge list should never be exposed to the clients.

return: the charges internal

ArrayList getChargesInternal ()

getCustomerAccount (line 659)

Gets the customer account.

return: the customer account
access: public

CustomerAccount getCustomerAccount ()

getDeferredLength (line 293)

Gets the deferred length.

return: Returns the deferredLength
access: public

int getDeferredLength ()

getDeferredValue (line 311)

Gets the deferred value.

return: Returns the deferredValue
access: public

int getDeferredValue ()

getFirstBillingDate (line 509)

Gets the first billing date.

return: Returns the firstBillingDate
access: public

DateTime getFirstBillingDate ()

getGroupCode1 (line 347)

Gets the group code1.

return: Returns the groupCode1
access: public

String getGroupCode1 ()

getGroupCode2 (line 365)

Gets the group code2.

return: Returns the groupCode2
access: public

String getGroupCode2 ()

getGroupCode3 (line 383)

Gets the group code3.

return: Returns the groupCode3
access: public

String getGroupCode3 ()

getGroupCode4 (line 401)

Gets the group code4.

return: Returns the groupCode4
access: public

String getGroupCode4 ()

getGroupCode5 (line 419)

Gets the group code5.

return: Returns the groupCode5
access: public

String getGroupCode5 ()

getGroupCode6 (line 437)

Gets the group code6.

return: Returns the groupCode6
access: public

String getGroupCode6 ()

getGroupCode7 (line 455)

Gets the group code7.

return: Returns the groupCode7
access: public

String getGroupCode7 ()

getGroupCode8 (line 473)

Gets the group code8.

return: Returns the groupCode8
access: public

String getGroupCode8 ()

getItemCode (line 560)

Gets the item code.

return: Returns the itemCode
access: public

String getItemCode ()

getLastInvocingDate (line 203)

Gets the last invocing date.

return: Returns the lastInvocingDate
access: public

DateTime getLastInvocingDate ()

getLastProcessingDate (line 221)

Gets the last processing date.

return: Returns the lastProcessingDate
access: public

DateTime getLastProcessingDate ()

getLastUpdateDate (line 884)

getLastUpdateDate method.

return: the last update date
access: public

DateTime getLastUpdateDate ()

getLength (line 257)

Gets the length.

return: Returns the length
access: public

int getLength ()

getLinkAccount (line 980)

Gets the link account.

return: the link account

int getLinkAccount ()

getLinkParentPlan (line 680)

Gets the link parent plan.

return: the link parent plan
access: public

PaymentPlan getLinkParentPlan ()

getNextBillingDate (line 920)

Gets the next billing date.

return: the next billing date
access: public

DateTime getNextBillingDate ()

getNextCharge (line 851)

getNextCharge method.

return: the next charge
access: public

Charge getNextCharge ()

getPaymentOption (line 641)

Gets the payment option.

return: the payment option
access: public

PaymentOption getPaymentOption ()

getSellerCode (line 239)

Gets the seller code.

return: Returns the sellerCode
access: public

String getSellerCode ()

getStatus (line 614)

Gets the status.

return: the status
access: public

String getStatus ()

getTaxCode (line 578)

Gets the tax code.

return: Returns the taxCode
access: public

String getTaxCode ()

getType (line 491)

Gets the type.

return: Returns the type
access: public

String getType ()

getValue (line 275)

Gets the value.

return: Returns the value
access: public

int getValue ()

incrementChargesListParameters (line 938)

Increment charges list parameters.

access: private

void incrementChargesListParameters (Charge $charge)

Charge $charge: charge the charge

remove (line 813)

remove method.

access: public

void remove (Charge $charge)

Charge $charge: charge the charge

removeIndex (line 803)

remove method.

access: public

void removeIndex (int $position)

int $position: position the position

removeRange (line 779)

remove method.

access: public

void removeRange (int $position, int $length)

int $position: position the position
int $length: length the length

setAdjustment (line 911)

Sets the adjustment.

access: public

void setAdjustment (Adjustment $adjustment)

Adjustment $adjustment: adjustment the new adjustment

setAmount (line 338)

Set a value to amount.

access: public

void setAmount (int $amount)

int $amount: amount the amount

setBillingCycleCode (line 548)

Set a value to billingCycleCode.

access: public

void setBillingCycleCode (String $billingCycleCode)

String $billingCycleCode: billingCycleCode the billing cycle code

setCharges (line 632)

Sets the charges.

void setCharges (ArrayList $charges)

ArrayList $charges: charges the new charges

setCustomerAccount (line 668)

Sets the customer account.

void setCustomerAccount (CustomerAccount $customerAccount)

CustomerAccount $customerAccount: customerAccount the new customer account

setDeferredLength (line 302)

Set a value to deferredLength.

void setDeferredLength (int $deferredLength)

int $deferredLength: deferredLength the deferred length

setDeferredValue (line 320)

Set a value to deferredValue.

void setDeferredValue (int $deferredValue)

int $deferredValue: deferredValue the deferred value

setFirstBillingDate (line 518)

Set a value to firstBillingDate.

access: public

void setFirstBillingDate (DateTime $firstBillingDate)

DateTime $firstBillingDate: firstBillingDate the first billing date

setGroupCode1 (line 356)

Set a value to groupCode1.

access: public

void setGroupCode1 (String $groupCode1)

String $groupCode1: groupCode1 the group code1

setGroupCode2 (line 374)

Set a value to groupCode2.

access: public

void setGroupCode2 (String $groupCode2)

String $groupCode2: groupCode2 the group code2

setGroupCode3 (line 392)

Set a value to groupCode3.

access: public

void setGroupCode3 (String $groupCode3)

String $groupCode3: groupCode3 the group code3

setGroupCode4 (line 410)

Set a value to groupCode4.

access: public

void setGroupCode4 (String $groupCode4)

String $groupCode4: groupCode4 the group code4

setGroupCode5 (line 428)

Set a value to groupCode5.

access: public

void setGroupCode5 (String $groupCode5)

String $groupCode5: groupCode5 the group code5

setGroupCode6 (line 446)

Set a value to groupCode6.

access: public

void setGroupCode6 (String $groupCode6)

String $groupCode6: groupCode6 the group code6

setGroupCode7 (line 464)

Set a value to groupCode7.

access: public

void setGroupCode7 (String $groupCode7)

String $groupCode7: groupCode7 the group code7

setGroupCode8 (line 482)

Set a value to groupCode8.

access: public

void setGroupCode8 (String $groupCode8)

String $groupCode8: groupCode8 the group code8

setItemCode (line 569)

Set a value to itemCode.

access: public

void setItemCode (String $itemCode)

String $itemCode: itemCode the item code

setLastInvocingDate (line 212)

Set a value to lastInvocingDate.

void setLastInvocingDate (DateTime $lastInvocingDate)

DateTime $lastInvocingDate: lastInvocingDate the last invocing date

setLastProcessingDate (line 230)

Set a value to lastProcessingDate.

void setLastProcessingDate (DateTime $lastProcessingDate)

DateTime $lastProcessingDate: lastProcessingDate the last processing date

setLastUpdateDate (line 893)

setLastUpdateDate method.

void setLastUpdateDate (DateTime $lastUpdateDate)

DateTime $lastUpdateDate: lastUpdateDate the last update date

setLength (line 266)

Set a value to length.

void setLength (int $length)

int $length: length the length

setLinkAccount (line 989)

Sets the link account.

void setLinkAccount (int $linkAccount)

int $linkAccount: linkAccount the new link account