Package com.storedobject.core

Class AbstractCheckList

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.AbstractCheckList

All Implemented Interfaces:

Displayable, StringFiller, HasChildren, HasId

Direct Known Subclasses:

AbstractCheckListItem, CheckList

public abstract class AbstractCheckList
extends StoredObject
implements HasChildren

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
AbstractCheckList()

Method Summary

Modifier and Type	Method	Description
boolean	checkCompleteness()
static void	columns(Columns columns)
AbstractCheckList	getCheckList()
AbstractCheckList	getCheckList(Transaction transaction)
ComputedDate	getCompleteBefore()
boolean	getCompleted()
Date	getCompletedOn()
String	getName()
ObjectIterator<AbstractCheckListItem>	listItems()
static <T extends AbstractCheckList> void	populate(T checkList, CheckListTemplate template, TransactionManager tm)
static <T extends AbstractCheckList> void	populate(T checkList, CheckListTemplate template, TransactionManager tm, Consumer<T> setValues)
static <T extends AbstractCheckList, IT extends AbstractCheckListItem> void	populate(T checkList, CheckListTemplate template, TransactionManager tm, Consumer<T> setValues, BiConsumer<IT,T> setItemValues)
void	setCompleteBefore(ComputedDate completeBefore)
void	setCompleteBefore(Object value)
void	setCompleted(boolean completed)
void	setCompletedOn(Date completedOn)
void	setName(String name)
String	toString()	String representation of the instance.
void	validate()	The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions).
void	validateChildAttach(StoredObject child, int linkType)	Do validation when a child is attached.
void	validateChildDetach(StoredObject child, int linkType)	Do validation when a child is detached.
void	validateChildUpdate(StoredObject child, int linkType)	Do validation when a child is updated.
void	validateData(TransactionManager tm)	The system will invoke this 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, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, 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, listDeletedIds, 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, loadAttributesFrom, 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, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, 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

AbstractCheckList

public AbstractCheckList()

Method Details

columns

public static void columns(Columns columns)

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

setName

public void setName(String name)

getName

@Column(order=100)
public String getName()

setCompleteBefore

public void setCompleteBefore(ComputedDate completeBefore)

setCompleteBefore

public void setCompleteBefore(Object value)

getCompleteBefore

@Column(order=150)
public ComputedDate getCompleteBefore()

setCompletedOn

public void setCompletedOn(Date completedOn)

getCompletedOn

@Column(order=160)
public Date getCompletedOn()

setCompleted

public void setCompleted(boolean completed)

getCompleted

@Column(order=200)
public boolean getCompleted()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting 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

The system invokes this method internally 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/undeleting 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 the 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-methods 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.

checkCompleteness

public boolean checkCompleteness()

listItems

public ObjectIterator<AbstractCheckListItem> listItems()

validateChildAttach

public void validateChildAttach(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is attached.

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildAttach in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

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

validateChildDetach

public void validateChildDetach(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is detached.

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildDetach in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

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

validateChildUpdate

public void validateChildUpdate(StoredObject child,
 int linkType)

Description copied from class: StoredObject

Do validation when a child is updated. Default implementation of this invokes StoredObject.validateChildAttach(StoredObject, int).

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildUpdate in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

populate

public static <T extends AbstractCheckList> void populate(T checkList,
 CheckListTemplate template,
 TransactionManager tm)
                                                   throws Exception

Throws:

Exception

populate

public static <T extends AbstractCheckList> void populate(T checkList,
 CheckListTemplate template,
 TransactionManager tm,
 Consumer<T> setValues)
                                                   throws Exception

Throws:

Exception

populate

public static <T extends AbstractCheckList,
IT extends AbstractCheckListItem>
void populate(T checkList,
 CheckListTemplate template,
 TransactionManager tm,
 Consumer<T> setValues,
 BiConsumer<IT,T> setItemValues)
       throws Exception

Throws:

Exception

getCheckList

public AbstractCheckList getCheckList()

getCheckList

public AbstractCheckList getCheckList(Transaction transaction)