Package com.storedobject.core

Class Memo

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Memo

All Implemented Interfaces:

Displayable, StringFiller, HasId, OfEntity

Direct Known Subclasses:

Issue

public class Memo
extends StoredObject
implements OfEntity

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Memo()

Method Summary

Modifier and Type	Method	Description
protected void	approved()	This method is invoked when the memo is finally approved.
static String[]	browseColumns()
boolean	canEscalate(SystemUser su)
boolean	canReopen(SystemUser su)
boolean	canReturnToInitiator(MemoComment latestComment)
static void	columns(Columns columns)
protected SystemUser	escalating()	This method is invoked when a memo is escalated to another level.
int	getApprovalsRequired()	Typically, number of approvals required is determined by the number returned by the MemoType.getApprovalCount() method.
final String	getContent()
final Date	getDate()
MemoComment	getInitialComment()
SystemUser	getInitiatedBy()
final Id	getInitiatedById()
final int	getLastComment()
SystemUser	getLastCommentBy()
MemoComment	getLatestComment()
protected String	getMemoStatus()
final int	getNo()
final String	getPendingWith()
final String	getReference()
final int	getStatus()
String	getStatusValue()
static String	getStatusValue(int value)
static String[]	getStatusValues()
String	getSubject()
final SystemEntity	getSystemEntity()
final Id	getSystemEntityId()
final MemoType	getType()
Id	getTypeId()
final boolean	isLatestComment(MemoComment memoComment)
boolean	isMine(SystemUser su)
List<SystemUser>	listApprovers()
final Set<SystemUser>	listApprovers(SystemEntity forEntity)
List<SystemUser>	listCommenters()
final Set<SystemUser>	listCommenters(SystemEntity forEntity)
static String[]	protectedColumns()
protected void	rejected()	This method is invoked if the memo is rejected.
String	renameAction(String action)
String	renameActionVerb(String action)
String	renameCommentAction(String action)
protected void	reopening()	This is invoked just before the memo is reopened.
protected void	returning(MemoComment comment)	This is invoked just before the memo is returned.
Id	save(Transaction transaction, String content, SystemUser enteredFor)
void	setDate(Date date)
final void	setLastComment(int lastComment)
void	setNo(int no)
final void	setStatus(int status)
void	setSubject(String subject)
final void	setSystemEntity(Id systemEntityId)
final void	setSystemEntity(SystemEntity systemEntity)
final void	setSystemEntity(BigDecimal idValue)
final void	setType(Id typeId)
final void	setType(MemoType type)
final void	setType(BigDecimal idValue)
String	toDisplay()	Display representation of the instance used for human-friendly display.
void	updateSubject(Transaction transaction, String subject)
void	validate()	This method is invoked internally by the system whenever the object gets saved to the DB (that means, while doing transactions).
void	validateData(TransactionManager tm)	This will be invoked by the system whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.
String	whyNoTakers()

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildAttach, validateChildDetach, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId

Constructor Details

Memo

public Memo()

Method Details

columns

public static void columns(Columns columns)

browseColumns

public static String[] browseColumns()

protectedColumns

public static String[] protectedColumns()

setSystemEntity

public final void setSystemEntity(Id systemEntityId)

Specified by:

setSystemEntity in interface OfEntity

setSystemEntity

public final void setSystemEntity(BigDecimal idValue)

setSystemEntity

public final void setSystemEntity(SystemEntity systemEntity)

getSystemEntityId

@SetNotAllowed
@Column(order=10,
        caption="Of")
public final Id getSystemEntityId()

Specified by:

getSystemEntityId in interface OfEntity

getSystemEntity

public final SystemEntity getSystemEntity()

Specified by:

getSystemEntity in interface OfEntity

setType

public final void setType(Id typeId)

setType

public final void setType(BigDecimal idValue)

setType

public final void setType(MemoType type)

getTypeId

@SetNotAllowed
@Column(order=100)
public Id getTypeId()

getType

public final MemoType getType()

setNo

public void setNo(int no)

getNo

@SetNotAllowed
@Column(style="(serial)",
        order=200)
public final int getNo()

setDate

public void setDate(Date date)

getDate

@SetNotAllowed
@Column(order=300)
public final Date getDate()

setSubject

public void setSubject(String subject)

getSubject

@Column(order=500,
        caption="Subject / Short Description")
public String getSubject()

setStatus

public final void setStatus(int status)

getStatus

@SetNotAllowed
@Column(order=400)
public final int getStatus()

