ChargeableTask (stSoftware API)

java.lang.Object
- com.aspc.DBObj.DBObject
- - com.aspc.Layers.aspc_app.Task.Task
  - - com.aspc.Layers.aspc_app.Task.ChargeableTask

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Campaign, JobTemplate, Quote, Sale, SalesCycle, SupplierQuote
```
public class ChargeableTask
extends Task
```
Task is a Generic DBObject.

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
ChargableTask

static java.lang.String DBCLASS_NAME
ChargableTask
- 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

Fields
Modifier and Type	Field and Description
`static GlobalId`	`DBCLASS_GID` ChargableTask
`static java.lang.String`	`DBCLASS_NAME` ChargableTask

Constructor Summary

Constructors
Constructor and Description

ChargeableTask(DBClass def, DataSource dataSource)
Std.

Constructors
Constructor and Description
`ChargeableTask(DBClass def, DataSource dataSource)` Std.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyChildren(ChargeableTask ctsk)` Over ridden method
`protected void`	`eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams inParams)` update dependent fields.
`protected void`	`extAutoEnterCreate()` Additional functionality when an object is created.
`protected void`	`extCopy(DBObject target)` Additional functionality when an object is copied
`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`	`extPostSaveRecord(long transNr)` OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database.
`protected void`	`extPreSaveRecord()` Over ridden method
`protected void`	`extPreValidate()` Update the in-memory universe BEFORE validating
`Person`	`findAccountManager(java.lang.String... args)` Person responsible for managing the customer account for this project.
`Contact`	`findBillTo(java.lang.String... args)` Person responsible for paying the completed work, or task.
`TaskType`	`findCalcSaleType(java.lang.String... args)` Determines the sales type.
`Campaign`	`findCampaign(java.lang.String... args)` Campaign that this item originated from.
`TaxCode`	`findChargeTaxCode(java.lang.String... args)` Default tax code to be used when adding charges.
`Person`	`findContact(java.lang.String... args)` Primary contact.
`Task`	`findCopyFromTemplate(java.lang.String... args)` Copies Tasks from the supplied Template.
`Labour`	`findDefaultLabourRate(java.lang.String... args)` Default rate.
`Activity`	`findLastCompleteActivity(java.lang.String... args)` Id of last completed activity.
`Activity`	`findLastModifiedActivity(java.lang.String... args)` Last Modified Activity.
`Activity`	`findNextScheduledActivity(java.lang.String... args)` Next future scheduled Activity.
`java.lang.Object`	`findPaymentTerms(java.lang.String... args)` Intructions on when payment should be made.
`Contact`	`findRecipient(java.lang.String... args)` Customer.
`Contact`	`findSite(java.lang.String... args)` Site where work is to be done.
`Region`	`findSiteRegion(java.lang.String... args)` Site Region.
`State`	`findState(java.lang.String... args)` A new state XLAT field, since the field siteState is old and does not linked to State table, it's done only code.
`Suburb`	`findSuburb(java.lang.String... args)` A new suburb XLAT field, since the field siteSuburbCity is old and does not linked to Suburb table, it's done only code.
`Person`	`getAccountManager(java.lang.String... args)`
`Activity[]`	`getActivities()`
`double`	`getAdjTotalPrice(java.lang.String... args)`
`Contact`	`getBillTo(java.lang.String... args)`
`protected GlobalKey`	`getCalcAttn()`
`protected GlobalKey`	`getCalcBillTo()`
`TaskType`	`getCalcSaleType(java.lang.String... args)`
`Campaign`	`getCampaign(java.lang.String... args)`
`TaxCode`	`getChargeTaxCode(java.lang.String... args)`
`double`	`getChargeTaxRate(java.lang.String... args)`
`Person`	`getContact(java.lang.String... args)`
`protected java.lang.Object`	`getContactDisplaySiteAddress(DBObject contact, java.lang.String contactFld)`
`Task`	`getCopyFromTemplate(java.lang.String... args)`
`double`	`getCreditSurchargePerc(java.lang.String... args)`
`java.lang.String`	`getCustomerInvoice(java.lang.String... args)`
`java.util.Date`	`getCustomerInvoiceDate(java.lang.String... args)`
`java.lang.String`	`getCustomerPO(java.lang.String... args)`
`Labour`	`getDefaultLabourRate(java.lang.String... args)`
`protected DBObject`	`getDefaultSiteContact()`
`double`	`getDeliveryFee(java.lang.String... args)`
`double`	`getDiscountRate(java.lang.String... args)`
`java.lang.String`	`getDisplayContact(java.lang.String... args)`
`protected java.lang.Object`	`getDisplaySiteAddress(java.lang.String contactFld, java.lang.String realFld)`
`java.lang.String`	`getDisplaySiteCountry(java.lang.String... args)`
`java.lang.String`	`getDisplaySitePhone(java.lang.String... args)`
`java.lang.String`	`getDisplaySitePostCode(java.lang.String... args)`
`java.lang.String`	`getDisplaySiteState(java.lang.String... args)`
`java.lang.String`	`getDisplaySiteSuburbCity(java.lang.String... args)`
`JobItem[]`	`getJobItems(boolean includeSubItems)` Returns all the job items linked to this chargeable task If includeSubItems is set then job items contained within group items are returned as well.
`java.util.Date`	`getLastActionTime(java.lang.String... args)`
`Activity`	`getLastCompleteActivity(java.lang.String... args)`
`Activity`	`getLastModifiedActivity(java.lang.String... args)`
`java.lang.String`	`getLastNoticeNumber(java.lang.String... args)`
`Activity`	`getNextScheduledActivity(java.lang.String... args)`
`java.lang.String`	`getOrderConfirmationNum(java.lang.String... args)`
`java.lang.Object`	`getPaymentTerms(java.lang.String... args)`
`double`	`getProfit(java.lang.String... args)`
`double`	`getProfitPerc(java.lang.String... args)`
`Contact`	`getRecipient(java.lang.String... args)`
`java.lang.String`	`getRecipientName(java.lang.String... args)`
`java.lang.String`	`getReminderComment(java.lang.String... args)`
`Contact`	`getSite(java.lang.String... args)`
`java.lang.String`	`getSiteAddress(java.lang.String... args)`
`java.lang.String`	`getSiteContactMobile(java.lang.String... args)`
`java.lang.String`	`getSiteContactPerson(java.lang.String... args)`
`java.lang.String`	`getSiteContactPhone(java.lang.String... args)`
`java.lang.String`	`getSiteCoordinate(java.lang.String... args)`
`java.lang.String`	`getSiteCountry(java.lang.String... args)`
`java.lang.String`	`getSiteFax(java.lang.String... args)`
`java.lang.String`	`getSiteName(java.lang.String... args)`
`java.lang.String`	`getSiteNotes(java.lang.String... args)`
`java.lang.String`	`getSitePhone(java.lang.String... args)`
`java.lang.String`	`getSitePostcode(java.lang.String... args)`
`Region`	`getSiteRegion(java.lang.String... args)`
`java.lang.String`	`getSiteState(java.lang.String... args)`
`java.lang.String`	`getSiteSuburbCity(java.lang.String... args)`
`State`	`getState(java.lang.String... args)`
`TaskStatusJournal[]`	`getStatusJournal()` Get status journal
`Suburb`	`getSuburb(java.lang.String... args)`
`double`	`getTotalDiscount(java.lang.String... args)`
`double`	`getTotalRoyalties(java.lang.String... args)`
`ChargeableTask`	`setAccountManager(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)`
`ChargeableTask`	`setAdjTotalPrice(double value, java.lang.String... args)`
`ChargeableTask`	`setBillTo(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)`
`ChargeableTask`	`setCampaign(com.aspc.dal.layers.aspc_app.campaign.Campaign value, java.lang.String... args)`
`ChargeableTask`	`setChargeTaxCode(com.aspc.dal.layers.aspc_app.misc.Tax value, java.lang.String... args)`
`ChargeableTask`	`setChargeTaxRate(double value, java.lang.String... args)`
`ChargeableTask`	`setContact(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)`
`ChargeableTask`	`setCopyFromTemplate(com.aspc.dal.layers.aspc_app.task.Task value, java.lang.String... args)`
`ChargeableTask`	`setCreditSurchargePerc(double value, java.lang.String... args)`
`ChargeableTask`	`setCustomerInvoice(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setCustomerInvoiceDate(java.util.Date value, java.lang.String... args)`
`ChargeableTask`	`setCustomerPO(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setDefaultLabourRate(com.aspc.dal.layers.aspc_app.productlabour.Labour value, java.lang.String... args)`
`ChargeableTask`	`setDeliveryFee(double value, java.lang.String... args)`
`ChargeableTask`	`setDiscountRate(double value, java.lang.String... args)`
`ChargeableTask`	`setOrderConfirmationNum(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setPaymentTerms(java.lang.Object value, java.lang.String... args)`
`ChargeableTask`	`setRecipient(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)`
`ChargeableTask`	`setReminderComment(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSite(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)`
`ChargeableTask`	`setSiteAddress(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteContactMobile(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteContactPerson(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteContactPhone(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteCoordinate(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteCountry(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteFax(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteName(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteNotes(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSitePhone(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSitePostcode(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteRegion(com.aspc.dal.layers.aspc_app.misc.Region value, java.lang.String... args)`
`ChargeableTask`	`setSiteState(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setSiteSuburbCity(java.lang.String value, java.lang.String... args)`
`ChargeableTask`	`setState(com.aspc.dal.dbobj.misc.State value, java.lang.String... args)`
`ChargeableTask`	`setSuburb(com.aspc.dal.layers.aspc_app.misc.Suburb value, java.lang.String... args)`
`protected void`	`updateProspectCategory(DBObject base)`

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, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, 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
```
ChargableTask

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

ChargableTask

Constructor Detail
- ChargeableTask
```
public ChargeableTask(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

getAccountManager

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

findAccountManager
```
@CheckReturnValue
 @Nonnull
public final Person findAccountManager(java.lang.String... args)
                                                            throws NotFoundException
```
Person responsible for managing the customer account for this project.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setAccountManager

@Nonnull
public ChargeableTask setAccountManager(com.aspc.dal.layers.aspc_app.contact.Person value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

getAdjTotalPrice

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

setAdjTotalPrice

@Nonnull
public ChargeableTask setAdjTotalPrice(double value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

getBillTo

@CheckReturnValue
 @Nullable
public Contact getBillTo(java.lang.String... args)

findBillTo
```
@CheckReturnValue
 @Nonnull
public final Contact findBillTo(java.lang.String... args)
                                                     throws NotFoundException
```
Person responsible for paying the completed work, or task.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setBillTo

@Nonnull
public ChargeableTask setBillTo(com.aspc.dal.dbobj.contact.Contact value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getCalcSaleType

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

findCalcSaleType
```
@CheckReturnValue
 @Nonnull
public final TaskType findCalcSaleType(java.lang.String... args)
                                                            throws NotFoundException
```
Determines the sales type. This can be the actual type if it is a sale or the proposed sale type if it is an opportunity or a quote.

--> TaskType (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

TaskType

Throws:

NotFoundException - TaskType was not found

getCampaign

@CheckReturnValue
 @Nullable
public Campaign getCampaign(java.lang.String... args)

findCampaign
```
@CheckReturnValue
 @Nonnull
public final Campaign findCampaign(java.lang.String... args)
                                                        throws NotFoundException
```
Campaign that this item originated from.

--> Campaign (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Campaign

Throws:

NotFoundException - Campaign was not found

setCampaign

@Nonnull
public ChargeableTask setCampaign(com.aspc.dal.layers.aspc_app.campaign.Campaign value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

getChargeTaxCode

@CheckReturnValue
 @Nullable
public TaxCode getChargeTaxCode(java.lang.String... args)

findChargeTaxCode
```
@CheckReturnValue
 @Nonnull
public final TaxCode findChargeTaxCode(java.lang.String... args)
                                                            throws NotFoundException
```
Default tax code to be used when adding charges.

--> Tax (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Tax Codes

Throws:

NotFoundException - Tax was not found

setChargeTaxCode

@Nonnull
public ChargeableTask setChargeTaxCode(com.aspc.dal.layers.aspc_app.misc.Tax value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

getChargeTaxRate

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

setChargeTaxRate

@Nonnull
public ChargeableTask setChargeTaxRate(double value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

getContact

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

findContact
```
@CheckReturnValue
 @Nonnull
public final Person findContact(java.lang.String... args)
                                                     throws NotFoundException
```
Primary contact. Will default to customer if customer is a Contact rather then a Business Unit.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setContact

@Nonnull
public ChargeableTask setContact(com.aspc.dal.layers.aspc_app.contact.Person value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:: java.lang.Exception

getCopyFromTemplate

@CheckReturnValue
 @Nullable
public Task getCopyFromTemplate(java.lang.String... args)

findCopyFromTemplate

@CheckReturnValue
 @Nonnull
public final Task findCopyFromTemplate(java.lang.String... args)
                                                            throws NotFoundException

Copies Tasks from the supplied Template.

--> Task (Integer, Searchable)

Parameters:: args - the optional arguments
Returns:: Task
Throws:: NotFoundException - Task was not found

setCopyFromTemplate

@Nonnull
public ChargeableTask setCopyFromTemplate(com.aspc.dal.layers.aspc_app.task.Task value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:: java.lang.Exception

getCreditSurchargePerc

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

setCreditSurchargePerc

@Nonnull
public ChargeableTask setCreditSurchargePerc(double value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:: java.lang.Exception

getCustomerInvoice

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

setCustomerInvoice

@Nonnull
public ChargeableTask setCustomerInvoice(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:: java.lang.Exception

getCustomerInvoiceDate

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

setCustomerInvoiceDate

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

Throws:: java.lang.Exception

getCustomerPO

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

setCustomerPO

@Nonnull
public ChargeableTask setCustomerPO(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:: java.lang.Exception

getDefaultLabourRate

@CheckReturnValue
 @Nullable
public Labour getDefaultLabourRate(java.lang.String... args)

findDefaultLabourRate

@CheckReturnValue
 @Nonnull
public final Labour findDefaultLabourRate(java.lang.String... args)
                                                               throws NotFoundException

Default rate.

--> Labour (String, Searchable)

Parameters:: args - the optional arguments
Returns:: Labour
Throws:: NotFoundException - Labour was not found

setDefaultLabourRate

@Nonnull
public ChargeableTask setDefaultLabourRate(com.aspc.dal.layers.aspc_app.productlabour.Labour value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:: java.lang.Exception

getDeliveryFee

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

setDeliveryFee

@Nonnull
public ChargeableTask setDeliveryFee(double value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:: java.lang.Exception

getDiscountRate

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

setDiscountRate

@Nonnull
public ChargeableTask setDiscountRate(double value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:: java.lang.Exception

getDisplayContact

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

getDisplaySiteCountry

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

getDisplaySitePhone

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

getDisplaySitePostCode

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

getDisplaySiteState

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

getDisplaySiteSuburbCity

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

getLastActionTime

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

getLastCompleteActivity

@CheckReturnValue
 @Nullable
public Activity getLastCompleteActivity(java.lang.String... args)

findLastCompleteActivity

@CheckReturnValue
 @Nonnull
public final Activity findLastCompleteActivity(java.lang.String... args)
                                                                    throws NotFoundException

Id of last completed activity.

--> Activity (Integer, Derived, Searchable)

Parameters:: args - the optional arguments
Returns:: Activity
Throws:: NotFoundException - Activity was not found

getLastModifiedActivity

@CheckReturnValue
 @Nullable
public Activity getLastModifiedActivity(java.lang.String... args)

findLastModifiedActivity

@CheckReturnValue
 @Nonnull
public final Activity findLastModifiedActivity(java.lang.String... args)
                                                                    throws NotFoundException

Last Modified Activity.

--> Activity (Integer, Derived, Searchable)

Parameters:: args - the optional arguments
Returns:: Activity
Throws:: NotFoundException - Activity was not found

getLastNoticeNumber

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

getNextScheduledActivity

@CheckReturnValue
 @Nullable
public Activity getNextScheduledActivity(java.lang.String... args)

findNextScheduledActivity

@CheckReturnValue
 @Nonnull
public final Activity findNextScheduledActivity(java.lang.String... args)
                                                                     throws NotFoundException

Next future scheduled Activity.

--> Activity (Integer, Derived, Searchable)

Parameters:: args - the optional arguments
Returns:: Activity
Throws:: NotFoundException - Activity was not found

getOrderConfirmationNum

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

setOrderConfirmationNum

@Nonnull
public ChargeableTask setOrderConfirmationNum(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:: java.lang.Exception

getPaymentTerms

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

findPaymentTerms
```
@CheckReturnValue
 @Nonnull
public final java.lang.Object findPaymentTerms(java.lang.String... args)
                                                                    throws NotFoundException
```
Intructions on when payment should be made.

--> PaymentTerms (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentTerms

Throws:

NotFoundException - PaymentTerms was not found

setPaymentTerms

@Nonnull
public ChargeableTask setPaymentTerms(java.lang.Object value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:: java.lang.Exception

getProfit

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

getProfitPerc

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

getRecipient

@CheckReturnValue
 @Nullable
public Contact getRecipient(java.lang.String... args)

findRecipient

@CheckReturnValue
 @Nonnull
public final Contact findRecipient(java.lang.String... args)
                                                        throws NotFoundException

Customer.

--> Contact (Integer, Searchable)

Parameters:: args - the optional arguments
Returns:: Person/Business
Throws:: NotFoundException - Contact was not found

setRecipient

@Nonnull
public ChargeableTask setRecipient(com.aspc.dal.dbobj.contact.Contact value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getRecipientName

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

getReminderComment

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

setReminderComment

@Nonnull
public ChargeableTask setReminderComment(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:: java.lang.Exception

getSite

@CheckReturnValue
 @Nullable
public Contact getSite(java.lang.String... args)

findSite
```
@CheckReturnValue
 @Nonnull
public final Contact findSite(java.lang.String... args)
                                                   throws NotFoundException
```
Site where work is to be done.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setSite

@Nonnull
public ChargeableTask setSite(com.aspc.dal.dbobj.contact.Contact value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getSiteAddress

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

setSiteAddress

@Nonnull
public ChargeableTask setSiteAddress(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:: java.lang.Exception

getSiteContactMobile

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

setSiteContactMobile

@Nonnull
public ChargeableTask setSiteContactMobile(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:: java.lang.Exception

getSiteContactPerson

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

setSiteContactPerson

@Nonnull
public ChargeableTask setSiteContactPerson(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:: java.lang.Exception

getSiteContactPhone

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

setSiteContactPhone

@Nonnull
public ChargeableTask setSiteContactPhone(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:: java.lang.Exception

getSiteCoordinate

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

setSiteCoordinate

@Nonnull
public ChargeableTask setSiteCoordinate(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

getSiteCountry

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

setSiteCountry

@Nonnull
public ChargeableTask setSiteCountry(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:: java.lang.Exception

getSiteFax

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

setSiteFax

@Nonnull
public ChargeableTask setSiteFax(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:: java.lang.Exception

getSiteName

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

setSiteName

@Nonnull
public ChargeableTask setSiteName(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

getSiteNotes

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

setSiteNotes

@Nonnull
public ChargeableTask setSiteNotes(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getSitePhone

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

setSitePhone

@Nonnull
public ChargeableTask setSitePhone(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getSitePostcode

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

setSitePostcode

@Nonnull
public ChargeableTask setSitePostcode(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:: java.lang.Exception

getSiteRegion

@CheckReturnValue
 @Nullable
public Region getSiteRegion(java.lang.String... args)

findSiteRegion

@CheckReturnValue
 @Nonnull
public final Region findSiteRegion(java.lang.String... args)
                                                        throws NotFoundException

Site Region.

--> Region (String, Searchable)

Parameters:: args - the optional arguments
Returns:: Region
Throws:: NotFoundException - Region was not found

setSiteRegion

@Nonnull
public ChargeableTask setSiteRegion(com.aspc.dal.layers.aspc_app.misc.Region value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:: java.lang.Exception

getSiteState

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

setSiteState

@Nonnull
public ChargeableTask setSiteState(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getSiteSuburbCity

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

setSiteSuburbCity

@Nonnull
public ChargeableTask setSiteSuburbCity(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

getState

@CheckReturnValue
 @Nullable
public State getState(java.lang.String... args)

findState
```
@CheckReturnValue
 @Nonnull
public final State findState(java.lang.String... args)
                                                  throws NotFoundException
```
A new state XLAT field, since the field siteState is old and does not linked to State table, it's done only code.

--> State (String, Searchable)

Parameters:

args - the optional arguments

Returns:

State

Throws:

NotFoundException - State was not found

setState

@Nonnull
public ChargeableTask setState(com.aspc.dal.dbobj.misc.State value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getSuburb

@CheckReturnValue
 @Nullable
public Suburb getSuburb(java.lang.String... args)

findSuburb
```
@CheckReturnValue
 @Nonnull
public final Suburb findSuburb(java.lang.String... args)
                                                    throws NotFoundException
```
A new suburb XLAT field, since the field siteSuburbCity is old and does not linked to Suburb table, it's done only code.

--> Suburb (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Suburb

Throws:

NotFoundException - Suburb was not found

setSuburb

@Nonnull
public ChargeableTask setSuburb(com.aspc.dal.layers.aspc_app.misc.Suburb value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getTotalDiscount

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

getTotalRoyalties

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

getActivities
```
public Activity[] getActivities()
```
Returns:

the value

getStatusJournal

public TaskStatusJournal[] getStatusJournal()
                                     throws java.lang.Exception

Get status journal

Returns:: the value
Throws:: java.lang.Exception - a serious problem.

getJobItems
```
public JobItem[] getJobItems(boolean includeSubItems)
```
Returns all the job items linked to this chargeable task If includeSubItems is set then job items contained within group items are returned as well.

Parameters:

includeSubItems -

Returns:

the value

extAutoEnterCreate
```
@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception
```
Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class Task

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Additional functionality when an object is copied

Overrides:: extCopy in class DBObject
Parameters:: target - The target object
Throws:: java.lang.Exception - A serious problem

extIsMandatory
```
@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)
```
Conditional mandatory field.

Overrides:

extIsMandatory in class Task

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

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 Task
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 Task
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

getCalcBillTo

protected GlobalKey getCalcBillTo()
                           throws java.lang.Exception

Returns:: the value
Throws:: java.lang.Exception - a serious problem

getCalcAttn

protected GlobalKey getCalcAttn()
                         throws java.lang.Exception

Returns:: the value
Throws:: java.lang.Exception - a serious problem

getDisplaySiteAddress

protected java.lang.Object getDisplaySiteAddress(java.lang.String contactFld,
                                                 java.lang.String realFld)

Parameters:: contactFld -; realFld -
Returns:: the value

getContactDisplaySiteAddress

protected java.lang.Object getContactDisplaySiteAddress(DBObject contact,
                                                        java.lang.String contactFld)

Parameters:: contact -; contactFld -
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

update dependent fields.

Overrides:: eventFieldUpdated in class Task
Parameters:: inParams -; field - The field updated.; previous - The previous value for this field.; previousKey - The previous key
Throws:: java.lang.Exception - a serious problem

extIsOnChange
```
@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)
```
OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class Task

Parameters:

field - The field to check

Returns:

true if the field affects others when changed

getDefaultSiteContact

protected DBObject getDefaultSiteContact()
                                  throws java.lang.Exception

Returns:: the value
Throws:: java.lang.Exception - a serious problem

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:: extPreValidate in class Task
Throws:: java.lang.Exception - A serious problem

extPostSaveRecord
```
@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)
```
Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database. At this stage the database transaction has been committed. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - This transaction number that was just saved.

updateProspectCategory

protected void updateProspectCategory(DBObject base)
                               throws java.lang.Exception

Parameters:: base - the base object
Throws:: java.lang.Exception - a serious problem

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 Task

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

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

Over ridden method

Overrides:: extPreSaveRecord in class Task
Throws:: java.lang.Exception - Serious problem

copyChildren
```
public void copyChildren(ChargeableTask ctsk)
                  throws java.lang.Exception
```
Over ridden method

Overrides:

copyChildren in class Task

Parameters:

ctsk - Chargeable Task

Throws:

java.lang.Exception - Serious Problem

Class ChargeableTask

Nested Class Summary

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

Field Summary

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

Fields inherited from class com.aspc.DBObj.DBObject

Constructor Summary