com.aspc.DBObj.Misc

Class Note

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Misc.Note

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

ChargeItemNote, ContactNote, IndustrialMatterNote, PublicationNote, TaskNote

public class Note
extends DBObject

Note provides a generic note attachments handler.

Notes

TODO: Should we allow users who didn't create a note to be able to change it ?

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

29 October 2001, 09:13

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Note provides a generic note attachments handler
static java.lang.String	DBCLASS_NAME Note provides a generic note attachments handler
static java.lang.String	DBFIELD_OBSOLETE_LINK_NAME
static java.lang.String	PARAMETER_STRIP_TAGS Strip the tags from the HTML

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
Note(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected void	adjustLinkName(java.lang.String className, java.lang.String linkField)
static Note	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams inParams) Additional business logic when a field is updated.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) We prevent some values from being set by a user.
protected void	extValidateRecord(ValidationList list) Text is mandatory if not file.
DBFile	findAttachment(java.lang.String... args) The note attachment.
Person	findEnteredBy(java.lang.String... args) Who created this note.
static Note	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBFile	getAttachment(java.lang.String... args)
java.lang.String	getDisplayHTML(java.lang.String... args)
java.lang.String	getDisplayShortNote(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnteredTime(java.lang.String... args)
double	getFullTextSearchScore(java.lang.String... args)
java.lang.String	getHtmlNote(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getLinkName(java.lang.String... args)
java.lang.String	getPrimaryType(java.lang.String... args)
java.util.List	getProperties(java.lang.String... args)
java.lang.String	getRawLinkName(java.lang.String... args)
java.lang.String	getRawNote(java.lang.String... args)
java.util.List<java.lang.String>	getReferencesUUID(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getUUID(java.lang.String... args)
java.util.List<java.lang.String>	getWeakReferencesUUID(java.lang.String... args)
boolean	isChildNode(java.lang.String... args)
boolean	isContains(java.lang.String... args)
boolean	isDescendantNode(java.lang.String... args)
boolean	isDirectory()
boolean	isPublic(java.lang.String... args)
boolean	isReferenceable(java.lang.String... args)
boolean	isSameNode(java.lang.String... args)
boolean	isVersionable(java.lang.String... args)
long	lastModified()
DBNode[]	listNodes()
static DBQuery<Note>	makeQuery(DataSource ds) Make a new QUERY for this class.
Note	setAttachment(com.aspc.dal.file.DBFile value, java.lang.String... args)
Note	setEnteredBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
Note	setEnteredTime(java.util.Date value, java.lang.String... args)
Note	setHtmlNote(java.lang.String value, java.lang.String... args)
Note	setID(int value, java.lang.String... args)
Note	setPrimaryType(java.lang.String value, java.lang.String... args)
Note	setProperties(java.util.List value, java.lang.String... args)
Note	setRawLinkName(java.lang.String value, java.lang.String... args)
Note	setRawNote(java.lang.String value, java.lang.String... args)
Note	setReferenceable(boolean value, java.lang.String... args)
Note	setReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
Note	setSequence(int value, java.lang.String... args)
void	setUniqueLinkName(java.lang.String className, java.lang.String linkField, java.lang.String preferedName)
Note	setUUID(java.lang.String value, java.lang.String... args)
Note	setVersionable(boolean value, java.lang.String... args)
Note	setWeakReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
java.lang.String	vDisplayName()
java.lang.String	vName()

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, extValidateField, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_STRIP_TAGS

public static final java.lang.String PARAMETER_STRIP_TAGS

Strip the tags from the HTML

See Also:

Constant Field Values

DBFIELD_OBSOLETE_LINK_NAME

public static final java.lang.String DBFIELD_OBSOLETE_LINK_NAME

See Also:

Constant Field Values

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Note provides a generic note attachments handler

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Note provides a generic note attachments handler

Constructor Detail

Note

public Note(DBClass def,
            DataSource dataSource)
     throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public Note setID(int value,
                           java.lang.String... args)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getUUID

@CheckReturnValue
 @Nonnull
public java.lang.String getUUID(java.lang.String... args)

setUUID

@Nonnull
public Note setUUID(java.lang.String value,
                             java.lang.String... args)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getAttachment

@CheckReturnValue
 @Nullable
public DBFile getAttachment(java.lang.String... args)

findAttachment

@CheckReturnValue
 @Nonnull
public final DBFile findAttachment(java.lang.String... args)
                                                        throws NotFoundException

The note attachment. Each file that is attached may have additional comments. If the note text is blank then the file's description will be used.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setAttachment

@Nonnull
public Note setAttachment(com.aspc.dal.file.DBFile value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

isContains

@CheckReturnValue
public boolean isContains(java.lang.String... args)

getDisplayHTML

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayHTML(java.lang.String... args)

getDisplayShortNote

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayShortNote(java.lang.String... args)

getEnteredBy

@CheckReturnValue
 @Nullable
public Person getEnteredBy(java.lang.String... args)

findEnteredBy

@CheckReturnValue
 @Nonnull
public final Person findEnteredBy(java.lang.String... args)
                                                       throws NotFoundException

Who created this note.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setEnteredBy

@Nonnull
public Note setEnteredBy(com.aspc.dal.dbobj.contact.Person value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredTime

@CheckReturnValue
 @Nullable
public java.util.Date getEnteredTime(java.lang.String... args)

setEnteredTime

@Nonnull
public Note setEnteredTime(java.util.Date value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getFullTextSearchScore

@CheckReturnValue
public double getFullTextSearchScore(java.lang.String... args)

getHtmlNote

@CheckReturnValue
 @Nonnull
public java.lang.String getHtmlNote(java.lang.String... args)

setHtmlNote

@Nonnull
public Note setHtmlNote(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isChildNode

@CheckReturnValue
public boolean isChildNode(java.lang.String... args)

isDescendantNode

@CheckReturnValue
public boolean isDescendantNode(java.lang.String... args)

isSameNode

@CheckReturnValue
public boolean isSameNode(java.lang.String... args)

getLinkName

@CheckReturnValue
 @Nonnull
public java.lang.String getLinkName(java.lang.String... args)

getPrimaryType

@CheckReturnValue
 @Nonnull
public java.lang.String getPrimaryType(java.lang.String... args)

setPrimaryType

@Nonnull
public Note setPrimaryType(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getProperties

@CheckReturnValue
 @Nonnull
public java.util.List getProperties(java.lang.String... args)

setProperties

@Nonnull
public Note setProperties(java.util.List value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

isPublic

@CheckReturnValue
public boolean isPublic(java.lang.String... args)

getRawLinkName

@CheckReturnValue
 @Nonnull
public java.lang.String getRawLinkName(java.lang.String... args)

setRawLinkName

@Nonnull
public Note setRawLinkName(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getRawNote

@CheckReturnValue
 @Nonnull
public java.lang.String getRawNote(java.lang.String... args)

setRawNote

@Nonnull
public Note setRawNote(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

isReferenceable

@CheckReturnValue
public boolean isReferenceable(java.lang.String... args)

setReferenceable

@Nonnull
public Note setReferenceable(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getReferencesUUID

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getReferencesUUID(java.lang.String... args)

setReferencesUUID

@Nonnull
public Note setReferencesUUID(java.util.List<java.lang.String> value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

@CheckReturnValue
public int getSequence(java.lang.String... args)

setSequence

@Nonnull
public Note setSequence(int value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isVersionable

@CheckReturnValue
public boolean isVersionable(java.lang.String... args)

setVersionable

@Nonnull
public Note setVersionable(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getWeakReferencesUUID

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getWeakReferencesUUID(java.lang.String... args)

setWeakReferencesUUID

@Nonnull
public Note setWeakReferencesUUID(java.util.List<java.lang.String> value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Note create(@Nonnull
                                                      MutableDataSource mds)
                                               throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Note> makeQuery(@Nonnull
                                                                  DataSource ds)
                                                           throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Note findKey(@Nonnull
                                                       DataSource ds,
                                                       int key)
                                                throws NotFoundException,
                                                       java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

We prevent some values from being set by a user.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Text is mandatory if not file.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list

Throws:

java.lang.Exception - A serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The value

Throws:

java.lang.Exception - A serious problem

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: DBObject

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class DBObject

Parameters:

field - The field

Returns:

the value

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams inParams)
                                                            throws java.lang.Exception

Additional business logic when a field is updated.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

inParams -

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

Throws:

java.lang.Exception - A serious problem

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

adjustLinkName

protected void adjustLinkName(java.lang.String className,
                              java.lang.String linkField)
                       throws java.lang.Exception

Parameters:

className -

linkField -

Throws:

java.lang.Exception - Exception A serious problem

setUniqueLinkName

public void setUniqueLinkName(java.lang.String className,
                              java.lang.String linkField,
                              java.lang.String preferedName)
                       throws java.lang.Exception

Throws:

java.lang.Exception

lastModified

public long lastModified()

isDirectory

public boolean isDirectory()

vName

public java.lang.String vName()

vDisplayName

public java.lang.String vDisplayName()

listNodes

public DBNode[] listNodes()
                   throws java.lang.Exception

Throws:

java.lang.Exception