getStatusValues

public static String[] getStatusValues()

getStatusValue

public static String getStatusValue(int value)

getStatusValue

public String getStatusValue()

getMemoStatus

protected String getMemoStatus()

renameAction

public String renameAction(String action)

renameCommentAction

public String renameCommentAction(String action)

renameActionVerb

public String renameActionVerb(String action)

setLastComment

public final void setLastComment(int lastComment)

getLastComment

@SetNotAllowed
@Column(order=600)
public final int getLastComment()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getPendingWith

public final String getPendingWith()

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method the current transaction can be abandoned.

validate

public void validate()
              throws Exception

Description copied from class: StoredObject

This method is invoked internally by the system whenever the object gets saved to the DB (that means, while doing transactions). It will be invoked in all cases (while creating new objects and updating/deleting/un-deleting existing objects). If this method raises any exceptions, the process of saving to the DB will be abandoned.

This method is not usually used for validating data (For that purpose, StoredObject.validateData(TransactionManager) is recommended). It is mainly used for validating state of the object. Methods such as StoredObject.created(), StoredObject.updated(), StoredObject.deleted(), StoredObject.undeleted() etc. are used to check the specific states but overridden methods may check for other "application-specific"/"business-specific" states.

This method is invoked only after one of the other operation-specific validate method is invoked depending on the save operation - StoredObject.validateInsert(), StoredObject.validateUpdate(), StoredObject.validateDelete(), StoredObject.validateUndelete().

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Overrides:

validate in class StoredObject

Throws:

Exception - By raising an exception from this method the current transaction can be abandoned.

getLatestComment

public MemoComment getLatestComment()

save

public Id save(Transaction transaction,
 String content,
 SystemUser enteredFor)
        throws Exception

Throws:

Exception

updateSubject

public void updateSubject(Transaction transaction,
 String subject)
                   throws Exception

Throws:

Exception

isLatestComment

public final boolean isLatestComment(MemoComment memoComment)

getReference

public final String getReference()

getApprovalsRequired

public int getApprovalsRequired()

Typically, number of approvals required is determined by the number returned by the MemoType.getApprovalCount() method. However, this method can be overridden and can return some other values based on some other conditions.

Returns:

A positive number.

toDisplay

public String toDisplay()

Description copied from class: StoredObject

Display representation of the instance used for human-friendly display.

Specified by:

toDisplay in interface Displayable

Overrides:

toDisplay in class StoredObject

Returns:

Display representation of the instance.

approved

protected void approved()

This method is invoked when the memo is finally approved. You may set any extra attributes in your memo at this point because it will be saved after this call. If you want to carry out any other transactions in some related object, you may use the StoredObject.getTransaction() of this.

rejected

protected void rejected()

This method is invoked if the memo is rejected. You may set any extra attributes in your memo at this point because it will be saved after this call. If you want to carry out any other transactions in some related object, you may use the StoredObject.getTransaction() of this.

escalating

protected SystemUser escalating()

This method is invoked when a memo is escalated to another level. This should return a system user at next level.

Note: This is not used by the basic memo system because there is no concept of "escalation" in memo system. However, it could be implemented in a derived class.

Returns:

A system user at the next level.

reopening

protected void reopening()

This is invoked just before the memo is reopened. You may set/change attributes of the memo at this stage. The memo will be saved after this call.

Note: This is not used by the basic memo system because there is no concept of reopening a memo. However, it could be implemented in derived classes.

returning

protected void returning(MemoComment comment)

This is invoked just before the memo is returned. You may set/change attributes of the memo at this stage. The memo will be saved after this call.

Parameters:

comment - Comment entry for the receiver of the memo.

getContent

public final String getContent()

getInitialComment

public MemoComment getInitialComment()

getInitiatedById

public final Id getInitiatedById()

getInitiatedBy

public SystemUser getInitiatedBy()

getLastCommentBy

public SystemUser getLastCommentBy()

isMine

public boolean isMine(SystemUser su)

listApprovers

public List<SystemUser> listApprovers()

listCommenters

public List<SystemUser> listCommenters()

listCommenters

public final Set<SystemUser> listCommenters(SystemEntity forEntity)

listApprovers

public final Set<SystemUser> listApprovers(SystemEntity forEntity)

canReturnToInitiator

public boolean canReturnToInitiator(MemoComment latestComment)

canReopen

public boolean canReopen(SystemUser su)

canEscalate

public boolean canEscalate(SystemUser su)

whyNoTakers

public String whyNoTakers()