Package com.storedobject.core

Class MemoComment

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.MemoComment

All Implemented Interfaces:

Displayable, StringFiller, HasId

public final class MemoComment
extends StoredObject

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
MemoComment()

Method Summary

Modifier and Type	Method	Description
void	approveMemo(Transaction transaction, String approvalText)
void	approveMemo(Transaction transaction, String approvalText, SystemUser forwardTo)
void	assignAssistant(Transaction transaction, SystemUser assistant)
static String[]	browseColumns()
boolean	canApprove(SystemUser su)
boolean	canClose(SystemUser su)
boolean	canComment(SystemUser su)
boolean	canEdit(SystemUser su)
boolean	canEditSubject(SystemUser su)
boolean	canEscalate(SystemUser su)
boolean	canForward(SystemUser su)
boolean	canRecall(SystemUser su)
boolean	canReopen(SystemUser su)
boolean	canReturn(SystemUser su)
boolean	canReturnToInitiator(SystemUser su)
void	closeMemo(Transaction transaction)
static void	columns(Columns columns)
void	commentMemo(Transaction transaction, String comment)
void	escalateMemo(Transaction transaction, String reason)
void	forwardMemo(Transaction transaction, String comment, SystemUser to)
String	getComment()
int	getCommentCount()
Timestamp	getCommentedAt()
SystemUser	getCommentedBy()
Id	getCommentedById()
String	getContent()
SystemUser	getEnteredBy()
Id	getEnteredById()
MemoComment	getFirst()
MemoComment	getLatest()
Memo	getMemo()
Id	getMemoId()
String	getMemoStatus()
MemoComment	getNext()
String	getPendingWith()
String	getReference()
int	getStatus()
String	getStatusValue()
static String	getStatusValue(int value)
static String[]	getStatusValues()
static void	indices(Indices indices)
boolean	isLatest()
boolean	isMine(SystemUser su)
boolean	isMyMemo(SystemUser su)
static String[]	links()
static String[]	protectedColumns()
void	recallMemo(Transaction transaction)
void	rejectMemo(Transaction transaction, String reason)
void	reopenMemo(Transaction transaction, String reason)
void	returnMemo(Transaction transaction, String reason)
void	returnMemoToInitiator(Transaction transaction, String reason)
void	setComment(String comment)
void	setCommentCount(int commentCount)
void	setCommentedAt(Timestamp commentedAt)
void	setCommentedBy(Id commentedById)
void	setCommentedBy(SystemUser commentedBy)
void	setCommentedBy(BigDecimal idValue)
void	setEnteredBy(Id enteredById)
void	setEnteredBy(SystemUser enteredBy)
void	setEnteredBy(BigDecimal idValue)
void	setMemo(Id memoId)
void	setMemo(Memo memo)
void	setMemo(BigDecimal idValue)
void	setStatus(int status)
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.

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, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

MemoComment

public MemoComment()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

browseColumns

public static String[] browseColumns()

protectedColumns

public static String[] protectedColumns()

links

public static String[] links()

setMemo

public void setMemo(Id memoId)

setMemo

public void setMemo(BigDecimal idValue)

setMemo

public void setMemo(Memo memo)

getMemoId

@Column(order=100,
        style="(any)")
public Id getMemoId()

getMemo

public Memo getMemo()

setCommentCount

public void setCommentCount(int commentCount)

getCommentCount

@Column(order=200)
public int getCommentCount()

setCommentedAt

public void setCommentedAt(Timestamp commentedAt)

getCommentedAt

@Column(order=400)
public Timestamp getCommentedAt()

setCommentedBy

public void setCommentedBy(Id commentedById)

setCommentedBy

public void setCommentedBy(BigDecimal idValue)

setCommentedBy

public void setCommentedBy(SystemUser commentedBy)

getCommentedById

@Column(order=500)
public Id getCommentedById()

getCommentedBy

public SystemUser getCommentedBy()

setEnteredBy

public void setEnteredBy(Id enteredById)

setEnteredBy

public void setEnteredBy(BigDecimal idValue)

setEnteredBy

public void setEnteredBy(SystemUser enteredBy)

getEnteredById

@Column(order=600)
public Id getEnteredById()

getEnteredBy

public SystemUser getEnteredBy()

setStatus

public void setStatus(int status)

getStatus

@Column(order=700)
public int getStatus()

getStatusValues

public static String[] getStatusValues()

getStatusValue

public static String getStatusValue(int value)

getStatusValue

public String getStatusValue()

setComment

public void setComment(String comment)

getComment

@Column(style="(large)",
        order=100000)
public String getComment()

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.

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.

getPendingWith

public String getPendingWith()

isLatest

public boolean isLatest()

assignAssistant

public void assignAssistant(Transaction transaction,
 SystemUser assistant)
                     throws Exception

Throws:

Exception

recallMemo

public void recallMemo(Transaction transaction)
                throws Exception

Throws:

Exception

returnMemoToInitiator

public void returnMemoToInitiator(Transaction transaction,
 String reason)
                           throws Exception

Throws:

Exception

returnMemo

public void returnMemo(Transaction transaction,
 String reason)
                throws Exception

Throws:

Exception

forwardMemo

public void forwardMemo(Transaction transaction,
 String comment,
 SystemUser to)
                 throws Exception

Throws:

Exception

reopenMemo

public void reopenMemo(Transaction transaction,
 String reason)
                throws Exception

Throws:

Exception

escalateMemo

public void escalateMemo(Transaction transaction,
 String reason)
                  throws Exception

Throws:

Exception

approveMemo

public void approveMemo(Transaction transaction,
 String approvalText)
                 throws Exception

Throws:

Exception

approveMemo

public void approveMemo(Transaction transaction,
 String approvalText,
 SystemUser forwardTo)
                 throws Exception

Throws:

Exception

rejectMemo

public void rejectMemo(Transaction transaction,
 String reason)
                throws Exception

Throws:

Exception

commentMemo

public void commentMemo(Transaction transaction,
 String comment)
                 throws Exception

Throws:

Exception

closeMemo

public void closeMemo(Transaction transaction)
               throws Exception

Throws:

Exception

getNext

public MemoComment getNext()

getFirst

public MemoComment getFirst()

getLatest

public MemoComment getLatest()

getReference

public String getReference()

getMemoStatus

public String getMemoStatus()

getContent

public String getContent()

canEdit

public boolean canEdit(SystemUser su)

canEditSubject

public boolean canEditSubject(SystemUser su)

canClose

public boolean canClose(SystemUser su)

canApprove

public boolean canApprove(SystemUser su)

canForward

public boolean canForward(SystemUser su)

canReturn

public boolean canReturn(SystemUser su)

canReturnToInitiator

public boolean canReturnToInitiator(SystemUser su)

canRecall

public boolean canRecall(SystemUser su)

canComment

public boolean canComment(SystemUser su)

canReopen

public boolean canReopen(SystemUser su)

canEscalate

public boolean canEscalate(SystemUser su)

isMine

public boolean isMine(SystemUser su)

isMyMemo

public boolean isMyMemo(SystemUser su)