com.aspc.questionnaire

Class Answers

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.questionnaire.Answers

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Answers

public class Answers
extends DBObject

Answers is a placeholder for a person's answers to a questionnaire.

There should be one answers record per Person/Questionnaire.

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

Since:

June 1, 2001, 11:51 AM

Author:

Nigel Leck

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 Answers is a placeholder for a person's answers to a questionnaire.
static java.lang.String	DBCLASS_NAME Answers is a placeholder for a person's answers to a questionnaire.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	correctStatus() correct the status
static Answers	create(MutableDataSource mds) Make a new instance of this class.
void	disableStatusCorrection() disable the correction
void	enableStatusCorrection() enable correction
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 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.
AnswersCallAttempt	findCallAttempt(java.lang.String... args) Call attempt.
static Answers	findKey(DataSource ds, int key) Find the target for this class by the primary key
Question	findNextQuestion(java.lang.String... args) The next question to be answered.
Questionnaire	findQuestionnaire(java.lang.String... args) Questionnaire.
Contact	findRecordAgainst(java.lang.String... args) Record Against.
Person	findSpokeTo(java.lang.String... args) Contact.
AnswersStatus	findStatus(java.lang.String... args) The status of the user's answers.
java.lang.String	getAbortReason(java.lang.String... args)
java.lang.String	getAnsweredByEmail(java.lang.String... args)
java.lang.String	getAnsweredByName(java.lang.String... args)
java.lang.String	getAnsweredByPostCode(java.lang.String... args)
AnswersCallAttempt	getCallAttempt(java.lang.String... args)
int	getID(java.lang.String... args)
Question	getNextQuestion(java.lang.String... args)
int	getNumCompletedQuestions(java.lang.String... args)
Questionnaire	getQuestionnaire(java.lang.String... args)
java.util.Date	getRawStartedTime(java.lang.String... args)
java.util.Date	getRawUpdatedTime(java.lang.String... args)
Contact	getRecordAgainst(java.lang.String... args)
java.lang.String	getRegisterEmail(java.lang.String... args)
java.lang.String	getRegisterFirstName(java.lang.String... args)
java.lang.String	getRegisterIP(java.lang.String... args)
java.lang.String	getRegisterLastName(java.lang.String... args)
java.lang.String	getRegisterPostCode(java.lang.String... args)
java.util.Date	getRescheduleFor(java.lang.String... args)
java.lang.String	getResult(java.lang.String... args)
double	getScore(java.lang.String... args)
double	getScore2(java.lang.String... args)
Person	getSpokeTo(java.lang.String... args)
java.util.Date	getStartedTime(java.lang.String... args)
AnswersStatus	getStatus(java.lang.String... args)
java.lang.String	getToken(java.lang.String... args)
java.lang.String	getUniqueCheck(java.lang.String... args)
java.util.Date	getUpdatedTime(java.lang.String... args)
boolean	isApplicable(Question aQuestion) is the question applicable
boolean	isDoPreferredOnly(java.lang.String... args)
boolean	isOnlyPreferredAnswered(java.lang.String... args)
boolean	isRegisterConfirmed(java.lang.String... args)
static DBQuery<Answers>	makeQuery(DataSource ds) Make a new QUERY for this class.
Answers	setAbortReason(java.lang.String value, java.lang.String... args)
Answers	setAnsweredByPostCode(java.lang.String value, java.lang.String... args)
Answers	setCallAttempt(com.aspc.dal.questionnaire.AnswersCallAttempt value, java.lang.String... args)
Answers	setDoPreferredOnly(boolean value, java.lang.String... args)
Answers	setID(int value, java.lang.String... args)
Answers	setQuestionnaire(com.aspc.dal.questionnaire.Questionnaire value, java.lang.String... args)
Answers	setRawStartedTime(java.util.Date value, java.lang.String... args)
Answers	setRawUpdatedTime(java.util.Date value, java.lang.String... args)
Answers	setRecordAgainst(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Answers	setRegisterConfirmed(boolean value, java.lang.String... args)
Answers	setRegisterEmail(java.lang.String value, java.lang.String... args)
Answers	setRegisterFirstName(java.lang.String value, java.lang.String... args)
Answers	setRegisterIP(java.lang.String value, java.lang.String... args)
Answers	setRegisterLastName(java.lang.String value, java.lang.String... args)
Answers	setRegisterPostCode(java.lang.String value, java.lang.String... args)
Answers	setRescheduleFor(java.util.Date value, java.lang.String... args)
Answers	setSpokeTo(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
Answers	setStatus(com.aspc.dal.questionnaire.AnswersStatus value, java.lang.String... args)
Answers	setToken(java.lang.String value, java.lang.String... args)
Answers	setUniqueCheck(java.lang.String value, java.lang.String... args)

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, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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, 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

Answers is a placeholder for a person's answers to a questionnaire.

There should be one answers record per Person/Questionnaire.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Answers is a placeholder for a person's answers to a questionnaire.

There should be one answers record per Person/Questionnaire.

Constructor Detail

Answers

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

getID

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

setID

@Nonnull
public Answers setID(int value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getAbortReason

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

setAbortReason

@Nonnull
public Answers setAbortReason(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getAnsweredByEmail

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

getAnsweredByName

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

getAnsweredByPostCode

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

setAnsweredByPostCode

@Nonnull
public Answers setAnsweredByPostCode(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getCallAttempt

@CheckReturnValue
 @Nullable
public AnswersCallAttempt getCallAttempt(java.lang.String... args)

findCallAttempt

@CheckReturnValue
 @Nonnull
public final AnswersCallAttempt findCallAttempt(java.lang.String... args)
                                                                     throws NotFoundException

Call attempt.

--> AnswersCallAttempt (String, Searchable)

Parameters:

args - the optional arguments

Returns:

AnswersCallAttempt

Throws:

NotFoundException - AnswersCallAttempt was not found

setCallAttempt

@Nonnull
public Answers setCallAttempt(com.aspc.dal.questionnaire.AnswersCallAttempt value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

isDoPreferredOnly

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

setDoPreferredOnly

@Nonnull
public Answers setDoPreferredOnly(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getNextQuestion

@CheckReturnValue
 @Nullable
public Question getNextQuestion(java.lang.String... args)

findNextQuestion

@CheckReturnValue
 @Nonnull
public final Question findNextQuestion(java.lang.String... args)
                                                            throws NotFoundException

The next question to be answered.

--> Question (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Question

Throws:

NotFoundException - Question was not found

getNumCompletedQuestions

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

isOnlyPreferredAnswered

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

getQuestionnaire

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

findQuestionnaire

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

Questionnaire.

--> Questionnaire (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Questionnaire

Throws:

NotFoundException - Questionnaire was not found

setQuestionnaire

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

Throws:

java.lang.Exception

getRawStartedTime

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

setRawStartedTime

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

Throws:

java.lang.Exception

getRawUpdatedTime

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

setRawUpdatedTime

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

Throws:

java.lang.Exception

getRecordAgainst

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

findRecordAgainst

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

Record Against.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setRecordAgainst

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

Throws:

java.lang.Exception

isRegisterConfirmed

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

setRegisterConfirmed

@Nonnull
public Answers setRegisterConfirmed(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRegisterEmail

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

setRegisterEmail

@Nonnull
public Answers setRegisterEmail(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getRegisterFirstName

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

setRegisterFirstName

@Nonnull
public Answers setRegisterFirstName(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRegisterIP

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

setRegisterIP

@Nonnull
public Answers setRegisterIP(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getRegisterLastName

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

setRegisterLastName

@Nonnull
public Answers setRegisterLastName(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getRegisterPostCode

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

setRegisterPostCode

@Nonnull
public Answers setRegisterPostCode(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getRescheduleFor

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

setRescheduleFor

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

Throws:

java.lang.Exception

getResult

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

getScore

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

getScore2

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

getSpokeTo

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

findSpokeTo

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

Contact.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setSpokeTo

@Nonnull
public Answers setSpokeTo(com.aspc.dal.dbobj.contact.Person value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getStartedTime

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

getStatus

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

findStatus

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

The status of the user's answers.

--> AnswersStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

AnswersStatus

Throws:

NotFoundException - AnswersStatus was not found

setStatus

@Nonnull
public Answers setStatus(com.aspc.dal.questionnaire.AnswersStatus value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getToken

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

setToken

@Nonnull
public Answers setToken(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getUniqueCheck

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

setUniqueCheck

@Nonnull
public Answers setUniqueCheck(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getUpdatedTime

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

create

@Nonnull
 @CheckReturnValue
public static Answers create(@Nonnull
                                                         MutableDataSource mds)
                                                  throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Answers> makeQuery(@Nonnull
                                                                     DataSource ds)
                                                              throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Answers findKey(@Nonnull
                                                          DataSource ds,
                                                          int key)
                                                   throws NotFoundException,
                                                          java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

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

disableStatusCorrection

public void disableStatusCorrection()

disable the correction

enableStatusCorrection

public void enableStatusCorrection()
                            throws java.lang.Exception

enable correction

Throws:

java.lang.Exception - a serious problem

correctStatus

public void correctStatus()
                   throws java.lang.Exception

correct the status

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 DBObject

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

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

Throws:

java.lang.Exception - A serious problem

isApplicable

public boolean isApplicable(Question aQuestion)
                     throws java.lang.Exception

is the question applicable

Parameters:

aQuestion - The question

Returns:

true if applicable

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 DBObject

Throws:

java.lang.Exception - a serious problem