org.cyclos.entities.banking

Class Transaction

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.banking.Transaction

All Implemented Interfaces:

java.lang.Cloneable, HasCurrency, HasEntityImportance, ProcessableForDataTranslation, EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>, HasTransactionNumber, IEntity

Direct Known Subclasses:

ExternalPayment, InternalTransaction

@Entity
public abstract class Transaction
extends BaseEntity
implements HasTransactionNumber, HasCurrency, EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>

A transaction is an abstract subject, which will determine that funds are transferred between accounts by one or more Transfers.

Author:

luis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Transaction.TransactionCustomizer Customizer to allow direct access to fields on queries

Constructor Summary

Constructors

Constructor and Description
Transaction()

Method Summary

Modifier and Type	Method and Description
AccessClient	getAccessClient()
java.math.BigDecimal	getAmount()
BasicUser	getBy()
Channel	getChannel()
Currency	getCurrency()
CurrencyAmount	getCurrencyAmount()
java.lang.Class<TransactionCustomFieldValue>	getCustomFieldValueClass() Returns the class for storing custom field values
java.util.Set<TransactionCustomFieldValue>	getCustomValues() Returns all custom field values
java.util.Date	getDate()
java.lang.String	getDescription()
abstract AccountLocator	getDestinationAccountLocator()
EntityImportance	getEntityImportance()
java.lang.String	getFromName()
InternalAccountOwner	getFromOwner()
User	getFromUser()
abstract Location	getLocation()
abstract TransactionNature	getNature()
Network	getNetwork()
PaymentRequest	getPaymentRequest()
PrincipalType	getPrincipalType()
abstract java.util.Date	getProcessDate() Returns the date the transaction was actually processed
abstract AccountLocator	getSourceAccountLocator()
java.lang.String	getToName()
AccountOwner	getToOwner()
User	getToUser()
java.lang.String	getTransactionNumber()
TransactionNumber	getTransactionNumberRef()
TransferType	getType()
boolean	isFromSystem()
boolean	isFromUser()
boolean	isToSystem()
boolean	isToUser()
void	setAccessClient(AccessClient accessClient)
void	setAmount(java.math.BigDecimal amount)
void	setBy(BasicUser by)
void	setChannel(Channel channel)
void	setCustomValues(java.util.Set<TransactionCustomFieldValue> customValues)
void	setDate(java.util.Date date)
void	setDescription(java.lang.String description)
void	setFromName(java.lang.String fromName)
void	setFromOwner(InternalAccountOwner from)
void	setFromUser(User fromUser)
void	setPrincipalType(PrincipalType principalType)
void	setToName(java.lang.String toName)
void	setToOwner(AccountOwner to)
void	setToUser(User toUser)
void	setTransactionNumberRef(TransactionNumber transactionNumberRef)
void	setType(TransferType type)

Methods inherited from class org.cyclos.entities.BaseEntity

getDataTranslationType, getLogType, getVersion, isGlobal, isPersistent, isTransient

Methods inherited from class org.cyclos.entities.SimpleEntity

clone, equals, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity

getId

Constructor Detail

Transaction

public Transaction()

Method Detail

getAccessClient

public AccessClient getAccessClient()

getAmount

public java.math.BigDecimal getAmount()

getBy

public BasicUser getBy()

getChannel

public Channel getChannel()

getCurrency

public Currency getCurrency()

Specified by:

getCurrency in interface HasCurrency

getCurrencyAmount

public CurrencyAmount getCurrencyAmount()

getCustomFieldValueClass

public java.lang.Class<TransactionCustomFieldValue> getCustomFieldValueClass()

Description copied from interface: EntityWithCustomValues

Returns the class for storing custom field values

Specified by:

getCustomFieldValueClass in interface EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>

getCustomValues

public java.util.Set<TransactionCustomFieldValue> getCustomValues()

Description copied from interface: EntityWithCustomValues

Returns all custom field values

Specified by:

getCustomValues in interface EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>

getDate

public java.util.Date getDate()

getDescription

public java.lang.String getDescription()

getDestinationAccountLocator

public abstract AccountLocator getDestinationAccountLocator()

getEntityImportance

public EntityImportance getEntityImportance()

Specified by:

getEntityImportance in interface HasEntityImportance

Overrides:

getEntityImportance in class SimpleEntity

getFromName

public java.lang.String getFromName()

getFromOwner

public InternalAccountOwner getFromOwner()

getFromUser

public User getFromUser()

getLocation

public abstract Location getLocation()

getNature

public abstract TransactionNature getNature()

getNetwork

public Network getNetwork()

Specified by:

getNetwork in class BaseEntity

Returns:

the network this entity belongs to

getPaymentRequest

public PaymentRequest getPaymentRequest()

getPrincipalType

public PrincipalType getPrincipalType()

getProcessDate

public abstract java.util.Date getProcessDate()

Returns the date the transaction was actually processed

getSourceAccountLocator

public abstract AccountLocator getSourceAccountLocator()

getToName

public java.lang.String getToName()

getToOwner

public AccountOwner getToOwner()

getToUser

public User getToUser()

getTransactionNumber

public java.lang.String getTransactionNumber()

Specified by:

getTransactionNumber in interface HasTransactionNumber

getTransactionNumberRef

public TransactionNumber getTransactionNumberRef()

getType

public TransferType getType()

isFromSystem

public boolean isFromSystem()

isFromUser

public boolean isFromUser()

isToSystem

public boolean isToSystem()

isToUser

public boolean isToUser()

setAccessClient

public void setAccessClient(AccessClient accessClient)

setAmount

public void setAmount(java.math.BigDecimal amount)

setBy

public void setBy(BasicUser by)

setChannel

public void setChannel(Channel channel)

setCustomValues

public void setCustomValues(java.util.Set<TransactionCustomFieldValue> customValues)

setDate

public void setDate(java.util.Date date)

setDescription

public void setDescription(java.lang.String description)

setFromName

public void setFromName(java.lang.String fromName)

setFromOwner

public void setFromOwner(InternalAccountOwner from)

setFromUser

public void setFromUser(User fromUser)

setPrincipalType

public void setPrincipalType(PrincipalType principalType)

setToName

public void setToName(java.lang.String toName)

setToOwner

public void setToOwner(AccountOwner to)

setToUser

public void setToUser(User toUser)

setTransactionNumberRef

public void setTransactionNumberRef(TransactionNumber transactionNumberRef)

setType

public void setType(TransferType type)