com.sri.emo.wizard.completion.persistence
Class CompletionDetails

java.lang.Object
  com.jcorporate.expresso.core.dataobjects.BaseDataObject
      com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject
          com.jcorporate.expresso.core.dbobj.DBObject
              com.jcorporate.expresso.core.dbobj.SecuredDBObject
                  com.jcorporate.expresso.core.dbobj.SecurDBObject
                      com.sri.emo.wizard.completion.persistence.CompletionDetails

All Implemented Interfaces:

Cacheable, ContextNested, DataObject, Securable, LookupInterface, Serializable

public class CompletionDetails
extends SecurDBObject

Per-Part Details of the Completion Wizards.

Version:

1.0

Author:

Michael Rimov

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jcorporate.expresso.core.dbobj.DBObject

DBObject.FieldError, DBObject.FieldUpdate

Field Summary

static String	COMPLETION_FIXED Completion wizard use fixed constant.
static String	COMPLETION_WIZARD Completion method use wizard constant.
static String	FLD_COMPLETION Field Completion Type
static String	FLD_DIRECTIVE Constant for acces to field 'Directive'
static String	FLD_FREETEXT Constant for access to field 'Is FreeText'
static String	FLD_HELPTEXT Constant fo access ot field 'Help Text';
static String	FLD_MAX_ENTRIES Constant for access to field 'Max Entries'
static String	FLD_MIN_ENTRIES Constant for access to field 'Min Entries'
static String	FLD_PART_ID Constant for access to field 'Part Id'
static String	FLD_PART_ORDER
static String	FLD_SINGLE_ENTRY Field for single entry.
static String	FLD_SURROGATE_KEY Constant for access to field 'Completion Details Number'.
static String	FLD_WIZARD_ID Constant for access to field 'Wizard Id'
static String	TABLE_NAME Table Name

Fields inherited from class com.jcorporate.expresso.core.dbobj.SecuredDBObject

ADD, ALL_FUNCTIONS, CACHE_NAME, CACHE_TTY, DELETE, SEARCH, SYSTEM_ACCOUNT_NAME, UPDATE

Fields inherited from class com.jcorporate.expresso.core.dbobj.DBObject

ATTRIBUTE_ERROR, ATTRIBUTE_ERROR_MESSAGE, ATTRIBUTE_PAGE_LIMIT, BIG_DECIMAL_ZERO, CACHE_LIMIT_PERCENT, CACHE_LIMIT_TTL, EMAIL_MASK, EVENT_ADD, EVENT_DELETE, EVENT_UPDATE, FLOAT_MASK, INT_MASK, IS_CHECK_RELATIONAL_INTEGRITY, IS_MUTABLE, sCacheStats, UPDATE_CHANGED_ONLY, WHERE_KEYWORD

Fields inherited from class com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject

anyFieldsDistinct, anyFieldsToInput, anyFieldsToRetrieve, appendCustomWhere, caseSensitiveQuery, customWhereClause, dbKey, distinctFields, inputFields, localConnection, LONGBINARY_READ_DEFAULT_SIZE, maxRecords, myClassName, myUpdates, offsetRecord, recordSet, retrieveFields, sMetadataMap, sortKeys

Fields inherited from class com.jcorporate.expresso.core.dataobjects.BaseDataObject

currentStatus, globalMask

Fields inherited from interface com.jcorporate.expresso.core.dataobjects.Securable

SYSTEM_ACCOUNT

Fields inherited from interface com.jcorporate.expresso.core.dataobjects.DataObject

STATUS_CURRENT, STATUS_DELETED, STATUS_NEW, STATUS_UPDATED

Constructor Summary

CompletionDetails()
Default constructor to create a new object.

CompletionDetails(DBConnection newConnection)
Constructor that takes a DBConnection for use inside a transaction.

CompletionDetails(ReadOnlyUser readOnlyUser)
Constructor taht takes a ReadOnlyUser security context.

Method Summary

Part	getPart() Retrieve the part.
Vector	getValidValues(String fieldName) New method to replace getValues with a structure of valid values and descriptions.
protected void	setupFields() Method to set up the fields for this database object.

Methods inherited from class com.jcorporate.expresso.core.dbobj.SecuredDBObject

