atg.commerce.payment

Class PaymentType

java.lang.Object

atg.commerce.payment.PaymentType

Direct Known Subclasses:

GroupPaymentType

public class PaymentType
extends java.lang.Object

A class to represent a specific type of payment, normally including more detail than simply a payment group e.g. not just 'credit card' but 'visa credit card'

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
PaymentType(java.lang.String pPaymentGroupIdentifier, java.lang.String pDefaultDisplayName, java.lang.String pPaymentGroupVariation, java.lang.String pResourceName, java.lang.String pResourceBundle) Constructs a new payment type object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject) Checks whether another object is equal to this payment type object.
java.lang.String	getDefaultDisplayName() Returns the default display name associated with this payment type.
java.lang.String	getDisplayName(java.util.Locale pLocale) Returns the display name associated with the given locale for this payment type.
java.lang.String	getDisplayNameResource() Returns the resource name which can be used to look up a localized name for this payment type.
java.lang.String	getPaymentGroupIdentifier() Returns the payment group identifier associated with this payment type.
java.lang.String	getPaymentGroupVariation() Returns the specific variation of the payment group associated with this payment type.
java.lang.String	getResourceBundle() Returns the name of the resource bundle associated with this payment type.
int	hashCode() Returns a hash code for this object.
boolean	matches(PaymentType pOtherPaymentType) Checks if another payment type object matches this one.
void	setDefaultDisplayName(java.lang.String pDefaultDisplayName) Set the default display name associated with this payment type.
void	setDisplayNameResource(java.lang.String pDisplayNameResource) Set a resource name which can used to look up a localized name for this payment type.
void	setPaymentGroupIdentifier(java.lang.String pPaymentGroupIdentifier) Set the payment group identifier associated with this payment type.
void	setPaymentGroupVariation(java.lang.String pPaymentGroupVariation) Set the specific variation of the payment group associated with this payment type.
void	setResourceBundle(java.lang.String pResourceBundle) Set the name of the resource bundle associated with this payment type.
protected boolean	stringsEqualAllowingNull(java.lang.String pFirstString, java.lang.String pSecondString) Compare two strings for equality, allowing either string to be null, and nulls to be classed as equal.
java.lang.String	toString() Return a string presentation of this payment type object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

PaymentType

public PaymentType(java.lang.String pPaymentGroupIdentifier,
                   java.lang.String pDefaultDisplayName,
                   java.lang.String pPaymentGroupVariation,
                   java.lang.String pResourceName,
                   java.lang.String pResourceBundle)

Constructs a new payment type object.

Parameters:

pPaymentGroupIdentifier - The payment group type identifier

pDefaultDisplayName - A localized default display name

pPaymentGroupVariation - An identifier for this payment type's variation.

pResourceName - A resource key for this payment type.

pResourceBundle - The name of the resource bundle for this payment type.

Method Detail

getPaymentGroupVariation

public java.lang.String getPaymentGroupVariation()

Returns the specific variation of the payment group associated with this payment type.

Returns:

A string representing the payment group variation.

setPaymentGroupVariation

public void setPaymentGroupVariation(java.lang.String pPaymentGroupVariation)

Set the specific variation of the payment group associated with this payment type.

Parameters:

pPaymentGroupVariation - The payment group variation for this payment type.

getPaymentGroupIdentifier

public java.lang.String getPaymentGroupIdentifier()

Returns the payment group identifier associated with this payment type.

Returns:

A string identifying the payment group associated with this payment type.

setPaymentGroupIdentifier

public void setPaymentGroupIdentifier(java.lang.String pPaymentGroupIdentifier)

Set the payment group identifier associated with this payment type.

Parameters:

pPaymentGroupIdentifier - The identifier for the payment group.

getDisplayNameResource

public java.lang.String getDisplayNameResource()

Returns the resource name which can be used to look up a localized name for this payment type.

Returns:

A string representing the resource name.

setDisplayNameResource

public void setDisplayNameResource(java.lang.String pDisplayNameResource)

Set a resource name which can used to look up a localized name for this payment type.

Parameters:

pDisplayNameResource - The resource name to use.

getDefaultDisplayName

public java.lang.String getDefaultDisplayName()

Returns the default display name associated with this payment type.

Returns:

A string representing the display name associated with this payment type.

setDefaultDisplayName

public void setDefaultDisplayName(java.lang.String pDefaultDisplayName)

Set the default display name associated with this payment type.

Parameters:

pDefaultDisplayName - The display name for this payment type.

getResourceBundle

public java.lang.String getResourceBundle()

Returns the name of the resource bundle associated with this payment type.

Returns:

A string representing the name of the resource bundle.

setResourceBundle

public void setResourceBundle(java.lang.String pResourceBundle)

Set the name of the resource bundle associated with this payment type.

Parameters:

pResourceBundle - The name of the resource bundle.

equals

public boolean equals(java.lang.Object pObject)

Checks whether another object is equal to this payment type object.

Overrides:

equals in class java.lang.Object

Parameters:

pOject - the object to compare to

Returns:

A boolean stating whether or not the object passed in was equal to this one

stringsEqualAllowingNull

protected boolean stringsEqualAllowingNull(java.lang.String pFirstString,
                                           java.lang.String pSecondString)

Compare two strings for equality, allowing either string to be null, and nulls to be classed as equal.

Parameters:

pFirstString - The first string to compare.

pSecondString - The second string to compare.

Returns:

A boolean stating whether or not the two strings (allowing nulls) were equal.

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

An integer representing a hash code for this object.

matches

public boolean matches(PaymentType pOtherPaymentType)

Checks if another payment type object matches this one. Note : If this payment type has no payment type variation set then it will match a payment type with ANY variation (to allow for the concept of things like 'Any credit card'). Display names are not considered when matching.

Parameters:

pOtherPaymentType - The payment type object we wish to check

Returns:

A boolean stating whether or not a match was found.

toString

public java.lang.String toString()

Return a string presentation of this payment type object.

Overrides:

toString in class java.lang.Object

getDisplayName

public java.lang.String getDisplayName(java.util.Locale pLocale)
                                throws java.util.MissingResourceException

Returns the display name associated with the given locale for this payment type.

Parameters:

pLocale - The locale to use in the lookup

Returns:

A localised display name based on the locale passed in

Throws:

MissingResourceExcpetion - if no resource bundle or string was found.

java.util.MissingResourceException