# com.beasys.commerce.ebusiness.payment
PaymentTransactionImpl Class

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 = PaymentTransactionPk

Related Topics

``PaymentTransaction``
``PaymentTransactionHome``
``PaymentTransactionValue``

Hierarchy
  `Object`
  `EntityImpl`
  `PaymentTransactionImpl`

All Implemented Interfaces
  `EnterpriseBean`, `EntityBean`, `RelationalReference`, `Serializable`

## Field Summary

`public `String`` | `batchId` The batchId attribute is populated after a batch-commit request for the transaction has returned successfully.
`public `CreditCard`` | `creditCard` Containment: By Value Multiplicity: 1:1
`public `WorkflowContext`` | `status` Containment: By Value Multiplicity: 1:1 WORKFLOW
`public transient `Workflow`` | `statusWorkflow` Workflow
`public `Price`` | `transactionAmount` In case of partial transcation(ie. return, cancel or settlement) this represents remainng transacation amount.
`public `Date`` | `transactionDate` The date of the transaction.
`public `SmartCollectionReference`` | `transactionEntry` Containment: By Value Multiplicity: 0:N Interface: java.util.Collection
`public `String`` | `transactionId` The order of which this transaction is a part.

Fields from com.beasys.commerce.foundation`.`EntityImpl``
``__classIdentifier`, `__containingEntity`, `__mapKey`, `__sequenceNumber`, `_ctx`, `_environmentNamingContext`, `_environmentPropertyCache`, `_isDirty`, `_smartBMP``

## Constructor Summary

PaymentTransactionImpl()

## Method Summary

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

Methods from `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 from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.ejb.`EntityBean``
`ejbActivate, ejbLoad, ejbPassivate, ejbRemove, ejbStore, setEntityContext, unsetEntityContext`

Methods from interface `com.beasys.commerce.foundation.`RelationalReference``
``get__classIdentifier`, `get__containingBelonging`, `get__containingEntity`, `get__mapKey`, `get__sequenceNumber`, `set__containingBelonging`, `set__containingEntity`, `set__mapKey``

## Field Detail

### batchId

    public 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

### creditCard

    public CreditCard creditCard

  - 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

### transactionDate

    public 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

### transactionId

    public String transactionId

  The order of which this transaction is a part.
  - Containment: By Value
  - Multiplicity: 1:1
  - PRIMARY KEY FIELD

## Constructor Detail

### PaymentTransactionImpl

    public PaymentTransactionImpl()

## Method Detail

### addTransactionEntry(TransactionEntry) Method

    public boolean addTransactionEntry(TransactionEntry element)

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

### addTransactionEntryCollection(Collection) Method

    public boolean addTransactionEntryCollection(Collection collection)

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

### authorize() Method

    public void authorize()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### bscInitializeAttributes(PaymentTransactionPk) Method

    protected void bscInitializeAttributes(PaymentTransactionPk paymentTransactionPk)
         throws CreateException

#### Exceptions

``CreateException``

### clearTransactionEntryCollection() Method

    public void clearTransactionEntryCollection()

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

### containsTransactionEntry(TransactionEntry) Method

    public boolean containsTransactionEntry(TransactionEntry element)

Returns true if this collection contains the specified element.

### containsTransactionEntryCollection(Collection) Method

    public boolean containsTransactionEntryCollection(Collection collection)

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

### ejbActivate() Method

    public void ejbActivate()
         throws EJBException

Description copied from `EntityImpl.ejbActivate()`
ejbActivate method.

Overrides
  `EntityImpl.ejbActivate()`

#### Exceptions

``EJBException``

### ejbCreate(PaymentTransactionPk) Method

    public PaymentTransactionPk ejbCreate(PaymentTransactionPk paymentTransactionPk)
         throws CreateException

#### Exceptions

``CreateException``

### ejbFindByPrimaryKey(PaymentTransactionPk) Method

    public PaymentTransactionPk ejbFindByPrimaryKey(PaymentTransactionPk pk)
         throws FinderException

#### Exceptions

``FinderException``

### ejbFindByStatus(String) Method

    public Collection ejbFindByStatus(String status)
         throws FinderException

Finds transactions by status.

#### Exceptions

``FinderException``

### ejbLoad() Method

    public void ejbLoad()
         throws EJBException

Description copied from `EntityImpl.ejbLoad()`
ejbLoad method.

Overrides
  `EntityImpl.ejbLoad()`

#### Exceptions

``EJBException``

### ejbPassivate() Method

    public void ejbPassivate()
         throws EJBException

Description copied from `EntityImpl.ejbPassivate()`
ejbPassivate method.

Overrides
  `EntityImpl.ejbPassivate()`

#### Exceptions

``EJBException``

### ejbPostCreate(PaymentTransactionPk) Method

    public void ejbPostCreate(PaymentTransactionPk paymentTransactionPk)
         throws CreateException

#### Exceptions

``CreateException``

### ejbRemove() Method

    public void ejbRemove()
         throws RemoveException

Description copied from `EntityImpl.ejbRemove()`
ejbRemove method.