add, canRequesterAdd, canRequesterDelete, canRequesterRead, canRequesterUpdate, checkAllowed, copyAttributes, count, createSecurityCache, delete, deleteAll, find, getRequestingUid, getRequestingUser, getString, getString, getString, getString, getString, getString, getSystemUid, instantiate, isAllowed, retrieve, search, searchAndRetrieveList, searchAndRetrieveList, setRequestingUid, setRequestingUser, update

Methods inherited from class com.jcorporate.expresso.core.dbobj.DBObject

addDetail, addField, addField, addFieldError, addFoundKeys, addIfNeeded, addIndex, addKey, addMaster, addOrUpdate, addSortKey, addTransition, addVirtualField, addVirtualField, addVirtualField, addVirtualField, average, basicAdd, cacheIsChangedComparison, canUseRetrieve, checkAllReferredToBy, checkAllRefs, checkAllRefsPublic, checkDeleteDetailPerm, checkField, checkMutable, checkRef, checkRef, clear, clearDistinctFields, clearError, clearFieldsToInput, clearFieldsToRetrieve, clearSortKeys, clone, containsWildCards, copyAllFields, delete, deleteAll, deleteDetails, denotesRange, equals, fetchImmut, fetchImmutable, forKey, formatDateTime, get, getAllAttributes, getAttribute, getAttributesIterator, getBooleanFieldValue, getCacheSize, getCacheStatsMap, getCacheUtil, getCheckZeroUpdate, getCustomWhereClause, getDataContext, getDataField, getDataTransferObject, getDBName, getDetails, getDistinctFieldCount, getDistinctFields, getField, getFieldAttributesIterator, getFieldBigDecimal, getFieldBoolean, getFieldByte, getFieldByteArray, getFieldData, getFieldDate, getFieldDecimalFormatted, getFieldDouble, getFieldErrorMessage, getFieldFloat, getFieldInt, getFieldLong, getFieldMetaData, getFieldShort, getFieldsToInputCount, getFieldsToRetrieveCount, getFilterClass, getFoundCount, getFoundKeysArray, getIndexArray, getISOValuesDefault, getISOValuesDefault, getISOValuesDefault, getKey, getKeyFieldListIterator, getLength, getLengthInt, getLocale, getLogger, getLookupObject, getMax, getMax, getMaxRecords, getMyKeys, getMyUpdatesArray, getOffsetRecord, getPatternMatcher, getPrecision, getSerializedForm, getSizeEstimate, getStringFilter, getThisDBbj, getThisDBObj, getValidValueDescrip, getValidValuesList, getValues, getValuesDefault, getValuesDefault, getValuesDefault, hasError, hasErrors, haveAllKeys, initialize, isCached, isChanged, isDistinct, isEmpty, isFieldDistinct, isFieldNull, isFieldsToInput, isFieldsToRetrieve, isFieldToRetrieve, isMultiValued, isMutable, isMutable, isReadOnly, isSecret, isVirtual, loadFromConnection, logChange, max, min, newInstance, noNewLine, noQuotes, notifyListeners, populateDefaultValues, referredToBy, removeAttribute, removeFromCache, retrieveFromCache, saveBinaryField, search, set, setAttribute, setCacheLimit, setCacheLimit, setCacheLimitAsPercent, setCacheSize, setCharset, setCheckZeroUpdate, setConnection, setConnection, setCustomWhereClause, setCustomWhereClause, setDataContext, setDataField, setDataTransferObject, setDefaultValue, setDescription, setField, setField, setField, setField, setField, setField, setField, setField, setField, setField, setFieldData, setFieldData, setFieldDistinct, setFieldsToInput, setFieldsToRetrieve, setFilterClass, setFilterClass, setKey, setKeys, setLocale, setLookupField, setLookupObject, setMask, setMaxRecords, setMultiValued, setName, setOffsetRecord, setReadOnly, setSchema, setSecret, setSortKey, setStringFilter, setStringFiltersOnAll, setTargetDbSchema, setTargetTable, sqlAggrFunction, sum, toDebugString, update, updateAll, updateAll, updateIsChanged, verify

Methods inherited from class com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject

