com.aspc.Layers.aspc_app.Campaign

Class CampaignContact

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.ContactMap

com.aspc.Layers.aspc_app.Campaign.CampaignContact

All Implemented Interfaces:

SecondaryCacheGroup

public class CampaignContact
extends ContactMap

Maps a contact to be a part of a 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 Maps a contact to be a part of a Campaign
static java.lang.String	DBCLASS_NAME Maps a contact to be a part of a Campaign

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Person	findAssignedTo(java.lang.String... args) Assigned To.
Campaign	findCampaign(java.lang.String... args) Campaign.
CampaignResource	findCampaignResource(java.lang.String... args) Campaign Resource.
Person	findContacted(java.lang.String... args) Contacted.
TaskResult	findResult(java.lang.String... args) Result.
CampaignStatus	findStatus(java.lang.String... args) Status.
Person	getAssignedTo(java.lang.String... args)
Campaign	getCampaign(java.lang.String... args)
CampaignResource	getCampaignResource(java.lang.String... args)
Person	getContacted(java.lang.String... args)
java.util.Date	getLastActioned(java.lang.String... args)
java.util.Date	getNextActionDate(java.lang.String... args)
int	getNumCalls(java.lang.String... args)
TaskResult	getResult(java.lang.String... args)
CampaignStatus	getStatus(java.lang.String... args)
boolean	isCallBackDue(java.lang.String... args)
CampaignContact	setAssignedTo(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
CampaignContact	setCampaign(com.aspc.dal.layers.aspc_app.campaign.Campaign value, java.lang.String... args)
CampaignContact	setCampaignResource(com.aspc.dal.layers.aspc_app.campaign.CampaignResource value, java.lang.String... args)
CampaignContact	setContacted(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
CampaignContact	setLastActioned(java.util.Date value, java.lang.String... args)
CampaignContact	setNextActionDate(java.util.Date value, java.lang.String... args)
CampaignContact	setNumCalls(int value, java.lang.String... args)
CampaignContact	setResult(com.aspc.dal.layers.aspc_app.misc.TaskResult value, java.lang.String... args)
CampaignContact	setStatus(com.aspc.dal.layers.aspc_app.campaign.CampaignStatus value, java.lang.String... args)
void	updateStatus()

Methods inherited from class com.aspc.DBObj.Contact.ContactMap

findContact, findEnteredBy, findKey, getContact, getEnteredBy, getEnterTime, getID, getLastModifiedTime, makeQuery, setContact, setEnteredBy, setEnterTime, setID, setLastModifiedTime

Methods inherited from class com.aspc.DBObj.DBObject

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

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Maps a contact to be a part of a Campaign

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Maps a contact to be a part of a Campaign

Constructor Detail

CampaignContact

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

getAssignedTo

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

findAssignedTo

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

Assigned To.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setAssignedTo

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

Throws:

java.lang.Exception

isCallBackDue

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

getCampaign

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

findCampaign

@CheckReturnValue
 @Nonnull
public final Campaign findCampaign(java.lang.String... args)
                                                        throws NotFoundException

Campaign.

--> Campaign (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Campaign

Throws:

NotFoundException - Campaign was not found

setCampaign

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

Throws:

java.lang.Exception

getCampaignResource

@CheckReturnValue
 @Nullable
public CampaignResource getCampaignResource(java.lang.String... args)

findCampaignResource

@CheckReturnValue
 @Nonnull
public final CampaignResource findCampaignResource(java.lang.String... args)
                                                                        throws NotFoundException

Campaign Resource.

--> CampaignResource (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

CampaignResource

Throws:

NotFoundException - CampaignResource was not found

setCampaignResource

@Nonnull
public CampaignContact setCampaignResource(com.aspc.dal.layers.aspc_app.campaign.CampaignResource value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getContacted

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

findContacted

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

Contacted.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setContacted

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

Throws:

java.lang.Exception

getLastActioned

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

setLastActioned

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

Throws:

java.lang.Exception

getNextActionDate

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

setNextActionDate

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

Throws:

java.lang.Exception

getNumCalls

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

setNumCalls

@Nonnull
public CampaignContact setNumCalls(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getResult

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

findResult

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

Result.

--> TaskResult (String, Searchable)

Parameters:

args - the optional arguments

Returns:

TaskResult

Throws:

NotFoundException - TaskResult was not found

setResult

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

Throws:

java.lang.Exception

getStatus

@CheckReturnValue
 @Nullable
public CampaignStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final CampaignStatus findStatus(java.lang.String... args)
                                                            throws NotFoundException

Status.

--> CampaignStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

CampaignStatus

Throws:

NotFoundException - CampaignStatus was not found

setStatus

@Nonnull
public CampaignContact setStatus(com.aspc.dal.layers.aspc_app.campaign.CampaignStatus value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

updateStatus

public void updateStatus()
                  throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: DBObject

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

Overrides:

extIsOnChange in class DBObject

Parameters:

field - The field

Returns:

the value

eventFieldUpdated

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

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

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

extValidateRecord

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

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

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 ContactMap

Throws:

java.lang.Exception - A serious problem

extGetDerivedValue

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

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

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

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem