Package 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:

Cloneable, HasCurrency, HasCurrencyAmount, Trans, ProcessableForDataTranslation, EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>, HasTransactionNumber, IEntity, HasAmount

Direct Known Subclasses:

ExternalPayment, InternalTransaction

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

Field Summary

Fields

Modifier and Type	Field	Description
protected TransactionAuthorizationStatus	authorizationStatus	This represents the authorization status of the transaction.
protected TransactionAuthorizationType	authorizationType	This represents the authorization status type of the transaction.
protected Date	expirationDate	The expiration date is used in a few subclasses, but is declared here to make queries easier
protected AuthorizationLevel	nextAuthorizationLevel	This really belongs to BasePayment and its subclasses, but we put it here so we can make (DB) queries simpler.
protected Boolean	received	This really belongs to BasePayment and its subclasses, but we put it here so we can make (DB) queries simpler.
protected Operator	receivedBy	This really belongs to BasePayment and its subclasses, but we put it here so we can make (DB) queries simpler.
protected Boolean	showToReceiver	This represents if a transaction is shown to receiver.
protected 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	Description
Transaction()

Method Summary

Modifier and Type	Method	Description
AccessClient	getAccessClient()
BigDecimal	getAmount()
BasicUser	getBy()
Channel	getChannel()
Currency	getCurrency()
Class<TransactionCustomField>	getCustomFieldClass()	Returns custom field the class on this entity
Class<TransactionCustomFieldValue>	getCustomFieldValueClass()	Returns the class for storing custom field values
Set<TransactionCustomFieldValue>	getCustomValues()	Returns all custom field values
Date	getDate()
String	getDescription()
Account	getFrom()
String	getFromName()
abstract Location	getLocation()
abstract TransactionNature	getNature()
Network	getNetwork()	Returns the network this entity belongs to
BasicUser	getPerformer()	If this payment was performed by an operator, returns it.
PrincipalType	getPrincipalType()
abstract Date	getProcessDate()	Returns the date the transaction was actually processed
BasicUser	getReceiver()	If this payment was received by an operator, returns it.
String	getRelatedName(InternalAccountOwner owner)
Account	getTo()
String	getToName()
User	getToUser()
String	getTransactionNumber()
TransferType	getType()
void	setAccessClient(AccessClient accessClient)
void	setAmount(BigDecimal amount)
void	setBy(BasicUser by)
void	setChannel(Channel channel)
void	setCustomValues(Set<TransactionCustomFieldValue> customValues)
void	setDate(Date date)
void	setDescription(String description)
void	setFrom(Account from)
void	setFromName(String fromName)
void	setPrincipalType(PrincipalType principalType)
void	setTo(Account to)
void	setToName(String toName)
void	setTransactionNumber(String transactionNumber)
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, toShortString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.entities.banking.HasCurrencyAmount

getCurrencyAmount

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.entities.banking.Trans

getActualAmount, getFromOwner, getFromOwnerOrType, getFromType, getFromUser, getRelatedAccount, getRelatedOwner, getToOwner, getToOwnerOrType, getToType, isDebit, isFromSystem, isFromUser, isToSystem, isToUser

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

expirationDate

protected Date expirationDate

The expiration date is used in a few subclasses, but is declared here to make queries easier

showToReceiver

protected Boolean showToReceiver

This represents if a transaction is shown to receiver. Indeed it only belongs to some sub-classes, to know: 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.

authorizationStatus

protected TransactionAuthorizationStatus authorizationStatus

This represents the authorization status of the transaction. Indeed it only belongs to BasePayment and its subclasses, 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 the proper subclass.

authorizationType

protected TransactionAuthorizationType authorizationType

This represents the authorization status type of the transaction. Indeed it only belongs to BasePayment and its subclasses, 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 the proper subclass.

nextAuthorizationLevel

protected AuthorizationLevel nextAuthorizationLevel

This really belongs to BasePayment and its subclasses, but we put it here so we can make (DB) queries simpler.

received

protected Boolean received

This really belongs to BasePayment and its subclasses, but we put it here so we can make (DB) queries simpler.

receivedBy

protected Operator receivedBy

This really belongs to BasePayment and its subclasses, but we put it here so we can make (DB) queries simpler.

Constructor Detail

Transaction

public Transaction()

Method Detail

getAccessClient

public AccessClient getAccessClient()

Specified by:

getAccessClient in interface Trans

getAmount

public BigDecimal getAmount()

Specified by:

getAmount in interface HasAmount

Specified by:

getAmount in interface Trans

getBy

public BasicUser getBy()

getChannel

public Channel getChannel()

Specified by:

getChannel in interface Trans

getCurrency

public Currency getCurrency()

Specified by:

getCurrency in interface HasCurrency

getCustomFieldClass

public 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 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 Set<TransactionCustomFieldValue> getCustomValues()

Description copied from interface: EntityWithCustomValues

Returns all custom field values

Specified by:

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

Specified by:

getCustomValues in interface Trans

getDate

public Date getDate()

Specified by:

getDate in interface Trans

getDescription

public String getDescription()

getFrom

public Account getFrom()

Specified by:

getFrom in interface Trans

getFromName

public String getFromName()

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

getPerformer

public BasicUser getPerformer()

If this payment was performed by an operator, returns it. Otherwise returns the from user, if this payment is from a user

getPrincipalType

public PrincipalType getPrincipalType()

getProcessDate

public abstract Date getProcessDate()

Returns the date the transaction was actually processed

getReceiver

public BasicUser getReceiver()

If this payment was received by an operator, returns it. Otherwise returns the to user, if this payment is to a user

getRelatedName

public String getRelatedName(InternalAccountOwner owner)

getTo

public Account getTo()

Specified by:

getTo in interface Trans

getToName

public String getToName()

getToUser

public User getToUser()

Specified by:

getToUser in interface Trans

getTransactionNumber

public String getTransactionNumber()

Specified by:

getTransactionNumber in interface HasTransactionNumber

getType

public TransferType getType()

Specified by:

getType in interface Trans

setAccessClient

public void setAccessClient(AccessClient accessClient)

setAmount

public void setAmount(BigDecimal amount)

Specified by:

setAmount in interface HasAmount

setBy

public void setBy(BasicUser by)

setChannel

public void setChannel(Channel channel)

setCustomValues

public void setCustomValues(Set<TransactionCustomFieldValue> customValues)

setDate

public void setDate(Date date)

setDescription

public void setDescription(String description)

setFrom

public void setFrom(Account from)

setFromName

public void setFromName(String fromName)

setPrincipalType

public void setPrincipalType(PrincipalType principalType)

setTo

public void setTo(Account to)

setToName

public void setToName(String toName)

setTransactionNumber

public void setTransactionNumber(String transactionNumber)

setType

public void setType(TransferType type)