BEA WebLogic Portal 7.0.5.0 JavaDoc: Overview: Class PaymentTransactionImpl

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.beasys.commerce.ebusiness.payment
Class PaymentTransactionImpl

java.lang.Object
  |
  +--com.beasys.commerce.foundation.EntityImpl
        |
        +--com.beasys.commerce.ebusiness.payment.PaymentTransactionImpl

public class PaymentTransactionImpl
extends EntityImpl

This class holds data common to all the transaction types. The PaymentTransactionManager uses this class to pass along to the payment service provider - reqeusts made by the client.

 Primary Key = com.beasys.commerce.ebusiness.payment.PaymentTransactionPk

See Also:: PaymentTransaction, PaymentTransactionHome, PaymentTransactionValue, Serialized Form

Field Summary
`java.lang.String`	`batchId` The batchId attribute is populated after a batch-commit request for the transaction has returned successfully.
`com.beasys.commerce.axiom.contact.CreditCard`	`creditCard` Containment: By Value Multiplicity: 1:1
`WorkflowContext`	`status` Containment: By Value Multiplicity: 1:1 WORKFLOW
`Workflow`	`statusWorkflow`
`Price`	`transactionAmount` In case of partial transcation(ie.
`java.sql.Date`	`transactionDate` The date of the transaction.
`SmartCollectionReference`	`transactionEntry` Containment: By Value Multiplicity: 0:N Interface: java.util.Collection
`java.lang.String`	`transactionId` The order of which this transaction is a part.

Fields inherited from class com.beasys.commerce.foundation.EntityImpl

__classIdentifier,  
__containingEntity,  
__mapKey,  
__sequenceNumber,  
_ctx,  
_environmentNamingContext,  
_environmentPropertyCache,  
_isDirty,  
_smartBMP

Constructor Summary
`PaymentTransactionImpl()`

Method Summary
`boolean`	`addTransactionEntry(TransactionEntry element)` Ensures that this collection contains the specified element (optional operation).
`boolean`	`addTransactionEntryCollection(java.util.Collection collection)` Adds all of the elements in the specified collection to this collection (optional operation).
`void`	`authorize()`
`protected void`	`bscInitializeAttributes(PaymentTransactionPk paymentTransactionPk)`
`void`	`clearTransactionEntryCollection()` Removes all of the elements from this collection (optional operation).
`boolean`	`containsTransactionEntry(TransactionEntry element)` Returns true if this collection contains the specified element.
`boolean`	`containsTransactionEntryCollection(java.util.Collection collection)` Returns true if this collection contains all of the elements in the specified collection.
`void`	`ejbActivate()`
`PaymentTransactionPk`	`ejbCreate(PaymentTransactionPk paymentTransactionPk)`
`PaymentTransactionPk`	`ejbFindByPrimaryKey(PaymentTransactionPk pk)`
`java.util.Collection`	`ejbFindByStatus(java.lang.String status)` Finds transactions by status.
`void`	`ejbLoad()`
`void`	`ejbPassivate()`
`void`	`ejbPostCreate(PaymentTransactionPk paymentTransactionPk)`
`void`	`ejbRemove()`
`void`	`ejbStore()`
`boolean`	`equalsTransactionEntryCollection(java.lang.Object object)` Compares the specified object with this collection for equality.
`void`	`failRetry()`
`void`	`failSettle()`
`java.lang.String`	`getBatchId()` Get the value of batchId
`com.beasys.commerce.axiom.contact.CreditCard`	`getCreditCard()` Get the value of creditCard
`PaymentTransactionValue`	`getPaymentTransactionByValue()` Get all of PaymentTransaction's attributes.
`java.lang.String`	`getStatus()` Returns the current state name of the com.beasys.commerce.ebusiness.payment.PaymentWorkflow workflow
`protected Workflow`	`getStatusWorkflow()` returns the Workflow status.
`java.lang.String`	`getStatusWorkflowName()` Returns the workflow classname that status uses.
`Price`	`getTransactionAmount()` Get the value of transactionAmount
`java.sql.Date`	`getTransactionDate()` Get the value of transactionDate
`java.util.Collection`	`getTransactionEntryCollection()` Returns a deep copy of the entire collection
`SmartCollectionReference`	`getTransactionEntryCollectionReference()` Get the SmartCollectionReference for transactionEntry
`java.lang.String`	`getTransactionId()`
`boolean`	`isTransactionEntryCollectionEmpty()` Returns true if this collection contains no elements.
`void`	`markForSettle()`
`void`	`pendingSettle()`
`void`	`queryFail()`
`void`	`querySuccess()`
`void`	`reject()`
`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 batchId
`void`	`setCreditCard(com.beasys.commerce.axiom.contact.CreditCard creditCard)` Set the value of creditCard
`void`	`setEntityContext(javax.ejb.EntityContext ctx)`
`void`	`setPaymentTransactionByValue(PaymentTransactionValue value)` Set all of PaymentTransaction's attributes to the passed in value.
`void`	`settle()`
`void`	`setTransactionAmount(Price transactionAmount)` Set the value of transactionAmount
`void`	`setTransactionDate(java.sql.Date transactionDate)` Set the value of transactionDate
`void`	`setTransactionEntryCollection(java.util.Collection collection)` Sets the entire collection
`void`	`setTransactionEntryCollectionReference(SmartCollectionReference smartCollectionReference)` Set the SmartCollectionReference for transactionEntry
`void`	`setTransactionId(java.lang.String value)`
`void`	`systemFailure()`
`int`	`transactionEntryCollectionHashCode()` Returns the hash code value for this collection.
`java.util.Iterator`	`transactionEntryCollectionIterator()` Returns an iterator over the elements in this collection.
`int`	`transactionEntryCollectionSize()` Returns the number of elements in this collection.
`void`	`unsetEntityContext()`

Methods inherited from class com.beasys.commerce.foundation.EntityImpl

bscInitializeAttributes, 
clearRelationalBinding, 
clearRelationalBinding, 
clearRelationalBinding, 
clearRelationalBinding, 
doRelationalBinding, 
doRelationalBinding, 
doRelationalBindingOnElement, 
doRelationalBindingOnElement, 
doRelationalBindingOnElement, 
doRelationalBindingOnSingleton, 
doRelationalBindingOnSingleton, 
doRelationalBindingOnSingleton, 
doRelationalBindingWithMapKey, 
doRelationalBindingWithMapKey, 
doRelationalBindingWithMapKey, 
ejbCreate, 
ejbFindAll, 
ejbFindByPrimaryKey, 
ejbPostCreate, 
enumerateRelationalBinding, 
enumerateRelationalBinding, 
get__classIdentifier, 
get__containingBelonging, 
get__containingEntity, 
get__containingEntityReference, 
get__mapKey, 
get__sequenceNumber, 
getEntityContext, 
getEnvironmentNamingContext, 
getEnvironmentProperty, 
getEnvironmentProperty, 
getEnvironmentPropertyCache, 
getPersistenceHelperPlugin, 
getSmartBMP, 
initSmartBMP, 
isModified, 
set__classIdentifier, 
set__containingBelonging, 
set__containingEntity, 
set__containingEntityReference, 
set__mapKey

Methods inherited from class java.lang.Object

clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

Field Detail

transactionId

public java.lang.String transactionId

The order of which this transaction is a part.

Containment: By Value
Multiplicity: 1:1
PRIMARY KEY FIELD

creditCard

public com.beasys.commerce.axiom.contact.CreditCard creditCard

Containment: By Value
Multiplicity: 1:1

transactionDate

public java.sql.Date transactionDate

The date of the transaction.

Containment: By Value
Multiplicity: 1:1

transactionEntry

public SmartCollectionReference transactionEntry

Containment: By Value
Multiplicity: 0:N
Interface: java.util.Collection

batchId

public java.lang.String batchId

The batchId attribute is populated after a batch-commit request for the transaction has returned successfully. It is then used to query the Payment Service for the results of a settled transaction.

Containment: By Value
Multiplicity: 1:1

status

public WorkflowContext status

Containment: By Value
Multiplicity: 1:1
WORKFLOW

statusWorkflow

public transient Workflow statusWorkflow

transactionAmount

public Price transactionAmount

In case of partial transcation(ie. return, cancel or settlement) this represents remainng transacation amount.

Containment: By Value
Multiplicity: 1:1

Constructor Detail

PaymentTransactionImpl

public PaymentTransactionImpl()

Method Detail

getPaymentTransactionByValue

public PaymentTransactionValue getPaymentTransactionByValue()

Get all of PaymentTransaction's attributes.

Returns:: PaymentTransactionValue the PaymentTransaction value object

setPaymentTransactionByValue

public void setPaymentTransactionByValue(PaymentTransactionValue value)

Set all of PaymentTransaction's attributes to the passed in value. Note: Primary key attributes are not set.

Parameters:: PaymentTransactionValue - the PaymentTransaction value object

ejbCreate

public PaymentTransactionPk ejbCreate(PaymentTransactionPk paymentTransactionPk)
                               throws javax.ejb.CreateException

bscInitializeAttributes

protected void bscInitializeAttributes(PaymentTransactionPk paymentTransactionPk)
                                throws javax.ejb.CreateException

ejbPostCreate

public void ejbPostCreate(PaymentTransactionPk paymentTransactionPk)
                   throws javax.ejb.CreateException

ejbLoad

public void ejbLoad()
             throws javax.ejb.EJBException

Overrides:: ejbLoad in class EntityImpl

ejbStore

public void ejbStore()
              throws javax.ejb.EJBException

Overrides:: ejbStore in class EntityImpl

ejbRemove

public void ejbRemove()
               throws javax.ejb.RemoveException

Overrides:: ejbRemove in class EntityImpl

ejbActivate

public void ejbActivate()
                 throws javax.ejb.EJBException

Overrides:: ejbActivate in class EntityImpl

ejbPassivate

public void ejbPassivate()
                  throws javax.ejb.EJBException

Overrides:: ejbPassivate in class EntityImpl

setEntityContext

public void setEntityContext(javax.ejb.EntityContext ctx)
                      throws javax.ejb.EJBException

Overrides:: setEntityContext in class EntityImpl

unsetEntityContext

public void unsetEntityContext()
                        throws javax.ejb.EJBException

Overrides:: unsetEntityContext in class EntityImpl

ejbFindByPrimaryKey

public PaymentTransactionPk ejbFindByPrimaryKey(PaymentTransactionPk pk)
                                         throws javax.ejb.FinderException

getCreditCard

public com.beasys.commerce.axiom.contact.CreditCard getCreditCard()

Get the value of creditCard

Returns:: creditCard.

setCreditCard

public void setCreditCard(com.beasys.commerce.axiom.contact.CreditCard creditCard)

Set the value of creditCard

Parameters:: creditCard - creditCard to be added

getTransactionDate

public java.sql.Date getTransactionDate()

Get the value of transactionDate

Returns:: transactionDate.

setTransactionDate

public void setTransactionDate(java.sql.Date transactionDate)

Set the value of transactionDate

Parameters:: transactionDate - transactionDate to be added

getTransactionEntryCollectionReference

public SmartCollectionReference getTransactionEntryCollectionReference()

Get the SmartCollectionReference for transactionEntry

setTransactionEntryCollectionReference

public void setTransactionEntryCollectionReference(SmartCollectionReference smartCollectionReference)

Set the SmartCollectionReference for transactionEntry

getTransactionEntryCollection

public java.util.Collection getTransactionEntryCollection()

Returns a deep copy of the entire collection

setTransactionEntryCollection

public void setTransactionEntryCollection(java.util.Collection collection)

Sets the entire collection

addTransactionEntry

public boolean addTransactionEntry(TransactionEntry element)

Ensures that this collection contains the specified element (optional operation).

addTransactionEntryCollection

public boolean addTransactionEntryCollection(java.util.Collection collection)

Adds all of the elements in the specified collection to this collection (optional operation).

clearTransactionEntryCollection

public void clearTransactionEntryCollection()

Removes all of the elements from this collection (optional operation).

containsTransactionEntry

public boolean containsTransactionEntry(TransactionEntry element)

Returns true if this collection contains the specified element.

containsTransactionEntryCollection

public boolean containsTransactionEntryCollection(java.util.Collection collection)

Returns true if this collection contains all of the elements in the specified collection.

equalsTransactionEntryCollection

public boolean equalsTransactionEntryCollection(java.lang.Object object)

Compares the specified object with this collection for equality.

transactionEntryCollectionHashCode

public int transactionEntryCollectionHashCode()

Returns the hash code value for this collection.

isTransactionEntryCollectionEmpty

public boolean isTransactionEntryCollectionEmpty()

Returns true if this collection contains no elements.

transactionEntryCollectionIterator

public java.util.Iterator transactionEntryCollectionIterator()

Returns an iterator over the elements in this collection.

removeTransactionEntry

public boolean removeTransactionEntry(TransactionEntry element)

Removes a single instance of the specified element from this collection, if it is present (optional operation).

removeTransactionEntryCollection

public boolean removeTransactionEntryCollection(java.util.Collection collection)

Removes all this collection's elements that are also contained in the specified collection (optional operation).

retainTransactionEntryCollection

public boolean retainTransactionEntryCollection(java.util.Collection collection)

Retains only the elements in this collection that are contained in the specified collection (optional operation).

transactionEntryCollectionSize

public int transactionEntryCollectionSize()

Returns the number of elements in this collection.

getBatchId

public java.lang.String getBatchId()

Get the value of batchId

Returns:: batchId.

setBatchId

public void setBatchId(java.lang.String batchId)

Set the value of batchId

Parameters:: batchId - batchId to be added

getStatusWorkflowName

public java.lang.String getStatusWorkflowName()

Returns the workflow classname that status uses. Currently, this is set to "com.beasys.commerce.ebusiness.payment.PaymentWorkflow". You may override this by extending this class. This method is used internally by the BSCs.

getStatus

public java.lang.String getStatus()

Returns the current state name of the com.beasys.commerce.ebusiness.payment.PaymentWorkflow workflow

getStatusWorkflow

protected Workflow getStatusWorkflow()

returns the Workflow status. If this is null, creates the workflow and resets it.

Throws:: WorkflowInstantiationException - could not instantiate workflow

getTransactionId

public java.lang.String getTransactionId()

setTransactionId

public void setTransactionId(java.lang.String value)

getTransactionAmount

public Price getTransactionAmount()

Get the value of transactionAmount

Returns:: transactionAmount.

setTransactionAmount

public void setTransactionAmount(Price transactionAmount)

Set the value of transactionAmount

Parameters:: transactionAmount - transactionAmount to be added

authorize

public void authorize()
               throws WorkflowInstantiationException,
                      IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

reject

public void reject()
            throws WorkflowInstantiationException,
                   IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

failSettle

public void failSettle()
                throws WorkflowInstantiationException,
                       IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

markForSettle

public void markForSettle()
                   throws WorkflowInstantiationException,
                          IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

settle

public void settle()
            throws WorkflowInstantiationException,
                   IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

pendingSettle

public void pendingSettle()
                   throws WorkflowInstantiationException,
                          IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

querySuccess

public void querySuccess()
                  throws WorkflowInstantiationException,
                         IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

queryFail

public void queryFail()
               throws WorkflowInstantiationException,
                      IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

systemFailure

public void systemFailure()
                   throws WorkflowInstantiationException,
                          IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

failRetry

public void failRetry()
               throws WorkflowInstantiationException,
                      IllegalWorkflowTransitionException

Throws:: WorkflowInstantiationException -; IllegalWorkflowTransitionException -

ejbFindByStatus

public java.util.Collection ejbFindByStatus(java.lang.String status)
                                     throws javax.ejb.FinderException

Finds transactions by status.