com.tenduke.objectmodel
Class CreditAccountEntry

java.lang.Object
  com.tenduke.types.AbstractBindableObject
      com.tenduke.objectmodel.TendukeObject
          com.tenduke.objectmodel.CreditAccountEntry

All Implemented Interfaces:

DescriptionObject, RelationObject, SerializableObject, java.lang.Cloneable

public class CreditAccountEntry
extends TendukeObject
implements DescriptionObject

Credit account event. A set of CreditAccountEntry objects represent all events that affect credit account balance. Credit account may be represented by a CreditAccount object, or it can be external.

Nested Class Summary

Nested classes/interfaces inherited from class com.tenduke.objectmodel.TendukeObject

TendukeObject.CreatedDateComparator<T extends TendukeObject>, TendukeObject.ModifiedDateComparator<T extends TendukeObject>

Field Summary

static int	FIELD_LENGTH_DESCRIPTION Constant for maximum length of credit account entry description fields value.
static int	FIELD_LENGTH_PAYER_NAME Constant for maximum length of credit account entry payer name fields value.
static int	FIELD_LENGTH_PAYMENT_METHOD Constant for maximum length of credit account entry payment methods fields value.
static int	FIELD_LENGTH_RECIPIENT_NAME Constant for maximum length of credit account entry recipient name fields value.
static int	FIELD_LENGTH_SUMMARY Constant for maximum length of credit account entry summary fields value.
static java.lang.String	FIELD_NAME_CREDIT_ACCOUNT Constant for name of field that holds credit account based on relation.
static java.lang.String	FIELD_NAME_CREDIT_ACCOUNT_ENTRY_OWNER Constant for name of field that holds entry owner based on relation.
static java.lang.String	FIELD_NAME_CREDIT_ACCOUNT_ID Constant for name of credit account id field.
static java.lang.String	FIELD_NAME_DESCRIPTION Constant for name of credit account entry description field.
static java.lang.String	FIELD_NAME_OWNER_PROFILE_ID Constant for name of credit account entry owner profile id field.
static java.lang.String	FIELD_NAME_PAYER_NAME Constant for name of credit account entry payer name field.
static java.lang.String	FIELD_NAME_PAYMENT_CREDITS Constant for name of credit account entry credit amount method field.
static java.lang.String	FIELD_NAME_PAYMENT_METHOD Constant for name of credit account entry paymemt method field.
static java.lang.String	FIELD_NAME_RECIPIENT_NAME Constant for name of credit account entry recipient name field.
static java.lang.String	FIELD_NAME_SUMMARY Constant for name of credit account entry summary field.

Fields inherited from class com.tenduke.objectmodel.TendukeObject

FIELD_NAME_CREATED, FIELD_NAME_CREATED_BY_PROFILE, FIELD_NAME_MODIFIED, FIELD_NAME_MODIFIED_BY_PROFILE, FIELD_NAME_OBJECT_CATEGORY, FIELD_NAME_OBJECT_CATEGORY_ID, FIELD_NAME_OBJECT_CONSUMPTION, FIELD_NAME_OBJECT_FEATURES, FIELD_NAME_OBJECT_PROPERTIES, RELATED_FIELD_COPY_STYLE_DEEP, RELATED_FIELD_COPY_STYLE_NONE, RELATED_FIELD_COPY_STYLE_SHALLOW

Fields inherited from class com.tenduke.types.AbstractBindableObject

FIELD_LENGTH_SHORT_ID, FIELD_NAME_OBJECT_STATE_CHANGE, FIELD_NAME_REPLACES_OBJECT, FIELD_NAME_SHORT_ID, PERMISSION_ACTION_CREATE, PERMISSION_ACTION_DELETE, PERMISSION_ACTION_MODIFY, PERMISSION_ACTION_READ

Constructor Summary

CreditAccountEntry()
Creates new instance of CreditAccountEntry with null id.

CreditAccountEntry(java.util.UUID creditAccountEntryId)
Creates new instance of CreditAccountEntry with caller defined id.

Method Summary

