|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PaymentTransaction
A PaymentTransaction
is an Entity EJB that maintains the state
of an individual Credit Card transaction. This includes the credit card,
amount, status, and date of last modification. It also maintains a journal
of the actions in the form of TransactionEntry
objects taken as
the transaction is moved through authorization, capture, and settlement.
The transaction workflow is dictated by the PaymentWorkflow
state
machine.
PaymentTransactionPk
,
PaymentTransactionHome
,
PaymentTransactionValue
,
TransactionEntry
,
PaymentWorkflow
Method Summary | |
---|---|
boolean |
addTransactionEntry(TransactionEntry element)
Adds a new TransactionEntry to the journal. |
boolean |
addTransactionEntryCollection(Collection collection)
Adds all of the TransactionEntries to the journal. |
void |
authorize()
Change the state of the payment transaction by applying the authorize event. |
void |
clearTransactionEntryCollection()
Removes all of the transaction entries from the journal. |
boolean |
containsTransactionEntry(TransactionEntry element)
Returns true if this collection contains the specified element. |
boolean |
containsTransactionEntryCollection(Collection c)
Returns true if this collection contains all of the elements in the specified collection. |
boolean |
equalsTransactionEntryCollection(Object object)
Compares the specified object with this collection for equality. |
void |
failRetry()
Change the state of the payment transaction by applying the failRetry event. |
void |
failSettle()
Change the state of the payment transaction by applying the failSettle event. |
String |
getBatchId()
Get the value of the identifier for the batch in which this Payment was settled. |
com.beasys.commerce.axiom.contact.CreditCard |
getCreditCard()
Get the credit card information associated with the transaction. |
PaymentTransactionValue |
getPaymentTransactionByValue()
Retrieve a local copy of all of the public attributes in the form of a PaymentTransactionValue object. |
String |
getStatus()
Retrieve the status of this payment. |
Price |
getTransactionAmount()
Get the amount of the transaction. |
Date |
getTransactionDate()
Get the date that the transaction was last updated. |
Collection |
getTransactionEntryCollection()
Returns a history of the modifications to this transaction. |
String |
getTransactionId()
Get the transaction's identifier. |
boolean |
isTransactionEntryCollectionEmpty()
Returns true if this collection contains no elements. |
void |
markForSettle()
Change the state of the payment transaction by applying the markForSettle event. |
void |
pendingSettle()
Change the state of the payment transaction by applying the pendingSettle event. |
void |
queryFail()
Change the state of the payment transaction by applying the queryFail event. |
void |
querySuccess()
Change the state of the payment transaction by applying the querySuccess event. |
void |
reject()
Change the state of the payment transaction by applying the reject event. |
boolean |
removeTransactionEntry(TransactionEntry element)
Removes a single instance of the specified element from this collection, if it is present (optional operation). |
boolean |
removeTransactionEntryCollection(Collection collection)
Removes all this collection's elements that are also contained in the specified collection (optional operation). |
boolean |
retainTransactionEntryCollection(Collection collection)
Retains only the elements in this collection that are contained in the specified collection (optional operation). |
void |
setBatchId(String batchId)
Set the value of the identifier for the batch in which this Payment was settled. |
void |
setCreditCard(com.beasys.commerce.axiom.contact.CreditCard creditCard)
Set the credit card information associated with the transaction |
void |
setPaymentTransactionByValue(PaymentTransactionValue value)
Update all of the public attributes of a PaymentTransaction with a single method invocation. |
void |
settle()
Change the state of the payment transaction by applying the settle event. |
void |
setTransactionAmount(Price transactionAmount)
Set the amount of the transaction. |
void |
setTransactionDate(Date transactionDate)
Set the modification date for the PaymentTransaction |
void |
setTransactionEntryCollection(Collection collection)
Update the journal of the modifications for this transaction. |
void |
systemFailure()
Change the state of the payment transaction by applying the systemFailure event. |
int |
transactionEntryCollectionHashCode()
Returns the hash code value for this collection. |
int |
transactionEntryCollectionSize()
Returns the number of elements in this collection. |
Methods inherited from interface com.beasys.commerce.foundation.RemoteRelationalReference |
---|
get__classIdentifier, get__containingBelonging, get__containingEntity, get__mapKey, get__sequenceNumber, set__containingBelonging, set__containingEntity, set__mapKey |
Method Detail |
---|
PaymentTransactionValue getPaymentTransactionByValue() throws RemoteException
PaymentTransactionValue
object. This reduces the number of remote
method invocations needed to retrieve all of the information associated with this Entity.
RemoteException
- On remote error.void setPaymentTransactionByValue(PaymentTransactionValue value) throws RemoteException
PaymentTransactionValue
- the PaymentTransaction value object
RemoteException
- On remote error.String getTransactionId() throws RemoteException
PaymentTransactionValue
- the PaymentTransaction value object
RemoteException
- On remote error.com.beasys.commerce.axiom.contact.CreditCard getCreditCard() throws RemoteException
RemoteException
- On remote error.void setCreditCard(com.beasys.commerce.axiom.contact.CreditCard creditCard) throws RemoteException
creditCard
- the new credit card information
RemoteException
- On remote error.Date getTransactionDate() throws RemoteException
RemoteException
- On remote error.void setTransactionDate(Date transactionDate) throws RemoteException
transactionDate
- the transaction date to be set.
RemoteException
- On remote error.Collection getTransactionEntryCollection() throws RemoteException
TransactionEntry
objects.
RemoteException
- On remote error.void setTransactionEntryCollection(Collection collection) throws RemoteException
collection
- a collection of TransactionEntry
objects.
RemoteException
- On remote error.boolean addTransactionEntry(TransactionEntry element) throws RemoteException
element
- The Transaction entry to add.
RemoteException
- On remote error.boolean addTransactionEntryCollection(Collection collection) throws RemoteException
collection
- a collection of TransactionEntry
objects.
RemoteException
- On remote error.void clearTransactionEntryCollection() throws RemoteException
RemoteException
- On remote error.boolean containsTransactionEntry(TransactionEntry element) throws RemoteException
RemoteException
boolean containsTransactionEntryCollection(Collection c) throws RemoteException
RemoteException
boolean equalsTransactionEntryCollection(Object object) throws RemoteException
RemoteException
int transactionEntryCollectionHashCode() throws RemoteException
RemoteException
boolean isTransactionEntryCollectionEmpty() throws RemoteException
RemoteException
boolean removeTransactionEntry(TransactionEntry element) throws RemoteException
RemoteException
boolean removeTransactionEntryCollection(Collection collection) throws RemoteException
RemoteException
boolean retainTransactionEntryCollection(Collection collection) throws RemoteException
RemoteException
int transactionEntryCollectionSize() throws RemoteException
RemoteException
String getBatchId() throws RemoteException
RemoteException
void setBatchId(String batchId) throws RemoteException
batchId
- batchId to be added
RemoteException
String getStatus() throws RemoteException
PaymentWorkflow
RemoteException
Price getTransactionAmount() throws RemoteException
RemoteException
void setTransactionAmount(Price transactionAmount) throws RemoteException
transactionAmount
- the amount of the transaction.
RemoteException
void authorize() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void reject() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void failSettle() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void markForSettle() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void settle() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void pendingSettle() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void querySuccess() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void queryFail() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void systemFailure() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
void failRetry() throws RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
WorkflowInstantiationException
IllegalWorkflowTransitionException
RemoteException
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |