atg.payment.giftcertificate

Interface GiftCertificateProcessor

All Known Implementing Classes:

DummyGiftCertificateProcessor, GiftCertificateProcessorImpl

public interface GiftCertificateProcessor

This class defines an interface for gift certificate processing. It has three methods for submitting transactions to a gtft certificate processing system. They are authorize, debit, and credit. Any class which implements this class must provide implementations for each of these methods.

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
GiftCertificateStatus	authorize(GiftCertificateInfo pGiftCertificateInfo) Authorize the gift certificate
GiftCertificateStatus	credit(GiftCertificateInfo pGiftCertificateInfo) Credit the amount on the gift certificate without a previous debit.
GiftCertificateStatus	credit(GiftCertificateInfo pGiftCertificateInfo, PaymentStatus pStatus) Credit the amount on the gift certificate after debiting.
GiftCertificateStatus	debit(GiftCertificateInfo pGiftCertificateInfo, PaymentStatus pStatus) Debit the amount on the gift certificate after authorization
GiftCertificateStatus	expireAuthorization(GiftCertificateInfo pGiftCertificateInfo) Expire a gift certificate authorization

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

authorize

GiftCertificateStatus authorize(GiftCertificateInfo pGiftCertificateInfo)

Authorize the gift certificate

Parameters:

pGiftCertificateInfo - the GiftCertificateInfo reference which contains all the authorization data

Returns:

a GiftCertificateStatus object detailing the results of the authorization

expireAuthorization

GiftCertificateStatus expireAuthorization(GiftCertificateInfo pGiftCertificateInfo)

Expire a gift certificate authorization

Parameters:

pGiftCertificateInfo - the GiftCertificateInfo reference which contains all the authorization expiration data

Returns:

a GiftCertificateStatus object detailing the results of the authorization

debit

GiftCertificateStatus debit(GiftCertificateInfo pGiftCertificateInfo,
                          PaymentStatus pStatus)

Debit the amount on the gift certificate after authorization

Parameters:

pGiftCertificateInfo - the GiftCertificateInfo reference which contains all the debit data

pStatus - the PaymentStatus object which contains information about the transaction. This should be the object which was returned from authorize().

Returns:

a GiftCertificateStatus object detailing the results of the debit

credit

GiftCertificateStatus credit(GiftCertificateInfo pGiftCertificateInfo,
                           PaymentStatus pStatus)

Credit the amount on the gift certificate after debiting.

Parameters:

pGiftCertificateInfo - the GiftCertificateInfo reference which contains all the credit data

pStatus - the PaymentStatus object which contains information about the transaction. This should be the object which was returned from debit().

Returns:

a GiftCertificateStatus object detailing the results of the credit

credit

GiftCertificateStatus credit(GiftCertificateInfo pGiftCertificateInfo)

Credit the amount on the gift certificate without a previous debit.

Parameters:

pGiftCertificateInfo - the GiftCertificateInfo reference which contains all the credit data

Returns:

a GiftCertificateStatus object detailing the results of the credit