java.lang.Object	clone() Clones instance of CreditAccountEntry.
protected void	copyThis(CreditAccountEntry result) Copy this instance's field values to argument instance of CreditAccountEntry.
CreditAccount	getCreditAccount() Gets the credit account this entry belongs to.
java.util.UUID	getCreditAccountEntryId() Gets the id of this object.
java.util.UUID	getCreditAccountId() Gets id of credit account this entry belongs to.
java.lang.Double	getCredits() Gets the amount of credits this entry represents.
java.lang.String	getDescription() Gets textual description for this entry.
java.util.UUID	getId() Gets CreditAccountEntry object's id.
Profile	getOwnerProfile() Gets the owner of this credit account entry.
java.util.UUID	getOwnerProfileId() Gets entry owner profile's id.
java.lang.String	getPayerName() Gets payer's name.
java.lang.String	getPaymentMethod() Gets the method of payment that produced this entry.
java.lang.String	getRecipientName() Gets recipient's name.
java.lang.String	getSummary() Gets the textual summary for this entry.
void	setCreditAccount(CreditAccount creditAccount) Sets the credit account this entry belongs to.
void	setCreditAccountEntryId(java.util.UUID creditAccountEntryId) Sets the id of this object.
void	setCreditAccountId(java.util.UUID creditAccountId) Sets id of credit account this entry belongs to.
void	setCredits(java.lang.Double credits) Sets amount of credits this entry represents.
void	setDescription(java.lang.String description) Sets textual description for this entry.
void	setId(java.util.UUID id) Sets CreditAccountEntry object's id.
void	setOwnerProfile(Profile ownerProfile) Sets the owner profile of this credit account entry.
void	setOwnerProfileId(java.util.UUID ownerProfileId) Sets entry owner profile's id.
void	setPayerName(java.lang.String payerName) Sets payer's name.
void	setPaymentMethod(java.lang.String paymentMethod) Sets method of payment that produced this entry.
void	setRecipientName(java.lang.String recipientName) Sets recipient's name.
void	setSummary(java.lang.String summary) Sets textual summary for this entry.

Methods inherited from class com.tenduke.objectmodel.TendukeObject

addFeature, addObjectConsumption, addObjectProperty, addProperty, addRelatedObjectDefault, addRelatedObjectDefault, addRelatedObjectsDefault, addRelatedObjectsDefault, clone, copyThis, copyThis, equals, fieldValueToString, findProperty, findProperty, getChangedSerializableFieldValues, getCreated, getCreatedBy, getCreatedByRecursive, getCreatingActor, getModified, getModifiedBy, getModifiedByRecursive, getModifyingActor, getObjectCategory, getObjectCategoryId, getObjectConsumption, getObjectContractName, getObjectContractName, getObjectFeature, getObjectFeatures, getObjectProperties, getObjectProperty, getObjectPropertyValue, getRelatedObjectsDefault, getRelatedObjectsDefault, hashCode, idFromString, merge, objectFeaturesToMap, objectPropertiesToMap, orderByCreatedDate, orderByModifiedDate, setCreated, setCreatedBy, setCreatedByRecursive, setCreatedByRecursive, setCreatingActor, setModified, setModifiedBy, setModifiedBy, setModifiedByRecursive, setModifiedByRecursive, setModifiedByRecursive, setModifyingActor, setObjectCategory, setObjectCategoryId, setObjectConsumption, setObjectFeatures, setObjectProperties, setRelatedObjectsDefault, setRelatedObjectsDefault, toString

Methods inherited from class com.tenduke.types.AbstractBindableObject

addRelatedObject, addRelatedObject, addRelatedObject, addRelatedObject, addRelatedObjects, addRelatedObjects, addRelatedObjects, copyThis, getFirstObjectById, getGrantedObjectPermissionActions, getParent, getParentBindableType, getParentBindableTypeChain, getParentId, getParentNode, getParentType, getRelatedObjectList, getRelatedObjectList, getRelatedObjectLists, getRelatedObjectLists, getRelatedObjects, getRelatedObjects, getRelatedObjects, getRelatedObjects, getRelatedObjects, getRelatedObjects, getRelationAttributeObject, getRelationField, getRelationHandler, getRelationType, getReplaces, getShortId, getStateChange, hasRelatedObjects, hasRelatedObjects, resolveParentBindableType, resolveParentBindableTypeByTreeParent, setGrantedObjectPermissionActions, setParent, setParent, setParentBindableType, setParentNode, setRelatedObjectList, setRelatedObjects, setRelatedObjects, setRelatedObjects, setRelatedObjects, setRelatedObjects, setRelatedObjects, setRelationAttributeObject, setRelationHandler, setReplaces, setShortId, setStateChange

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_LENGTH_DESCRIPTION

