com.aspc.questionnaire

Class Questionnaire

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.questionnaire.Questionnaire

All Implemented Interfaces:

SecondaryCacheGroup

public class Questionnaire
extends DBObject

This the base class for a questionnaire/quiz/survey

A Questionnaire may have 1..N questions

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 This the base class for a questionnaire/quiz/survey A Questionnaire may have 1..N questions
static java.lang.String	DBCLASS_NAME This the base class for a questionnaire/quiz/survey A Questionnaire may have 1..N questions

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Questionnaire	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.
DBHelpItem	findHelpItem(java.lang.String... args) Help Item.
static Questionnaire	findKey(DataSource ds, int key) Find the target for this class by the primary key
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getDescriptionHTML(java.lang.String... args)
java.lang.String	getDescriptionObsolete(java.lang.String... args)
java.lang.String	getDescriptionTEXT(java.lang.String... args)
DBHelpItem	getHelpItem(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMeta(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
int	getNumQuestions(java.lang.String... args)
java.lang.String	getPlugin(java.lang.String... args)
java.lang.String	getThankYouHTML(java.lang.String... args)
java.lang.String	getTitle(java.lang.String... args)
java.lang.String	getToolTip(java.lang.String... args)
boolean	hasPreferredQuestions(java.lang.String... args)
boolean	isDescriptionIncludesHtmlTags(java.lang.String... args)
static DBQuery<Questionnaire>	makeQuery(DataSource ds) Make a new QUERY for this class.
Questionnaire	setCode(java.lang.String value, java.lang.String... args)
Questionnaire	setDescriptionHTML(java.lang.String value, java.lang.String... args)
Questionnaire	setDescriptionIncludesHtmlTags(boolean value, java.lang.String... args)
Questionnaire	setDescriptionObsolete(java.lang.String value, java.lang.String... args)
Questionnaire	setDescriptionTEXT(java.lang.String value, java.lang.String... args)
Questionnaire	setHelpItem(com.aspc.dal.dbobj.help.DBHelpItem value, java.lang.String... args)
Questionnaire	setID(int value, java.lang.String... args)
Questionnaire	setMeta(java.lang.String value, java.lang.String... args)
Questionnaire	setNotes(java.lang.String value, java.lang.String... args)
Questionnaire	setPlugin(java.lang.String value, java.lang.String... args)
Questionnaire	setThankYouHTML(java.lang.String value, java.lang.String... args)
Questionnaire	setTitle(java.lang.String value, java.lang.String... args)
Questionnaire	setToolTip(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, 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

This the base class for a questionnaire/quiz/survey

A Questionnaire may have 1..N questions

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

This the base class for a questionnaire/quiz/survey

A Questionnaire may have 1..N questions

Constructor Detail

Questionnaire

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

Throws:

java.lang.Exception

getDescriptionHTML

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

setDescriptionHTML

@Nonnull
public Questionnaire setDescriptionHTML(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

isDescriptionIncludesHtmlTags

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

setDescriptionIncludesHtmlTags

@Nonnull
public Questionnaire setDescriptionIncludesHtmlTags(boolean value,
                                                             java.lang.String... args)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDescriptionObsolete

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

setDescriptionObsolete

@Nonnull
public Questionnaire setDescriptionObsolete(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getDescriptionTEXT

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

setDescriptionTEXT

@Nonnull
public Questionnaire setDescriptionTEXT(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

hasPreferredQuestions

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

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 Questionnaire setHelpItem(com.aspc.dal.dbobj.help.DBHelpItem value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getMeta

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

setMeta

@Nonnull
public Questionnaire setMeta(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getNotes

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

setNotes

@Nonnull
public Questionnaire setNotes(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getNumQuestions

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

getPlugin

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

setPlugin

@Nonnull
public Questionnaire setPlugin(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getThankYouHTML

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

setThankYouHTML

@Nonnull
public Questionnaire setThankYouHTML(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getTitle

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

setTitle

@Nonnull
public Questionnaire setTitle(java.lang.String 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 Questionnaire setToolTip(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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

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

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

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

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