org.cyclos.entities.banking

Class Transaction

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.banking.Transaction

All Implemented Interfaces:

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

Direct Known Subclasses:

ExternalPayment, InternalTransaction

@Entity
public abstract class Transaction
extends NetworkedEntity
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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	status This represents the status of the transaction.
protected Transaction	transaction This represents the generated transaction after this transaction was processed.

Constructor Summary

Constructors

Constructor and Description
Transaction()

Method Summary

Modifier and Type	Method and Description
AccessClient	getAccessClient()
BasicUser	getActualBy() Returns the user that made the payment: the from owner or the the by user.
java.math.BigDecimal	getAmount()
BasicUser	getBy() Returns the user that made the payment only if different from the "from account owner".
Channel	getChannel()
Currency	getCurrency()
CurrencyAmount	getCurrencyAmount()
java.lang.Class<TransactionCustomField>	getCustomFieldClass() Returns custom field the class on this entity
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()
java.lang.String	getFromName()
InternalAccountOwner	getFromOwner()
User	getFromUser()
abstract Location	getLocation()
abstract TransactionNature	getNature()
Network	getNetwork() Returns the network this entity belongs to
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	setBySelf(boolean bySelf)
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	setPrincipalType(PrincipalType principalType)
void	setToName(java.lang.String toName)
void	setToOwner(AccountOwner to)
void	setTransactionNumberRef(TransactionNumber transactionNumberRef)
void	setType(TransferType type)

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.model.IEntity

getId

Field Detail

transaction

protected Transaction transaction

This represents the generated transaction after this transaction was processed. Indeed it only belongs to some sub-classes, to know: Ticket, PaymentRequest, ExternalPayment but we put it here so we can make (DB) queries simpler. Here we have only the property the corresponding get/set methods are in each subclass with the right type.

status

protected java.lang.String status

This represents the status of the transaction. Indeed it only belongs to some sub-classes, to know: Ticket, PaymentRequest, ExternalPayment, RecurringPayment, ScheduledPayment but we put it here so we can make (DB) queries simpler. Here we have only the property the corresponding get/set methods are in each subclass with the right enum type.

Constructor Detail

Transaction

public Transaction()

Method Detail

getAccessClient

public AccessClient getAccessClient()

getActualBy

public BasicUser getActualBy()

Returns the user that made the payment: the from owner or the the by user. It could return null in case of payments made by system or scripts without a logged user.

getAmount

public java.math.BigDecimal getAmount()

getBy

public BasicUser getBy()

Returns the user that made the payment only if different from the "from account owner". If the payment is from user (i.e. the owner is a member) then the "by" could be a manager or an operator of the owner. Otherwise (on a payment from system) it will be the administrator who made the payment.
There are two cases where the "by" will be null but it doesn't means the payment was made by the user itself:

• A payment made by system (i.e. SystemSessionData).
• A payment made by a script (i.e. ScriptSessionData) without a logged user.

Then this method must be used with care (mainly to return it to the client) but for server side calculations you should use this method getActualBy() that will take into account the cases described above and also won't return null if the the payment was made by the from owner (this method will).

See Also:

getActualBy()

getChannel

public Channel getChannel()

getCurrency

public Currency getCurrency()

Specified by:

getCurrency in interface HasCurrency

getCurrencyAmount

public CurrencyAmount getCurrencyAmount()

getCustomFieldClass

public java.lang.Class<TransactionCustomField> getCustomFieldClass()

Description copied from interface: EntityWithCustomValues

Returns custom field the class on this entity

Specified by:

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

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()

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()

Description copied from class: NetworkedEntity

Returns the network this entity belongs to

Specified by:

getNetwork in class NetworkedEntity

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)

setBySelf

public void setBySelf(boolean bySelf)

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)

setPrincipalType

public void setPrincipalType(PrincipalType principalType)

setToName

public void setToName(java.lang.String toName)

setToOwner

public void setToOwner(AccountOwner to)

setTransactionNumberRef

public void setTransactionNumberRef(TransactionNumber transactionNumberRef)

setType

public void setType(TransferType type)