public static final int FIELD_LENGTH_DESCRIPTION

Constant for maximum length of credit account entry description fields value.

See Also:

Constant Field Values

FIELD_LENGTH_PAYER_NAME

public static final int FIELD_LENGTH_PAYER_NAME

Constant for maximum length of credit account entry payer name fields value.

See Also:

Constant Field Values

FIELD_LENGTH_PAYMENT_METHOD

public static final int FIELD_LENGTH_PAYMENT_METHOD

Constant for maximum length of credit account entry payment methods fields value.

See Also:

Constant Field Values

FIELD_LENGTH_RECIPIENT_NAME

public static final int FIELD_LENGTH_RECIPIENT_NAME

Constant for maximum length of credit account entry recipient name fields value.

See Also:

Constant Field Values

FIELD_LENGTH_SUMMARY

public static final int FIELD_LENGTH_SUMMARY

Constant for maximum length of credit account entry summary fields value.

See Also:

Constant Field Values

FIELD_NAME_CREDIT_ACCOUNT

public static final java.lang.String FIELD_NAME_CREDIT_ACCOUNT

Constant for name of field that holds credit account based on relation.

See Also:

Constant Field Values

FIELD_NAME_CREDIT_ACCOUNT_ENTRY_OWNER

public static final java.lang.String FIELD_NAME_CREDIT_ACCOUNT_ENTRY_OWNER

Constant for name of field that holds entry owner based on relation.

See Also:

Constant Field Values

FIELD_NAME_CREDIT_ACCOUNT_ID

public static final java.lang.String FIELD_NAME_CREDIT_ACCOUNT_ID

Constant for name of credit account id field.

See Also:

Constant Field Values

FIELD_NAME_DESCRIPTION

public static final java.lang.String FIELD_NAME_DESCRIPTION

Constant for name of credit account entry description field.

See Also:

Constant Field Values

FIELD_NAME_OWNER_PROFILE_ID

public static final java.lang.String FIELD_NAME_OWNER_PROFILE_ID

Constant for name of credit account entry owner profile id field.

See Also:

Constant Field Values

FIELD_NAME_PAYER_NAME

public static final java.lang.String FIELD_NAME_PAYER_NAME

Constant for name of credit account entry payer name field.

See Also:

Constant Field Values

FIELD_NAME_PAYMENT_CREDITS

public static final java.lang.String FIELD_NAME_PAYMENT_CREDITS

Constant for name of credit account entry credit amount method field.

See Also:

Constant Field Values

FIELD_NAME_PAYMENT_METHOD

public static final java.lang.String FIELD_NAME_PAYMENT_METHOD

Constant for name of credit account entry paymemt method field.

See Also:

Constant Field Values

FIELD_NAME_RECIPIENT_NAME

public static final java.lang.String FIELD_NAME_RECIPIENT_NAME

Constant for name of credit account entry recipient name field.

See Also:

Constant Field Values

FIELD_NAME_SUMMARY

public static final java.lang.String FIELD_NAME_SUMMARY

Constant for name of credit account entry summary field.

See Also:

Constant Field Values

Constructor Detail

CreditAccountEntry

public CreditAccountEntry()

Creates new instance of CreditAccountEntry with null id.

CreditAccountEntry

public CreditAccountEntry(java.util.UUID creditAccountEntryId)

Creates new instance of CreditAccountEntry with caller defined id.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones instance of CreditAccountEntry.

Overrides:

clone in class TendukeObject

Returns:

clones instance of CreditAccountEntry

Throws:

java.lang.CloneNotSupportedException - clone is implemented, exception is not thrown explicitly.

