|
© 2002 BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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(java.util.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(java.util.Collection c)
Returns true if this collection contains all of the elements in the specified collection. |
boolean |
equalsTransactionEntryCollection(java.lang.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. |
java.lang.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. |
java.lang.String |
getStatus()
Retrieve the status of this payment. |
Price |
getTransactionAmount()
Get the amount of the transaction. |
java.sql.Date |
getTransactionDate()
Get the date that the transaction was last updated. |
java.util.Collection |
getTransactionEntryCollection()
Returns a history of the modifications to this transaction. |
java.lang.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(java.util.Collection collection)
Removes all this collection's elements that are also contained in the specified collection (optional operation). |
boolean |
retainTransactionEntryCollection(java.util.Collection collection)
Retains only the elements in this collection that are contained in the specified collection (optional operation). |
void |
setBatchId(java.lang.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(java.sql.Date transactionDate)
Set the modification date for the PaymentTransaction |
void |
setTransactionEntryCollection(java.util.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 javax.ejb.EJBObject |
getEJBHome,
getHandle,
getPrimaryKey,
isIdentical,
remove |
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 |
public PaymentTransactionValue getPaymentTransactionByValue() throws java.rmi.RemoteException
PaymentTransactionValue
object. This reduces the number of remote
method invocations needed to retrieve all of the information associated with this Entity.
public void setPaymentTransactionByValue(PaymentTransactionValue value) throws java.rmi.RemoteException
PaymentTransactionValue
- the PaymentTransaction value objectpublic java.lang.String getTransactionId() throws java.rmi.RemoteException
PaymentTransactionValue
- the PaymentTransaction value objectpublic com.beasys.commerce.axiom.contact.CreditCard getCreditCard() throws java.rmi.RemoteException
public void setCreditCard(com.beasys.commerce.axiom.contact.CreditCard creditCard) throws java.rmi.RemoteException
creditCard
- the new credit card informationpublic java.sql.Date getTransactionDate() throws java.rmi.RemoteException
public void setTransactionDate(java.sql.Date transactionDate) throws java.rmi.RemoteException
transactionDate
- the transaction date to be set.public java.util.Collection getTransactionEntryCollection() throws java.rmi.RemoteException
TransactionEntry
objects.public void setTransactionEntryCollection(java.util.Collection collection) throws java.rmi.RemoteException
collection
- a collection of TransactionEntry
objects.public boolean addTransactionEntry(TransactionEntry element) throws java.rmi.RemoteException
element
- The Transaction entry to add.public boolean addTransactionEntryCollection(java.util.Collection collection) throws java.rmi.RemoteException
collection
- a collection of TransactionEntry
objects.public void clearTransactionEntryCollection() throws java.rmi.RemoteException
public boolean containsTransactionEntry(TransactionEntry element) throws java.rmi.RemoteException
public boolean containsTransactionEntryCollection(java.util.Collection c) throws java.rmi.RemoteException
public boolean equalsTransactionEntryCollection(java.lang.Object object) throws java.rmi.RemoteException
public int transactionEntryCollectionHashCode() throws java.rmi.RemoteException
public boolean isTransactionEntryCollectionEmpty() throws java.rmi.RemoteException
public boolean removeTransactionEntry(TransactionEntry element) throws java.rmi.RemoteException
public boolean removeTransactionEntryCollection(java.util.Collection collection) throws java.rmi.RemoteException
public boolean retainTransactionEntryCollection(java.util.Collection collection) throws java.rmi.RemoteException
public int transactionEntryCollectionSize() throws java.rmi.RemoteException
public java.lang.String getBatchId() throws java.rmi.RemoteException
public void setBatchId(java.lang.String batchId) throws java.rmi.RemoteException
batchId
- batchId to be addedpublic java.lang.String getStatus() throws java.rmi.RemoteException
PaymentWorkflow
public Price getTransactionAmount() throws java.rmi.RemoteException
public void setTransactionAmount(Price transactionAmount) throws java.rmi.RemoteException
transactionAmount
- the amount of the transaction.public void authorize() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void reject() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void failSettle() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void markForSettle() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void settle() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void pendingSettle() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void querySuccess() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void queryFail() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void systemFailure() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
public void failRetry() throws java.rmi.RemoteException, WorkflowInstantiationException, IllegalWorkflowTransitionException
|
© 2002 BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |