com.jcorporate.expresso.services.dbobj
Class ValidationQueue

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.services.dbobj.ValidationQueue

All Implemented Interfaces:

Cacheable, ContextNested, DataObject, LookupInterface, Securable, Serializable

public class ValidationQueue

extends SecuredDBObject

This class stores each validation entry

Author:

Shash Chatterjee

See Also:

Serialized Form

Nested Class Summary

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

DBObject.FieldError, DBObject.FieldUpdate

Field Summary

static String	FLD_ADDED_ON
static String	FLD_EXPIRES_AT
static String	FLD_ID
static String	FLD_PROCESSED_BY
static String	FLD_PROCESSED_ON
static String	FLD_STATUS_CODE
static String	FLD_VAL_CODE
static String	FLD_VAL_HANDLER
static String	JOB_STATUS_AVAILABLE
static String	JOB_STATUS_DENIED
static String	JOB_STATUS_EXPIRED
static String	JOB_STATUS_NEW
static String	JOB_STATUS_VALIDATED
static String	JOB_STATUS_WAIT

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

ADD, ALL_FUNCTIONS, CACHE_NAME, CACHE_TTY, DELETE, SEARCH, SYSTEM_ACCOUNT, 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, EMAIL_MASK, EVENT_ADD, EVENT_DELETE, EVENT_UPDATE, FLOAT_MASK, INT_MASK, IS_CHECK_RELATIONAL_INTEGRITY, UPDATE_CHANGED_ONLY, WHERE_KEYWORD

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

anyFieldsDistinct, anyFieldsToRetrieve, appendCustomWhere, caseSensitiveQuery, customWhereClause, dbKey, distinctFields, 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.DataObject

STATUS_CURRENT, STATUS_DELETED, STATUS_NEW, STATUS_UPDATED

Constructor Summary

ValidationQueue()

ValidationQueue(int uid)
Use over (String) constructor.

ValidationQueue(RequestContext request)
For using DBObjects within Controllers.

Method Summary

void	add() Extends the usual add method to fetch a next number field and set the Updated flag to Y
protected void	checkAllRefs() Extends the checkAllRefs method to check for valid job queue entry
boolean	find() Extend the normal find method to read the parameters once the find is done.
Vector	getParams() Get the job queue parameters associated with this queue entry
String	getParamValue(String paramCode) Get the parameter value for the named parameter code
Vector	getValidValues(String fieldName) Override the method getValidValues to provide specific values for our multi-valued fields
boolean	isExpired() Returns true if the validation queue entry has expired by checking the expires at field.
void	retrieve() Extend the normal retrieve method to read the parameters after the record is retrieved
protected void	setupFields() Method to set up the fields for this database object.

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

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

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

addDetail, addField, addField, addFieldError, addFoundKeys, addIfNeeded, addIndex, addKey, addOrUpdate, addSortKey, addTransition, addVirtualField, addVirtualField, addVirtualField, addVirtualField, average, basicAdd, cacheIsChangedComparison, checkAllReferredToBy, checkAllRefsPublic, checkDeleteDetailPerm, checkField, checkRef, checkRef, clear, clearDistinctFields, clearError, clearFieldsToRetrieve, clearSortKeys, containsWildCards, delete, deleteAll, deleteDetails, denotesRange, equals, forKey, formatDateTime, get, getAllAttributes, getAttribute, getAttributesIterator, getBooleanFieldValue, getCacheSize, getCacheStatsMap, getCacheUtil, getCheckZeroUpdate, getCustomWhereClause, getDataContext, getDataField, getDataTransferObject, getDBName, getDetails, getDistinctFieldCount, getDistinctFields, getField, getFieldBigDecimal, getFieldBoolean, getFieldByte, getFieldByteArray, getFieldData, getFieldDate, getFieldDecimalFormatted, getFieldDouble, getFieldErrorMessage, getFieldFloat, getFieldInt, getFieldLong, getFieldMetaData, getFieldShort, getFieldsToRetrieveCount, getFilterClass, getFoundCount, getFoundKeysArray, getIndexArray, getISOValuesDefault, getISOValuesDefault, getISOValuesDefault, getKey, getKeyFieldListIterator, getLength, getLengthInt, getLocalConnection, getLocale, getLogger, getLookupObject, getMax, getMax, getMaxRecords, getMyKeys, getMyUpdatesArray, getOffsetRecord, getPatternMatcher, getPrecision, getSerializedForm, getStringFilter, getThisDBbj, getThisDBObj, getValidValueDescrip, getValidValuesList, getValues, getValuesDefault, getValuesDefault, getValuesDefault, hasError, hasErrors, haveAllKeys, initialize, isCached, isChanged, isDistinct, isEmpty, isFieldDistinct, isFieldNull, isFieldsToRetrieve, isFieldToRetrieve, isMultiValued, isReadOnly, isSecret, isVirtual, loadFromConnection, logChange, max, min, newInstance, noNewLine, noQuotes, notifyListeners, populateDefaultValues, referredToBy, removeAttribute, removeFromCache, retrieveFromCache, saveBinaryField, search, set, setAttribute, 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, setFieldsToRetrieve, setFilterClass, setFilterClass, setKeys, setLocale, setLookupField, setLookupObject, setMask, setMaxRecords, setMultiValued, setName, setOffsetRecord, setReadOnly, setSchema, setSecret, setSortKey, setStringFilter, setStringFiltersOnAll, setTargetDbSchema, setTargetTable, sqlAggrFunction, sum, toDebugString, update, updateAll, updateAll, verify

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