Overrides
  `EntityImpl.ejbRemove()`

#### Exceptions

``RemoveException``

### ejbStore() Method

    public void ejbStore()
         throws EJBException

Description copied from `EntityImpl.ejbStore()`
ejbStore method.

Overrides
  `EntityImpl.ejbStore()`

#### Exceptions

``EJBException``

### equalsTransactionEntryCollection(Object) Method

    public boolean equalsTransactionEntryCollection(Object object)

Compares the specified object with this collection for equality.

### failRetry() Method

    public void failRetry()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### failSettle() Method

    public void failSettle()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### getBatchId() Method

    public String getBatchId()

Get the value of batchId

#### Returns

batchId.

### getCreditCard() Method

    public CreditCard getCreditCard()

Get the value of creditCard

#### Returns

creditCard.

### getPaymentTransactionByValue() Method

    public PaymentTransactionValue getPaymentTransactionByValue()

Get all of PaymentTransaction's attributes.

#### Returns

PaymentTransactionValue the PaymentTransaction value object

### getStatus() Method

    public String getStatus()

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

### getStatusWorkflow() Method

    protected Workflow getStatusWorkflow()

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

### getStatusWorkflowName() Method

    public 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.

### getTransactionAmount() Method

    public Price getTransactionAmount()

Get the value of transactionAmount

#### Returns

transactionAmount.

### getTransactionDate() Method

    public Date getTransactionDate()

Get the value of transactionDate

#### Returns

transactionDate.

### getTransactionEntryCollection() Method

    public Collection getTransactionEntryCollection()

Returns a deep copy of the entire collection

### getTransactionEntryCollectionReference() Method

    public SmartCollectionReference getTransactionEntryCollectionReference()

Get the SmartCollectionReference for transactionEntry

### getTransactionId() Method

    public String getTransactionId()

### isTransactionEntryCollectionEmpty() Method

    public boolean isTransactionEntryCollectionEmpty()

Returns true if this collection contains no elements.

### markForSettle() Method

    public void markForSettle()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### pendingSettle() Method

    public void pendingSettle()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### queryFail() Method

    public void queryFail()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### querySuccess() Method

    public void querySuccess()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### reject() Method

    public void reject()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### removeTransactionEntry(TransactionEntry) Method

    public boolean removeTransactionEntry(TransactionEntry element)

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

### removeTransactionEntryCollection(Collection) Method

    public boolean removeTransactionEntryCollection(Collection collection)

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

### retainTransactionEntryCollection(Collection) Method

    public boolean retainTransactionEntryCollection(Collection collection)

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

### setBatchId(String) Method

    public void setBatchId(String batchId)

Set the value of batchId

#### Parameters

batchId
  batchId to be added

### setCreditCard(CreditCard) Method

    public void setCreditCard(CreditCard creditCard)

Set the value of creditCard

#### Parameters

creditCard
  creditCard to be added

### setEntityContext(EntityContext) Method

    public void setEntityContext(EntityContext ctx)
         throws EJBException

Description copied from `EntityImpl.setEntityContext(EntityContext)`
setEntityContext method.

Overrides
  `EntityImpl.setEntityContext(EntityContext)`

#### Exceptions

``EJBException``

### setPaymentTransactionByValue(PaymentTransactionValue) Method

    public void setPaymentTransactionByValue(PaymentTransactionValue value)

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

#### Parameters

value
  the PaymentTransaction value object

### settle() Method

    public void settle()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### setTransactionAmount(Price) Method

    public void setTransactionAmount(Price transactionAmount)

Set the value of transactionAmount

#### Parameters

transactionAmount
  transactionAmount to be added

### setTransactionDate(Date) Method

    public void setTransactionDate(Date transactionDate)

Set the value of transactionDate

#### Parameters

transactionDate
  transactionDate to be added

### setTransactionEntryCollection(Collection) Method

    public void setTransactionEntryCollection(Collection collection)

Sets the entire collection

### setTransactionEntryCollectionReference(SmartCollectionReference) Method

    public void setTransactionEntryCollectionReference(SmartCollectionReference smartCollectionReference)

Set the SmartCollectionReference for transactionEntry

### setTransactionId(String) Method

    public void setTransactionId(String value)

### systemFailure() Method

    public void systemFailure()
         throws WorkflowInstantiationException, IllegalWorkflowTransitionException

#### Exceptions

``WorkflowInstantiationException``
``IllegalWorkflowTransitionException``

### transactionEntryCollectionHashCode() Method

    public int transactionEntryCollectionHashCode()

Returns the hash code value for this collection.

### transactionEntryCollectionIterator() Method

    public Iterator transactionEntryCollectionIterator()

Returns an iterator over the elements in this collection.

### transactionEntryCollectionSize() Method

    public int transactionEntryCollectionSize()

Returns the number of elements in this collection.

### unsetEntityContext() Method

    public void unsetEntityContext()
         throws EJBException

Description copied from `EntityImpl.unsetEntityContext()`
unsetEntityContext method.

Overrides
  `EntityImpl.unsetEntityContext()`

#### Exceptions

``EJBException``