com.aspc.Layers.aspc_app.Task

Class SalesCycle

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.Task

com.aspc.Layers.aspc_app.Task.ChargeableTask

com.aspc.Layers.aspc_app.Task.SalesCycle

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

SalesCycle

public class SalesCycle
extends ChargeableTask

Task is a Sales Opportunities record potential sales including details of estimated sales value, enquiry source and products and labour charges to be provided in the case of a sale.

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

Since:

October 18, 2001, 9:41 AM

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 Sales Opportunities record potential sales including details of estimated sales value, enquiry source and products and labour charges to be provided in the case of a sale.
static java.lang.String	DBCLASS_NAME Sales Opportunities record potential sales including details of estimated sales value, enquiry source and products and labour charges to be provided in the case of a sale.

Fields inherited from class com.aspc.Layers.aspc_app.Task.Task

skipAlert, STATUS_ACCEPTED, STATUS_COMPLETED, STATUS_DOLATER, STATUS_ENTERED, STATUS_REJECTED, STATUS_STARTED

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DBObject	createQuote(MutableDataSource mds)
Sale	createSale(MutableDataSource mds)
java.lang.String	displayName() The display name
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckDeleteAccess() Additional access checking for DELETE access for this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected void	extCheckReadAccess() Additional access checking for READ access of this object.
protected void	extFixUp() The extended fix up routine for known problems.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extPreSaveRecord() Over ridden method
protected void	extPreValidate() Update the in-memory universe BEFORE validating
InquirySource	findInquirySource(java.lang.String... args) Select Enquiry Source from pick list.
Invoice	findOriginalSubscriptionInvoice(java.lang.String... args) Invoice that this opportunity was generated from.
Quote	findQuote()
java.lang.Object	findRejectedReason(java.lang.String... args) Reason for rejection.
Invoice	findRenewal()
Sale	findSale()
TaskType	findSaleType(java.lang.String... args) Sale Type.
Invoice	generateRenewal(MutableDataSource mds) Generates a renewal invoice based on the chargeitems The process creates a new subscription item if there is not already one and makes sure that all charges are under this The generateInvoice is then called to convert to invoice TODO - tidy this process up so that we don't have to generate a subscription item which we delete again
java.lang.String	getAllDayEvent(java.lang.String... args)
double	getCalcEstSaleAmt(java.lang.String... args)
double	getCostOfSale(java.lang.String... args)
java.util.Date	getEstCloseDate(java.lang.String... args)
java.lang.String	getEstCloseMonthYear(java.lang.String... args)
int	getEstSaleAmt(java.lang.String... args)
java.lang.String	getHtmlProductList(java.lang.String... args)
InquirySource	getInquirySource(java.lang.String... args)
Invoice	getOriginalSubscriptionInvoice(java.lang.String... args)
double	getPotentialSaleAmt(java.lang.String... args)
java.lang.String	getPrivate(java.lang.String... args)
java.util.Date	getPublishedTS(java.lang.String... args)
java.lang.Object	getRejectedReason(java.lang.String... args)
java.lang.String	getReturnDateMonthYear(java.lang.String... args)
TaskType	getSaleType(java.lang.String... args)
java.lang.String	getUnsuccessfulNote(java.lang.String... args)
java.lang.String	getUnsuccessfulSubject(java.lang.String... args)
boolean	isClosesIn(java.lang.String... args)
boolean	isNeglected(java.lang.String... args)
protected java.lang.String	makeRawTags()
protected java.lang.String	makeSearchText()
SalesCycle	setEstCloseDate(java.util.Date value, java.lang.String... args)
SalesCycle	setEstSaleAmt(int value, java.lang.String... args)
SalesCycle	setInquirySource(com.aspc.dal.dbobj.misc.InquirySource value, java.lang.String... args)
SalesCycle	setOriginalSubscriptionInvoice(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
SalesCycle	setPublishedTS(java.util.Date value, java.lang.String... args)
SalesCycle	setRejectedReason(java.lang.Object value, java.lang.String... args)
SalesCycle	setSaleType(com.aspc.dal.layers.aspc_app.misc.TaskType value, java.lang.String... args)
SalesCycle	setUnsuccessfulNote(java.lang.String value, java.lang.String... args)
SalesCycle	setUnsuccessfulSubject(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.Layers.aspc_app.Task.ChargeableTask

copyChildren, extCopy, extPostSaveRecord, findAccountManager, findBillTo, findCalcSaleType, findCampaign, findChargeTaxCode, findContact, findCopyFromTemplate, findDefaultLabourRate, findLastCompleteActivity, findLastModifiedActivity, findNextScheduledActivity, findPaymentTerms, findRecipient, findSite, findSiteRegion, findState, findSuburb, getAccountManager, getActivities, getAdjTotalPrice, getBillTo, getCalcAttn, getCalcBillTo, getCalcSaleType, getCampaign, getChargeTaxCode, getChargeTaxRate, getContact, getContactDisplaySiteAddress, getCopyFromTemplate, getCreditSurchargePerc, getCustomerInvoice, getCustomerInvoiceDate, getCustomerPO, getDefaultLabourRate, getDefaultSiteContact, getDeliveryFee, getDiscountRate, getDisplayContact, getDisplaySiteAddress, getDisplaySiteCountry, getDisplaySitePhone, getDisplaySitePostCode, getDisplaySiteState, getDisplaySiteSuburbCity, getJobItems, getLastActionTime, getLastCompleteActivity, getLastModifiedActivity, getLastNoticeNumber, getNextScheduledActivity, getOrderConfirmationNum, getPaymentTerms, getProfit, getProfitPerc, getRecipient, getRecipientName, getReminderComment, getSite, getSiteAddress, getSiteContactMobile, getSiteContactPerson, getSiteContactPhone, getSiteCoordinate, getSiteCountry, getSiteFax, getSiteName, getSiteNotes, getSitePhone, getSitePostcode, getSiteRegion, getSiteState, getSiteSuburbCity, getState, getStatusJournal, getSuburb, getTotalDiscount, getTotalRoyalties, setAccountManager, setAdjTotalPrice, setBillTo, setCampaign, setChargeTaxCode, setChargeTaxRate, setContact, setCopyFromTemplate, setCreditSurchargePerc, setCustomerInvoice, setCustomerInvoiceDate, setCustomerPO, setDefaultLabourRate, setDeliveryFee, setDiscountRate, setOrderConfirmationNum, setPaymentTerms, setRecipient, setReminderComment, setSite, setSiteAddress, setSiteContactMobile, setSiteContactPerson, setSiteContactPhone, setSiteCoordinate, setSiteCountry, setSiteFax, setSiteName, setSiteNotes, setSitePhone, setSitePostcode, setSiteRegion, setSiteState, setSiteSuburbCity, setState, setSuburb, updateProspectCategory

Methods inherited from class com.aspc.Layers.aspc_app.Task.Task

cleanupCurrentNote, copyIncludeField, createFromType, extPreValidateDelete, extSetValue, extValidateField, findAssignTo, findAssignToGroup, findAttachedEmail, findCalcCustomer, findCategory, findCurrentNote, findCurrentNoteRaw, findDependsOn, findEnteredBy, findInitialAssignTo, findInitialNotNullAssignTo, findKey, findLastModifiedBy, findOwner, findOwnerBusUnit, findPredecessorsStatus, findPriority, findRepeatBase, findRepeatNext, findRepeatPrevious, findRequestedBy, findResult, findSchedAmPm, findSeriesPrevious, findSimpleStatus, findStatus, findStatusLastChangedBy, findTemplateType, findType, getActionByDate, getActualDuration, getActualEnd, getActualEndMonth, getActualStart, getAdditionalCharge, getAdditionalCosts, getAdditionalDetails, getAdjActualDuration, getAdjustedCost, getAssignTo, getAssignToDate, getAssignToGroup, getAttachedEmail, getCalcActualDuration, getCalcCustomer, getCalcTotalDuration, getCategory, getCurrentNote, getCurrentNoteRaw, getDependsOn, getDescription, getDisplayBusyTime, getDisplayId, getDisplaySchedTime, getDisplayShortDesc, getDisplayStatus, getDueBy, getDuration, getEndDate, getEnteredBy, getEnterTime, getEnterTimeMonthYear, getEstVSActualHours, getExpectedFinishMonthYear, getFullTextSearchScore, getHtmlDescription, getICalEnd, getICalFullAddress, getICalOrganizer, getICalStart, getID, getInitialAssignTo, getInitialAssignToDate, getInitialNotNullAssignTo, getInitialNotNullAssignToDate, getIssueDate, getLastModifiedBy, getLastModifiedTime, getLinkedJobs, getNextAlert, getNextOverdueAlert, getObseleteNotes, getOwner, getOwnerBusUnit, getPercUntilClosed, getPreAlertDuration, getPredecessorsStatus, getPrimaryType, getPriority, getProperties, getRawSearchText, getReferenceNumber, getReferencesUUID, getRepeatBase, getRepeatedTimezone, getRepeatNext, getRepeatPrevious, getRequestedBy, getResult, getSchedAmPm, getSequence, getSeriesPrevious, getShortDesc, getSimpleStatus, getStartDate, getStatus, getStatusLastChanged, getStatusLastChangedBy, getStatusLastChangedTurnaround, getTags, getTagsLabel, getTagsRaw, getTaskCoverphoto, getTaskfeedBackBad, getTaskfeedBackGood, getTaskfeedbacknotes, getTaskRating, getTaskSeries, getTemplateType, getTimemapDurationField, getTimemapEndTime, getTimemapEndTimeField, getTimemapStartTime, getTimemapStartTimeField, getTmpAttachmentKey, getTotalCost, getTotalLabourCosts, getTotalLabourPrice, getTotalLabourPriceExcTax, getTotalPriceExcTax, getTotalPriceIncTax, getTotalProductCosts, getTotalProductPrice, getTotalProductPriceExcTax, getTotalProfit, getTotalProfitPerc, getTotalRelatedCosts, getTotalTax, getType, getUntouchedTaskSeries, getUUID, getValueForPublic, getWeakReferencesUUID, handleEvent, hasReadAccess, isAllPredecessorsClosed, isApplicableTo, isCategoryRequired, isChangedByUser, isCheckPredecessorsClosed, isChildNode, isClosed, isContains, isCurrent, isDescendantNode, isDirectory, isDueByExpiresIn, isLockedAssignTo, isLockedStartDate, isMatchesSkillLevel, isMyGroup, isNextAlertDueIn, isNoteRequired, isPublic, isReferenceable, isRepeated, isSameNode, isSendAlert, isTimemapHasEndTime, isVersionable, lastModified, listNodes, makeQuery, makeSearchPlan, processRawTags, setActualEnd, setActualStart, setAdditionalCharge, setAdditionalCosts, setAdditionalDetails, setAdjActualDuration, setAdjustedCost, setAllPredecessorsClosed, setAssignTo, setAssignToDate, setAssignToGroup, setAttachedEmail, setCategory, setCategoryRequired, setChangedByUser, setCurrentNoteRaw, setDependsOn, setDescription, setDueBy, setDuration, setEndDate, setEnteredBy, setEnterTime, setID, setInitialAssignTo, setInitialAssignToDate, setIssueDate, setLastModifiedBy, setLastModifiedTime, setLockedAssignTo, setLockedStartDate, setNextAlert, setNextOverdueAlert, setObseleteNotes, setOwner, setOwnerBusUnit, setPercUntilClosed, setPreAlertDuration, setPredecessorsStatus, setPrimaryType, setPriority, setProperties, setRawSearchText, setReferenceable, setReferenceNumber, setReferencesUUID, setRepeatBase, setRepeated, setRepeatedTimezone, setRepeatNext, setRepeatPrevious, setRequestedBy, setResult, setSchedAmPm, setSendAlert, setSequence, setSeriesPrevious, setShortDesc, setSimpleStatus, setStartDate, setStatus, setStatusLastChanged, setStatusLastChangedBy, setTags, setTagsRaw, setTaskCoverphoto, setTaskfeedBackBad, setTaskfeedBackGood, setTaskfeedbacknotes, setTaskRating, setTemplateType, setTmpAttachmentKey, setType, setUUID, setVersionable, setWeakReferencesUUID, toString, updateStatus, 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, copyInwardLinks, delete, denormalizedResult, displayLogName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckModifyAccess, extDelete, extDeleteRecord, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, extValidateRecord, 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, 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, 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

Sales Opportunities record potential sales including details of estimated sales value, enquiry source and products and labour charges to be provided in the case of a sale.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Sales Opportunities record potential sales including details of estimated sales value, enquiry source and products and labour charges to be provided in the case of a sale.

Constructor Detail

SalesCycle

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

getAllDayEvent

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

getCalcEstSaleAmt

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

isClosesIn

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

getCostOfSale

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

getEstCloseDate

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

setEstCloseDate

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

Throws:

java.lang.Exception

getEstCloseMonthYear

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

getEstSaleAmt

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

setEstSaleAmt

@Nonnull
public SalesCycle setEstSaleAmt(int value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlProductList

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

getInquirySource

@CheckReturnValue
 @Nullable
public InquirySource getInquirySource(java.lang.String... args)

findInquirySource

@CheckReturnValue
 @Nonnull
public final InquirySource findInquirySource(java.lang.String... args)
                                                                  throws NotFoundException

Select Enquiry Source from pick list.

--> InquirySource (String, Searchable)

Parameters:

args - the optional arguments

Returns:

EnquirySource

Throws:

NotFoundException - InquirySource was not found

setInquirySource

@Nonnull
public SalesCycle setInquirySource(com.aspc.dal.dbobj.misc.InquirySource value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isNeglected

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

getOriginalSubscriptionInvoice

@CheckReturnValue
 @Nullable
public Invoice getOriginalSubscriptionInvoice(java.lang.String... args)

findOriginalSubscriptionInvoice

@CheckReturnValue
 @Nonnull
public final Invoice findOriginalSubscriptionInvoice(java.lang.String... args)
                                                                          throws NotFoundException

Invoice that this opportunity was generated from.

--> Invoice (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

setOriginalSubscriptionInvoice

@Nonnull
public SalesCycle setOriginalSubscriptionInvoice(com.aspc.dal.layers.aspc_app.invoice.Invoice value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getPotentialSaleAmt

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

getPrivate

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

getPublishedTS

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

setPublishedTS

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

Throws:

java.lang.Exception

getRejectedReason

@CheckReturnValue
 @Nullable
public java.lang.Object getRejectedReason(java.lang.String... args)

findRejectedReason

@CheckReturnValue
 @Nonnull
public final java.lang.Object findRejectedReason(java.lang.String... args)
                                                                      throws NotFoundException

Reason for rejection.

--> SalesCycleRejectionReason (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SalesCycleRejectionReason

Throws:

NotFoundException - SalesCycleRejectionReason was not found

setRejectedReason

@Nonnull
public SalesCycle setRejectedReason(java.lang.Object value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getReturnDateMonthYear

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

getSaleType

@CheckReturnValue
 @Nullable
public TaskType getSaleType(java.lang.String... args)

findSaleType

@CheckReturnValue
 @Nonnull
public final TaskType findSaleType(java.lang.String... args)
                                                        throws NotFoundException

Sale Type.

--> TaskType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

TaskType

Throws:

NotFoundException - TaskType was not found

setSaleType

@Nonnull
public SalesCycle setSaleType(com.aspc.dal.layers.aspc_app.misc.TaskType value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getUnsuccessfulNote

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

setUnsuccessfulNote

@Nonnull
public SalesCycle setUnsuccessfulNote(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getUnsuccessfulSubject

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

setUnsuccessfulSubject

@Nonnull
public SalesCycle setUnsuccessfulSubject(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

findQuote

public Quote findQuote()

Returns:

the value

findSale

public Sale findSale()

Returns:

the value

createSale

public Sale createSale(MutableDataSource mds)
                throws java.lang.Exception

Parameters:

mds - the mutable data source

Returns:

the value

Throws:

java.lang.Exception - a serious problem

findRenewal

public Invoice findRenewal()

Returns:

the value

generateRenewal

public Invoice generateRenewal(MutableDataSource mds)
                        throws java.lang.Exception

Generates a renewal invoice based on the chargeitems The process creates a new subscription item if there is not already one and makes sure that all charges are under this The generateInvoice is then called to convert to invoice TODO - tidy this process up so that we don't have to generate a subscription item which we delete again

Parameters:

mds - the mutable data source

Returns:

the value

Throws:

java.lang.Exception - a serious problem

displayName

@CheckReturnValue
 @Nonnull
public java.lang.String displayName()

The display name

Overrides:

displayName in class DBObject

Returns:

the display name

createQuote

public DBObject createQuote(MutableDataSource mds)
                     throws java.lang.Exception

Parameters:

mds - the mutable data source

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class ChargeableTask

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class ChargeableTask

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class ChargeableTask

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

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

Description copied from class: ChargeableTask

Over ridden method

Overrides:

extPreSaveRecord in class ChargeableTask

Throws:

java.lang.Exception - a serious problem

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckCreateAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckCreateAccess()
                                                               throws DBAccessException

Additional access checking for create access of this object.

Overrides:

extCheckCreateAccess in class DBObject

Throws:

DBAccessException - No access to create

See Also:

DBObject.checkCreateAccess()

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Additional access checking for DELETE access for this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete this object

extCheckReadAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckReadAccess()
                                                             throws DBAccessException

Additional access checking for READ access of this object.

Overrides:

extCheckReadAccess in class DBObject

Throws:

DBAccessException - No access to READ

See Also:

DBObject.checkReadAccess()

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 ChargeableTask

Throws:

java.lang.Exception - A serious problem

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: ChargeableTask

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

Overrides:

extIsOnChange in class ChargeableTask

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 params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class ChargeableTask

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

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 ChargeableTask

Parameters:

field - The field to get

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

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class ChargeableTask

Parameters:

field - The field to get

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

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

makeSearchText

protected java.lang.String makeSearchText()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

makeRawTags

protected java.lang.String makeRawTags()
                                throws java.lang.Exception

Throws:

java.lang.Exception