atg.commerce.order

Interface PaymentGroup

All Superinterfaces:

CommerceIdentifier, CommerceItemRelationshipContainer, OrderRelationshipContainer, java.io.Serializable, ShippingGroupRelationshipContainer

All Known Implementing Classes:

Cash, CreditCard, GiftCertificate, InStorePayment, InvoiceRequest, PaymentGroupImpl, StoreCredit

public interface PaymentGroup
extends CommerceItemRelationshipContainer, ShippingGroupRelationshipContainer, OrderRelationshipContainer, CommerceIdentifier, java.io.Serializable

This interface represents all the information which designates a payment medium. Examples would be credit card, check, COD, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
void	addAuthorizationStatus(PaymentStatus pAuthorizationStatus) Adds an authorizationStatus to the CreditCard
void	addCreditStatus(PaymentStatus pCreditStatus) Adds a creditStatus to the CreditCard
void	addDebitStatus(PaymentStatus pDebitStatus) Adds a debitStatus to the CreditCard
double	getAmount() returns the amount associated with this PaymentGroup.
double	getAmountAuthorized() Returns the amountAuthorized
double	getAmountCredited() Returns the amountCredited property.
double	getAmountDebited() Returns the amountDebited property.
java.util.List	getAuthorizationStatus() Returns the authorizationStatus
java.util.List	getCreditStatus() Returns the creditStatus
java.lang.String	getCurrencyCode() returns the currencyCode
java.util.List	getDebitStatus() Returns the debitStatus
java.lang.String	getPaymentGroupClassType() Returns the paymentGroupClassType
java.lang.String	getPaymentMethod() Returns the paymentMethod
java.lang.String	getPaymentTypeVariation() Return an identifier representing this payment group's variation (e.g.
java.lang.String	getRequisitionNumber() Return the requisition info associated with this payment group
java.util.Map	getSpecialInstructions() Returns the specialInstructions
int	getState() returns the PaymentGroup state.
java.lang.String	getStateDetail() returns the PaymentGroup state details.
java.util.Date	getSubmittedDate() Returns the submittedDate
void	setAmount(double pAmount) sets the amount associated with this PaymentGroup.
void	setAmountAuthorized(double pAmountAuthorized) Sets the amountAuthorized
void	setAmountCredited(double pAmountCredited) Sets the amountCredited
void	setAmountDebited(double pAmountDebited) Sets the amountDebited
void	setCurrencyCode(java.lang.String pCurrencyCode) Sets the currencyCode
void	setPaymentGroupClassType(java.lang.String pPaymentGroupClassType) Sets the paymentGroupClassType
void	setPaymentMethod(java.lang.String pPaymentMethod) Sets the paymentMethod
void	setRequisitionNumber(java.lang.String pRequisitionNumber) Set the requisition info associated with this payment group
void	setState(int pState) sets the PaymentGroup state.
void	setStateDetail(java.lang.String pStateDetail) sets the PaymentGroup state details.
void	setSubmittedDate(java.util.Date pSubmittedDate) Sets the submittedDate

Methods inherited from interface atg.commerce.order.CommerceItemRelationshipContainer

addCommerceItemRelationship, addCommerceItemRelationship, getCommerceItemRelationship, getCommerceItemRelationshipCount, getCommerceItemRelationships, removeAllCommerceItemRelationships, removeCommerceItemRelationship

Methods inherited from interface atg.commerce.order.ShippingGroupRelationshipContainer

addShippingGroupRelationship, addShippingGroupRelationship, getShippingGroupRelationship, getShippingGroupRelationshipCount, getShippingGroupRelationships, removeAllShippingGroupRelationships, removeShippingGroupRelationship

Methods inherited from interface atg.commerce.order.OrderRelationshipContainer

addOrderRelationship, getOrderRelationship, getOrderRelationshipCount, removeOrderRelationship

Methods inherited from interface atg.commerce.order.CommerceIdentifier

getId

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getPaymentGroupClassType

java.lang.String getPaymentGroupClassType()

Returns the paymentGroupClassType

setPaymentGroupClassType

void setPaymentGroupClassType(java.lang.String pPaymentGroupClassType)

Sets the paymentGroupClassType

getPaymentMethod

java.lang.String getPaymentMethod()

Returns the paymentMethod

setPaymentMethod

void setPaymentMethod(java.lang.String pPaymentMethod)

Sets the paymentMethod

getAmount

double getAmount()

returns the amount associated with this PaymentGroup.

setAmount

void setAmount(double pAmount)

sets the amount associated with this PaymentGroup.

Parameters:

pAmount - the amount to set for this payment

getAmountAuthorized

double getAmountAuthorized()

Returns the amountAuthorized

setAmountAuthorized

void setAmountAuthorized(double pAmountAuthorized)

Sets the amountAuthorized

getAmountDebited

double getAmountDebited()

Returns the amountDebited property. This property represents the amount that has been debited to-date for this PaymentGroup.

setAmountDebited

void setAmountDebited(double pAmountDebited)

Sets the amountDebited

getAmountCredited

double getAmountCredited()

Returns the amountCredited property. This property represents the amount that has been credited to-date for this PaymentGroup.

setAmountCredited

void setAmountCredited(double pAmountCredited)

Sets the amountCredited

getCurrencyCode

java.lang.String getCurrencyCode()

returns the currencyCode

setCurrencyCode

void setCurrencyCode(java.lang.String pCurrencyCode)

Sets the currencyCode

getState

int getState()

returns the PaymentGroup state.

setState

void setState(int pState)

sets the PaymentGroup state.

Parameters:

pState - the state to set

getStateDetail

java.lang.String getStateDetail()

returns the PaymentGroup state details.

setStateDetail

void setStateDetail(java.lang.String pStateDetail)

sets the PaymentGroup state details.

Parameters:

pStateDetail - the stateDetail to set

getAuthorizationStatus

java.util.List getAuthorizationStatus()

Returns the authorizationStatus

addAuthorizationStatus

void addAuthorizationStatus(PaymentStatus pAuthorizationStatus)

Adds an authorizationStatus to the CreditCard

getDebitStatus

java.util.List getDebitStatus()

Returns the debitStatus

addDebitStatus

void addDebitStatus(PaymentStatus pDebitStatus)

Adds a debitStatus to the CreditCard

getCreditStatus

java.util.List getCreditStatus()

Returns the creditStatus

addCreditStatus

void addCreditStatus(PaymentStatus pCreditStatus)

Adds a creditStatus to the CreditCard

getSubmittedDate

java.util.Date getSubmittedDate()

Returns the submittedDate

setSubmittedDate

void setSubmittedDate(java.util.Date pSubmittedDate)

Sets the submittedDate

getSpecialInstructions

java.util.Map getSpecialInstructions()

Returns the specialInstructions

setRequisitionNumber

void setRequisitionNumber(java.lang.String pRequisitionNumber)

Set the requisition info associated with this payment group

getRequisitionNumber

java.lang.String getRequisitionNumber()

Return the requisition info associated with this payment group

getPaymentTypeVariation

java.lang.String getPaymentTypeVariation()

Return an identifier representing this payment group's variation (e.g. type of credit card).

Returns:

A string representing this payment group's variation, or null if this payment group has no variation.