addInParam, addOutParam, buildWhereClause, buildWhereClauseBuffer, checkZeroUpdate, constructNewMetaData, createAndExecuteSearch, createAndRunStoreProcedure, getConnectionPool, getCustomStringFieldValue, getDef, getDistinctFieldArrayList, getExecutor, getFieldsToRetrieveIterator, getJDBCMetaData, getJDBCUtil, 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

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

Field Detail

FLD_ID

public static final String FLD_ID

See Also:

Constant Field Values

FLD_STATUS_CODE

public static final String FLD_STATUS_CODE

See Also:

Constant Field Values

FLD_ADDED_ON

public static final String FLD_ADDED_ON

See Also:

Constant Field Values

FLD_EXPIRES_AT

public static final String FLD_EXPIRES_AT

See Also:

Constant Field Values

FLD_PROCESSED_ON

public static final String FLD_PROCESSED_ON

See Also:

Constant Field Values

FLD_PROCESSED_BY

public static final String FLD_PROCESSED_BY

See Also:

Constant Field Values

FLD_VAL_CODE

public static final String FLD_VAL_CODE

See Also:

Constant Field Values

FLD_VAL_HANDLER

public static final String FLD_VAL_HANDLER

See Also:

Constant Field Values

JOB_STATUS_NEW

public static final String JOB_STATUS_NEW

See Also:

Constant Field Values

JOB_STATUS_AVAILABLE

public static final String JOB_STATUS_AVAILABLE

See Also:

Constant Field Values

JOB_STATUS_WAIT

public static final String JOB_STATUS_WAIT

See Also:

Constant Field Values

JOB_STATUS_VALIDATED

public static final String JOB_STATUS_VALIDATED

See Also:

Constant Field Values

JOB_STATUS_DENIED

public static final String JOB_STATUS_DENIED

See Also:

Constant Field Values

JOB_STATUS_EXPIRED

public static final String JOB_STATUS_EXPIRED

See Also:

Constant Field Values

Constructor Detail

ValidationQueue

public ValidationQueue()
                throws DBException

See Also:

SecuredDBObject

ValidationQueue

public ValidationQueue(RequestContext request)
                throws DBException

For using DBObjects within Controllers. Initializes based upon the current user and the requested db. [Of course this can be modified later]

Parameters:

request - - The controller request handed to you by the framework.

Throws:

DBException - upon initialization error

ValidationQueue

public ValidationQueue(int uid)
                throws DBException

Use over (String) constructor. Initializes the object in the context of the user who's uid belongs to the parameter.

Parameters:

uid - id of the user context

Throws:

DBException - if there's an initialization problem

Method Detail

add

public void add()
         throws DBException

Extends the usual add method to fetch a next number field and set the Updated flag to Y

Specified by:

add in interface DataObject

Overrides:

add in class SecuredDBObject

Throws:

DBException - If the next number cannot be determined or the add fails

checkAllRefs

protected void checkAllRefs()
                     throws DBException

Extends the checkAllRefs method to check for valid job queue entry

Overrides:

checkAllRefs in class DBObject

Throws:

DBException - If a referential integrity violation is found

find

public boolean find()
             throws DBException

Extend the normal find method to read the parameters once the find is done.

Specified by:

find in interface DataObject

Overrides:

find in class SecuredDBObject

Returns:

boolean

Throws:

DBException - if search is not allowed

getParams

public Vector getParams()
                 throws DBException

Get the job queue parameters associated with this queue entry

Returns:

Vector A vector of JobQueueParam objects for this entry

Throws:

DBException - If the job queue entry has not yet been retrieved

getParamValue

public String getParamValue(String paramCode)
                     throws DBException

Get the parameter value for the named parameter code

Parameters:

paramCode - Code for which we want the value

Returns:

String The parameter value

Throws:

DBException - If the paramter value cannot be retrieved

isExpired

public boolean isExpired()
                  throws DBException

Returns true if the validation queue entry has expired by checking the expires at field. If that field is null, then this function will return false.

Returns:

true if the validation queue entry is expired.

Throws:

DBException

getValidValues

public Vector getValidValues(String fieldName)
                      throws DBException

Override the method getValidValues to provide specific values for our multi-valued fields

Overrides:

getValidValues in class DBObject

Parameters:

fieldName - Field name for which values are requested

Returns:

Vector The ValidValues field

Throws:

DBException - If the values cannot be retrieved

retrieve

public void retrieve()
              throws DBException

Extend the normal retrieve method to read the parameters after the record is retrieved

Overrides:

retrieve in class SecuredDBObject

Throws:

DBException - If the parameters or the entry cannot be retrieved

setupFields

protected void setupFields()
                    throws DBException

Description copied from class: DBObject

Method to set up the fields for this database object. This method should be defined in the implementing object and should make calls to addField, addKey, setMultiValued, etc. as required to define the content of the DBObject. Each setupFields method should call "super.setupFields()" so that field definitions can be "inheritcable"

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

See Also:

DBObject.setupFields()