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

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

All Implemented Interfaces:

Cacheable, ContextNested, DataObject, Securable, LookupInterface, AdditionalInfo, Serializable

public class CompletionDefinition
extends SecurDBObject
implements AdditionalInfo

Gateway class to the completion definition. Provides a slightly different definition that wizard

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

List	completionDetails
static String	FLD_ID
static String	FLD_TARGET_NODE
static String	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

CompletionDefinition()
Default constructor to create a new object.

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

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

Method Summary

void	add() Override of add that also adds the completion details as well.
void	addCompletionDetail(CompletionDetails oneDetail) Adds a completion detail to the definition.
List	getCompletionDetails() Retrieve a list of all completion details.
String	getIdField() Attribute to know what the id field of the additional information database object is.
Node	getTargetNode() Retrieve the associated target node.
int	getTargetNodeId() Retrieve the target node id.
WizDefinition	getWizardDefinition() Retrieve the wizard definition.
protected void	setupFields() Method to set up the fields for this database object.
void	setWizardDefinition(WizDefinition definition) Sets the wizard definition.

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

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, getValidValues, 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_ID

public static final String FLD_ID

See Also:

Constant Field Values

FLD_TARGET_NODE

public static final String FLD_TARGET_NODE

See Also:

Constant Field Values

completionDetails

public List completionDetails

TABLE_NAME

public static final String TABLE_NAME

See Also:

Constant Field Values

Constructor Detail

CompletionDefinition

public CompletionDefinition()
                     throws DBException

Default constructor to create a new object.

Throws:

DBException - upon construction error.

CompletionDefinition

public CompletionDefinition(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.

CompletionDefinition

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

getTargetNodeId

public int getTargetNodeId()
                    throws DBException

Retrieve the target node id.

Returns:

int

Throws:

DBException

getTargetNode

public Node getTargetNode()
                   throws DBException

Retrieve the associated target node.

Returns:

Throws:

DBException

setWizardDefinition

public void setWizardDefinition(WizDefinition definition)
                         throws DBException

Sets the wizard definition.

Parameters:

definition - WizDefinition

Throws:

DBException

getWizardDefinition

public WizDefinition getWizardDefinition()
                                  throws DBException

Retrieve the wizard definition.

Returns:

WizDefinition

Throws:

DBException

getCompletionDetails

public List getCompletionDetails()
                          throws DBException

Retrieve a list of all completion details.

Returns:

List java.util.List of CompletionDetail objects.

Throws:

DBException - upon query error.

addCompletionDetail

public void addCompletionDetail(CompletionDetails oneDetail)
                         throws DBException

Adds a completion detail to the definition.

Parameters:

oneDetail - CompletionDetails

Throws:

DBException

add

public void add()
         throws DBException

Override of add that also adds the completion details as well.

Specified by:

add in interface DataObject

Overrides:

add in class SecuredDBObject

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

getIdField

public String getIdField()

Attribute to know what the id field of the additional information database object is.

Specified by:

getIdField in interface AdditionalInfo

Returns:

String

To Do:

Implement this com.sri.emo.dbobj.wizards.AdditionalInfo method