copyThis

protected void copyThis(CreditAccountEntry result)

Copy this instance's field values to argument instance of CreditAccountEntry.

Parameters:

result - The result data to overwrite with this instances members values, null accepted but noting is copied in that case.

getCreditAccount

public CreditAccount getCreditAccount()

Gets the credit account this entry belongs to.

Returns:

the credit account this entry belongs to or null if the relation field does not contain the account object.

getCreditAccountEntryId

public java.util.UUID getCreditAccountEntryId()

Gets the id of this object.

Returns:

the id of this object.

getCreditAccountId

public java.util.UUID getCreditAccountId()

Gets id of credit account this entry belongs to.

Returns:

the id of credit account this entry belongs to.

getCredits

public java.lang.Double getCredits()

Gets the amount of credits this entry represents.

Returns:

amount of credits this entry represents.

getDescription

public java.lang.String getDescription()

Gets textual description for this entry.

Specified by:

getDescription in interface DescriptionObject

Returns:

textual description for this entry.

getId

public java.util.UUID getId()

Gets CreditAccountEntry object's id.

Specified by:

getId in interface SerializableObject

Specified by:

getId in class AbstractBindableObject

Returns:

CreditAccountEntry object's id.

getOwnerProfile

public Profile getOwnerProfile()

Gets the owner of this credit account entry.

Returns:

Owner profile or null if the relation field does not contain the owner profile.

getOwnerProfileId

public java.util.UUID getOwnerProfileId()

Gets entry owner profile's id.

Returns:

entry owner profile's id.

getPayerName

public java.lang.String getPayerName()

Gets payer's name.

Returns:

payer's name.

getPaymentMethod

public java.lang.String getPaymentMethod()

Gets the method of payment that produced this entry.

Returns:

the method of payment that produced this entry.

getRecipientName

public java.lang.String getRecipientName()

Gets recipient's name.

Returns:

recipient's name.

getSummary

public java.lang.String getSummary()

Gets the textual summary for this entry.

Returns:

textual summary for this entry.

setCreditAccount

public void setCreditAccount(CreditAccount creditAccount)

Sets the credit account this entry belongs to.

Parameters:

creditAccount - credit account this entry belongs to.

setCreditAccountEntryId

public void setCreditAccountEntryId(java.util.UUID creditAccountEntryId)

Sets the id of this object.

Parameters:

creditAccountEntryId - id to set for this object.

setCreditAccountId

public void setCreditAccountId(java.util.UUID creditAccountId)

Sets id of credit account this entry belongs to.

Parameters:

creditAccountId - id of credit account this entry belongs to.

setCredits

public void setCredits(java.lang.Double credits)

Sets amount of credits this entry represents.

Parameters:

credits - amount of credits this entry represents.

setDescription

public void setDescription(java.lang.String description)

Sets textual description for this entry.

Specified by:

setDescription in interface DescriptionObject

Parameters:

description - textual description for this entry.

setId

public void setId(java.util.UUID id)

Sets CreditAccountEntry object's id.

Specified by:

setId in interface SerializableObject

Specified by:

setId in class AbstractBindableObject

Parameters:

id - CreditAccountEntry object's id to set.

setOwnerProfile

public void setOwnerProfile(Profile ownerProfile)

Sets the owner profile of this credit account entry.

Parameters:

ownerProfile - Owner profile

setOwnerProfileId

public void setOwnerProfileId(java.util.UUID ownerProfileId)

Sets entry owner profile's id.

Parameters:

ownerProfileId - entry owner profile's id.

setPayerName

public void setPayerName(java.lang.String payerName)

Sets payer's name.

Parameters:

payerName - payer's name.

setPaymentMethod

public void setPaymentMethod(java.lang.String paymentMethod)

Sets method of payment that produced this entry.

Parameters:

paymentMethod - method of payment that produced this entry.

setRecipientName

public void setRecipientName(java.lang.String recipientName)

Sets recipient's name.

Parameters:

recipientName - recipient's name.

setSummary

public void setSummary(java.lang.String summary)

Sets textual summary for this entry.

Parameters:

summary - textual summary for this entry.