com.aspc.questionnaire

Class QuestionChoice

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.questionnaire.QuestionChoice

All Implemented Interfaces:

SecondaryCacheGroup

public class QuestionChoice
extends DBObject

List of choices for a Single/Multiple choice question.

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 List of choices for a Single/Multiple choice question.
static java.lang.String	DBCLASS_NAME List of choices for a Single/Multiple choice question.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static QuestionChoice	create(MutableDataSource mds) Make a new instance of this class.
void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams inParams) update dependent fields.
protected void	extCopy(DBObject target) Additional functionality when an object is copied
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 ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
Question	findGoto(java.lang.String... args) Only valid for single choice question Validation: 1) Must point to a question number greater than the current.
DBHelpItem	findHelpItem(java.lang.String... args) Help Item.
static QuestionChoice	findKey(DataSource ds, int key) Find the target for this class by the primary key
Question	findQuestion(java.lang.String... args) Question.
java.lang.String	getCode(java.lang.String... args)
int	getCommentCols(java.lang.String... args)
int	getCommentRows(java.lang.String... args)
java.lang.String	getDisplayName(java.lang.String... args)
Question	getGoto(java.lang.String... args)
DBHelpItem	getHelpItem(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getLabelHTML(java.lang.String... args)
java.lang.String	getLabelObsolete(java.lang.String... args)
java.lang.String	getLabelTEXT(java.lang.String... args)
Question	getQuestion(java.lang.String... args)
java.lang.String	getScore2Formula(java.lang.String... args)
java.lang.String	getScoreFormula(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getToolTip(java.lang.String... args)
boolean	isLabelIncludesHtmlTags(java.lang.String... args)
static DBQuery<QuestionChoice>	makeQuery(DataSource ds) Make a new QUERY for this class.
QuestionChoice	setCode(java.lang.String value, java.lang.String... args)
QuestionChoice	setCommentCols(int value, java.lang.String... args)
QuestionChoice	setCommentRows(int value, java.lang.String... args)
QuestionChoice	setGoto(com.aspc.dal.questionnaire.Question value, java.lang.String... args)
QuestionChoice	setHelpItem(com.aspc.dal.dbobj.help.DBHelpItem value, java.lang.String... args)
QuestionChoice	setID(int value, java.lang.String... args)
QuestionChoice	setLabelHTML(java.lang.String value, java.lang.String... args)
QuestionChoice	setLabelIncludesHtmlTags(boolean value, java.lang.String... args)
QuestionChoice	setLabelObsolete(java.lang.String value, java.lang.String... args)
QuestionChoice	setLabelTEXT(java.lang.String value, java.lang.String... args)
QuestionChoice	setQuestion(com.aspc.dal.questionnaire.Question value, java.lang.String... args)
QuestionChoice	setScore2Formula(java.lang.String value, java.lang.String... args)
QuestionChoice	setScoreFormula(java.lang.String value, java.lang.String... args)
QuestionChoice	setSequence(int value, java.lang.String... args)
QuestionChoice	setShowCommentBox(boolean value, java.lang.String... args)
QuestionChoice	setToolTip(java.lang.String value, java.lang.String... args)
boolean	showCommentBox(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, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, 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, 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

List of choices for a Single/Multiple choice question.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

List of choices for a Single/Multiple choice question.

Constructor Detail

QuestionChoice

public QuestionChoice(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 QuestionChoice setID(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getCode

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

setCode

@Nonnull
public QuestionChoice setCode(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getCommentCols

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

setCommentCols

@Nonnull
public QuestionChoice setCommentCols(int value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getCommentRows

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

setCommentRows

@Nonnull
public QuestionChoice setCommentRows(int value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayName

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

getGoto

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

findGoto

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

Only valid for single choice question

Validation:
1) Must point to a question number greater than the current.

--> Question (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Question

Throws:

NotFoundException - Question was not found

setGoto

@Nonnull
public QuestionChoice setGoto(com.aspc.dal.questionnaire.Question value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getHelpItem

@CheckReturnValue
 @Nullable
public DBHelpItem getHelpItem(java.lang.String... args)

findHelpItem

@CheckReturnValue
 @Nonnull
public final DBHelpItem findHelpItem(java.lang.String... args)
                                                          throws NotFoundException

Help Item.

--> DBHelpItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Help Item

Throws:

NotFoundException - DBHelpItem was not found

setHelpItem

@Nonnull
public QuestionChoice setHelpItem(com.aspc.dal.dbobj.help.DBHelpItem value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getLabelHTML

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

setLabelHTML

@Nonnull
public QuestionChoice setLabelHTML(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isLabelIncludesHtmlTags

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

setLabelIncludesHtmlTags

@Nonnull
public QuestionChoice setLabelIncludesHtmlTags(boolean value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getLabelObsolete

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

setLabelObsolete

@Nonnull
public QuestionChoice setLabelObsolete(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getLabelTEXT

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

setLabelTEXT

@Nonnull
public QuestionChoice setLabelTEXT(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getQuestion

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

findQuestion

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

Question.

--> Question (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Question

Throws:

NotFoundException - Question was not found

setQuestion

@Nonnull
public QuestionChoice setQuestion(com.aspc.dal.questionnaire.Question value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getScore2Formula

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

setScore2Formula

@Nonnull
public QuestionChoice setScore2Formula(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getScoreFormula

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

setScoreFormula

@Nonnull
public QuestionChoice setScoreFormula(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

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

setSequence

@Nonnull
public QuestionChoice setSequence(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

showCommentBox

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

setShowCommentBox

@Nonnull
public QuestionChoice setShowCommentBox(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getToolTip

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

setToolTip

@Nonnull
public QuestionChoice setToolTip(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static QuestionChoice 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<QuestionChoice> 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 QuestionChoice 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
public 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 DBObject

Parameters:

inParams -

field - The field updated.

previous - The previous value for this field.

previousKey - The previous 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

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

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

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