com.aspc.Layers.aspc_app.Campaign

Class Campaign

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.Campaign.Campaign

All Implemented Interfaces:

SecondaryCacheGroup

public class Campaign
extends ChargeableTask

Add a new campaign.

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

Since:

November 20, 2003 11:51 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 Add a new campaign
static java.lang.String	DBCLASS_NAME Add a new campaign

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
Campaign(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extPostSaveRecord(long transNr) OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database.
TaskResult	findMaxCallsResult(java.lang.String... args) Result to set the campaign contact to when max calls are reached.
Questionnaire	findQuestionnaire(java.lang.String... args) The questionnaire for this campaign.
java.lang.String	getBusinessContactFilter(java.lang.String... args)
DBObject	getContactMap(DBObject contact)
DBObject[]	getContactMaps()
int	getMaxCallAttempts(java.lang.String... args)
TaskResult	getMaxCallsResult(java.lang.String... args)
Questionnaire	getQuestionnaire(java.lang.String... args)
java.lang.String	getQueueSortOrder(java.lang.String... args)
DBObject[]	getResources()
java.lang.String	getSurveyCode(java.lang.String... args)
boolean	isExcludeEmployeeStats(java.lang.String... args)
Campaign	setBusinessContactFilter(java.lang.String value, java.lang.String... args)
Campaign	setExcludeEmployeeStats(boolean value, java.lang.String... args)
Campaign	setMaxCallAttempts(int value, java.lang.String... args)
Campaign	setMaxCallsResult(com.aspc.dal.layers.aspc_app.misc.TaskResult value, java.lang.String... args)
Campaign	setQuestionnaire(com.aspc.dal.questionnaire.Questionnaire value, java.lang.String... args)
Campaign	setQueueSortOrder(java.lang.String value, java.lang.String... args)
Campaign	setSurveyCode(java.lang.String value, java.lang.String... args)

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

copyChildren, eventFieldUpdated, extCopy, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extIsMandatory, extIsOnChange, extPreSaveRecord, extPreValidate, 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, 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

Add a new campaign

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Add a new campaign

Constructor Detail

Campaign

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

getBusinessContactFilter

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

setBusinessContactFilter

@Nonnull
public Campaign setBusinessContactFilter(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isExcludeEmployeeStats

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

setExcludeEmployeeStats

@Nonnull
public Campaign setExcludeEmployeeStats(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getMaxCallAttempts

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

setMaxCallAttempts

@Nonnull
public Campaign setMaxCallAttempts(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getMaxCallsResult

@CheckReturnValue
 @Nullable
public TaskResult getMaxCallsResult(java.lang.String... args)

findMaxCallsResult

@CheckReturnValue
 @Nonnull
public final TaskResult findMaxCallsResult(java.lang.String... args)
                                                                throws NotFoundException

Result to set the campaign contact to when max calls are reached.

--> TaskResult (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

TaskResult

Throws:

NotFoundException - TaskResult was not found

setMaxCallsResult

@Nonnull
public Campaign setMaxCallsResult(com.aspc.dal.layers.aspc_app.misc.TaskResult value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getQuestionnaire

@CheckReturnValue
 @Nullable
public Questionnaire getQuestionnaire(java.lang.String... args)

findQuestionnaire

@CheckReturnValue
 @Nonnull
public final Questionnaire findQuestionnaire(java.lang.String... args)
                                                                  throws NotFoundException

The questionnaire for this campaign.

--> Questionnaire (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Questionnaire

Throws:

NotFoundException - Questionnaire was not found

setQuestionnaire

@Nonnull
public Campaign setQuestionnaire(com.aspc.dal.questionnaire.Questionnaire value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getQueueSortOrder

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

setQueueSortOrder

@Nonnull
public Campaign setQueueSortOrder(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSurveyCode

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

setSurveyCode

@Nonnull
public Campaign setSurveyCode(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getResources

public DBObject[] getResources()
                        throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getContactMaps

public DBObject[] getContactMaps()
                          throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getContactMap

public DBObject getContactMap(DBObject contact)
                       throws java.lang.Exception

Parameters:

contact -

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()

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 ChargeableTask

Parameters:

transNr - the transaction number