com.aspc.Layers.aspc_app.Notices

Class TaskNoticeNote

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Misc.Note

com.aspc.Layers.aspc_app.Misc.TaskNote

com.aspc.Layers.aspc_app.Notices.TaskNoticeNote

All Implemented Interfaces:

SecondaryCacheGroup

public class TaskNoticeNote
extends TaskNote

A note associated with the sending of a notice.

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

Since:

11 October 2004, 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 A note associated with the sending of a notice.
static java.lang.String	DBCLASS_NAME A note associated with the sending of a notice.

Fields inherited from class com.aspc.DBObj.Misc.Note

DBFIELD_OBSOLETE_LINK_NAME, PARAMETER_STRIP_TAGS

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected java.lang.String	extGenerateDescription()
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
DeliverySchedule	findDeliverySchedule(java.lang.String... args) details of the delivery schedule.
DBEmail	findEmail(java.lang.String... args) If the notice was sent from an email then this field will link to that email.
NoticeSchedule	findNoticeSchedule(java.lang.String... args) Notice Schedule.
InvoiceProductItem	findProductItem(java.lang.String... args) Product Item.
DeliverySchedule	getDeliverySchedule(java.lang.String... args)
DBEmail	getEmail(java.lang.String... args)
java.lang.String	getNoticeNumber(java.lang.String... args)
NoticeSchedule	getNoticeSchedule(java.lang.String... args)
InvoiceProductItem	getProductItem(java.lang.String... args)
TaskNoticeNote	setDeliverySchedule(com.aspc.dal.layers.aspc_app.subscription.DeliverySchedule value, java.lang.String... args)
TaskNoticeNote	setEmail(com.aspc.dal.dbobj.email.DBEmail value, java.lang.String... args)
TaskNoticeNote	setNoticeNumber(java.lang.String value, java.lang.String... args)
TaskNoticeNote	setNoticeSchedule(com.aspc.dal.layers.aspc_app.notices.NoticeSchedule value, java.lang.String... args)
TaskNoticeNote	setProductItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceProductItem value, java.lang.String... args)

Methods inherited from class com.aspc.Layers.aspc_app.Misc.TaskNote

extDelete, extFixUp, extGetDerivedValue, extPreSaveRecord, extPreValidate, findTaskId, getJiraCommentId, getTaskId, hasCategory, hasReadAccess, setJiraCommentId, setTaskId

Methods inherited from class com.aspc.DBObj.Misc.Note

adjustLinkName, create, extSetValue, extValidateRecord, findAttachment, findEnteredBy, findKey, getAttachment, getDisplayHTML, getDisplayShortNote, getEnteredBy, getEnteredTime, getFullTextSearchScore, getHtmlNote, getID, getLinkName, getPrimaryType, getProperties, getRawLinkName, getRawNote, getReferencesUUID, getSequence, getUUID, getWeakReferencesUUID, isChildNode, isContains, isDescendantNode, isDirectory, isPublic, isReferenceable, isSameNode, isVersionable, lastModified, listNodes, makeQuery, setAttachment, setEnteredBy, setEnteredTime, setHtmlNote, setID, setPrimaryType, setProperties, setRawLinkName, setRawNote, setReferenceable, setReferencesUUID, setSequence, setUniqueLinkName, setUUID, setVersionable, setWeakReferencesUUID, vDisplayName, 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, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, 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

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

A note associated with the sending of a notice.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A note associated with the sending of a notice.

Constructor Detail

TaskNoticeNote

public TaskNoticeNote(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

getDeliverySchedule

@CheckReturnValue
 @Nullable
public DeliverySchedule getDeliverySchedule(java.lang.String... args)

findDeliverySchedule

@CheckReturnValue
 @Nonnull
public final DeliverySchedule findDeliverySchedule(java.lang.String... args)
                                                                        throws NotFoundException

details of the delivery schedule.

--> DeliverySchedule (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DeliverySchedule

Throws:

NotFoundException - DeliverySchedule was not found

setDeliverySchedule

@Nonnull
public TaskNoticeNote setDeliverySchedule(com.aspc.dal.layers.aspc_app.subscription.DeliverySchedule value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getEmail

@CheckReturnValue
 @Nullable
public DBEmail getEmail(java.lang.String... args)

findEmail

@CheckReturnValue
 @Nonnull
public final DBEmail findEmail(java.lang.String... args)
                                                    throws NotFoundException

If the notice was sent from an email then this field will link to that email.

--> DBEmail (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Email

Throws:

NotFoundException - DBEmail was not found

setEmail

@Nonnull
public TaskNoticeNote setEmail(com.aspc.dal.dbobj.email.DBEmail value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getNoticeNumber

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

setNoticeNumber

@Nonnull
public TaskNoticeNote setNoticeNumber(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getNoticeSchedule

@CheckReturnValue
 @Nullable
public NoticeSchedule getNoticeSchedule(java.lang.String... args)

findNoticeSchedule

@CheckReturnValue
 @Nonnull
public final NoticeSchedule findNoticeSchedule(java.lang.String... args)
                                                                    throws NotFoundException

Notice Schedule.

--> NoticeSchedule (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

NoticeSchedule

Throws:

NotFoundException - NoticeSchedule was not found

setNoticeSchedule

@Nonnull
public TaskNoticeNote setNoticeSchedule(com.aspc.dal.layers.aspc_app.notices.NoticeSchedule value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getProductItem

@CheckReturnValue
 @Nullable
public InvoiceProductItem getProductItem(java.lang.String... args)

findProductItem

@CheckReturnValue
 @Nonnull
public final InvoiceProductItem findProductItem(java.lang.String... args)
                                                                     throws NotFoundException

Product Item.

--> InvoiceProductItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceProductItem

Throws:

NotFoundException - InvoiceProductItem was not found

setProductItem

@Nonnull
public TaskNoticeNote setProductItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceProductItem value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

eventFieldUpdated

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

update dependent fields.

Overrides:

eventFieldUpdated in class TaskNote

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

See Also:

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

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 Note

Parameters:

field - The field

Returns:

boolean if the field is changed

extGenerateDescription

protected java.lang.String extGenerateDescription()

Returns:

String generated description