addInParam, addOutParam, buildWhereClause, buildWhereClauseBuffer, checkZeroUpdate, constructNewMetaData, createAndExecuteSearch, createAndRunStoreProcedure, createSQLSelectStatement, createSQLSelectStatement, getConnectionPool, getCustomStringFieldValue, getDef, getDistinctFieldArrayList, getExecutor, getFieldsToInputIterator, getFieldsToRetrieveIterator, getJDBCMetaData, getJDBCUtil, getLocalConnection, getMappedDataContext, getMetaData, getQueryInterface, getSerialForm, loadFromConnection, makeLimitationStub, quoteIfNeeded, runStoredProcedure, runStoredProcedureAndRetrieveList, selectFieldString, setCaseSensitiveQuery, setDBConnectionPool, setDBName, setMappedDataContext, setOriginalDBName, setTargetStoreProcedure

Methods inherited from class com.jcorporate.expresso.core.dataobjects.BaseDataObject

getGlobalMask, getStatus, isGlobalMasked, setFieldsWithDefaults, setGlobalMask, setStatus

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jcorporate.expresso.core.dataobjects.Securable

getRequestingUid, isAllowed, setRequestingUid, setRequestingUser

Field Detail

FLD_SURROGATE_KEY

public static final String FLD_SURROGATE_KEY

Constant for access to field 'Completion Details Number'.

See Also:

Constant Field Values

FLD_WIZARD_ID

public static final String FLD_WIZARD_ID

Constant for access to field 'Wizard Id'

See Also:

Constant Field Values

TABLE_NAME

public static final String TABLE_NAME

Table Name

See Also:

Constant Field Values

FLD_PART_ID

public static final String FLD_PART_ID

Constant for access to field 'Part Id'

See Also:

Constant Field Values

FLD_PART_ORDER

public static final String FLD_PART_ORDER

See Also:

Constant Field Values

FLD_FREETEXT

public static final String FLD_FREETEXT

Constant for access to field 'Is FreeText'

See Also:

Constant Field Values

FLD_MIN_ENTRIES

public static final String FLD_MIN_ENTRIES

Constant for access to field 'Min Entries'

See Also:

Constant Field Values

FLD_MAX_ENTRIES

public static final String FLD_MAX_ENTRIES

Constant for access to field 'Max Entries'

See Also:

Constant Field Values

FLD_DIRECTIVE

public static final String FLD_DIRECTIVE

Constant for acces to field 'Directive'

See Also:

Constant Field Values

FLD_HELPTEXT

public static final String FLD_HELPTEXT

Constant fo access ot field 'Help Text';

See Also:

Constant Field Values

FLD_COMPLETION

public static final String FLD_COMPLETION

Field Completion Type

See Also:

Constant Field Values

FLD_SINGLE_ENTRY

public static final String FLD_SINGLE_ENTRY

Field for single entry.

See Also:

Constant Field Values

COMPLETION_FIXED

public static final String COMPLETION_FIXED

Completion wizard use fixed constant.

COMPLETION_WIZARD

public static final String COMPLETION_WIZARD

Completion method use wizard constant.

Constructor Detail

CompletionDetails

public CompletionDetails()
                  throws DBException

Default constructor to create a new object.

Throws:

DBException - upon construction error.

CompletionDetails

public CompletionDetails(DBConnection newConnection)
                  throws DBException

Constructor that takes a DBConnection for use inside a transaction.

Parameters:

newConnection - DBConnection the transaction connection.

Throws:

DBException - upon construction error.

CompletionDetails

public CompletionDetails(ReadOnlyUser readOnlyUser)
                  throws DBException

Constructor taht takes a ReadOnlyUser security context. This is most often set by the default constructor, so you only want to do this if you want to use special security permissions (such as Admin or SuperUser)

Parameters:

readOnlyUser - ReadOnlyUser the ReadOnlyUser instance.

Throws:

DBException - upon construction error.

Method Detail

getPart

public Part getPart()
             throws DBException

Retrieve the part.

Returns:

Part

Throws:

DBException

setupFields

protected void setupFields()
                    throws DBException

Method to set up the fields for this database object.

Overrides:

setupFields in class DBObject

Throws:

DBException - If there is an error setting up the fields as requested. For example, if a field allowing null is requested as part of the key

getValidValues

public Vector getValidValues(String fieldName)
                      throws DBException

New method to replace getValues with a structure of valid values and descriptions.

Overrides:

getValidValues in class DBObject

Parameters:

fieldName - The name of the fields for which a value set is requested

Returns:

A Vector of ValidValue objects

Throws:

DBException - upon error.