Package com.storedobject.core

Class Document<T extends StoredObject>

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.FileData

com.storedobject.core.Document<T>

All Implemented Interfaces:

Displayable, StringFiller, ContentType, Detail, HasId, HasParents

Direct Known Subclasses:

AccountDocument, BusinessDocument, PersonalDocument

public abstract class Document<T extends StoredObject>
extends FileData

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Document()

Method Summary

Modifier and Type	Method	Description
protected boolean	allowAny()
static void	columns(Columns columns)
Date	getExpiry()
Date	getIssuedOn()
String	getNo()
T	getOwner()
protected abstract Class<T>	getOwnerClass()
final Id	getOwnerId()
DocumentType	getType()
Id	getTypeId()
static void	indices(Indices indices)
void	setExpiry(Date expiry)
void	setIssuedOn(Date issuedOn)
void	setNo(String no)
final void	setOwner(Id ownerId)
final void	setOwner(BigDecimal idValue)
final void	setOwner(T owner)
void	setType(DocumentType type)
void	setType(Id typeId)
void	setType(BigDecimal idValue)
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.FileData

circulate, create, get, getCirculation, getCirculation, getContentType, getDetails, getExpiryDate, getFile, getFileExtension, getFileId, getFolder, getName, getPreviousVersion, getReadBefore, getReadBeforeTime, getReadStamp, getRootFolder, isAudio, isDetailOf, isEmpty, isImage, isLink, isPDF, isVideo, linkTo, linkTo, replaceWith, restore, saveInFolder, setFile, setFile, setFile, setName, toString, unlinkFrom, validate, validateParentDetach, validName, view

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, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, 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.ContentType

getLink, getMimeType, isHTML, isMedia, isText

Methods inherited from interface com.storedobject.core.Detail

copyValuesFrom, getId, getUniqueId, getUniqueValue

Constructor Details

Document

public Document()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

setType

public void setType(Id typeId)

setType

public void setType(BigDecimal idValue)

setType

public void setType(DocumentType type)

getTypeId

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

getType

public DocumentType getType()

setNo

public void setNo(String no)

getNo

@Column(order=600)
public String getNo()

setIssuedOn

public void setIssuedOn(Date issuedOn)

getIssuedOn

@Column(caption="Created/Issued on",
        order=700)
public Date getIssuedOn()

setExpiry

public void setExpiry(Date expiry)

getExpiry

@Column(order=800)
public Date getExpiry()

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 FileData

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getOwner

public T getOwner()

getOwnerId

public final Id getOwnerId()

setOwner

public final void setOwner(BigDecimal idValue)

setOwner

public final void setOwner(T owner)

setOwner

public final void setOwner(Id ownerId)

getOwnerClass

protected abstract Class<T> getOwnerClass()

allowAny

protected boolean allowAny()