planetj.database.possiblevalues
Class PossibleValueRow

java.lang.Object
  planetj.database.Row
      planetj.database.possiblevalues.PossibleValueRow

All Implemented Interfaces:

java.lang.Cloneable, IActionObject, IBatchProcessObject, IBusinessObject, ICSVRow, IFDFObject, IGuarded, INamedCollection, INavigationObject, IPossibleValue, IRowCreator, IXMLObject, java.io.Serializable

public class PossibleValueRow

extends Row

implements IPossibleValue

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Row

Row.SpacingRow

Field Summary

Fields inherited from class planetj.database.Row

className, DISPLAY_ORDER_COMPARATOR, MODE_COPY, MODE_DELETE, MODE_INSERT, MODE_READ, MODE_SEARCH, MODE_UNKNOWN, MODE_UPDATE

Fields inherited from interface planetj.database.possiblevalues.IPossibleValue

DISPLAY_ORDER, DISPLAY_VALUE, DISPLAY_VALUE_SQL_TYPE, ERROR_MESSAGE_KEY_DELETE, ERROR_MESSAGE_KEY_INSERT, ERROR_MESSAGE_KEY_UPDATE, FIELD_NAME, KEY, LIBRARY_NAME, OWNER_ID, POSSIBLE_VALUES_TABLE_NAME, SYSTEM_ALIAS, TABLE_NAME, TYPE, TYPE_CONFIG_PROPERTY, TYPE_POSSIBLE_VALUE, TYPE_USER_MESSAGE, USER_MESSAGE_KEY_DELETE, USER_MESSAGE_KEY_INSERT, USER_MESSAGE_KEY_UPDATE, VALUE

Fields inherited from interface planetj.dataengine.security.IGuarded

TYPE_ID_UNKNOWN, TYPE_NAME_FIELD, TYPE_NAME_SQLOPERATION, TYPE_SECURED_BY_LEVEL, TYPE_SECURED_BY_OPERATION, TYPE_UNSECURED

Constructor Summary

PossibleValueRow()

Method Summary

java.lang.String	getAlias() Returns the possible value system alias for the field.
java.lang.String	getDeleteConfirmationMessage() Get the delete confirmation message.
java.lang.String	getDisplayValue() Returns the possible display value for the value.
int	getDisplayValueSQLType() Returns the possible value's value sql type.
java.lang.String	getExternalName(java.lang.String fieldName) Gets the external name of a field
java.lang.String	getFieldFieldSetName(Field field) Gets the name of the given Field's FieldSet NOTE: This method will not get called unless you override the isUseRowForFieldSets method to return true.
java.lang.String	getFieldName() Returns the possible value field for the field.
java.lang.String	getKey() Returns the possible value key for the field.
java.util.List	getKeyFields() Returns the key fields for this Row.
java.lang.String	getLibrary() Returns the possible value library for the field.
java.lang.String	getNameOfTable() Returns the possible value table for the field.
java.lang.String	getPossibleValuesKey(Field field) Gets the possible values key for the given field
int	getType() Returns the possible value type the field.
java.lang.String	getValue() Returns the possible value for the field.
boolean	isFieldApplicable(Field fld, ExecutingContext ec) Tests if a field is applicable in the current scenario
boolean	isFieldDisplayable(Field field, ExecutingContext ec) Check to see if this Field is displayable.
boolean	isFieldRequired(Field field, ExecutingContext pContext) Tests if a field is required or not.
boolean	isUserMessage()
boolean	isUseRowForFieldSets() Check to see if the row should be used to obtain field sets.
void	setAlias(java.lang.String sysAlias) Sets the possible values system alias.
void	setDisplayValue(java.lang.String dspValue) Sets the possible value's display value field.
void	setDisplayValueSQLType(int sqlType) Sets the possible value's value sql type.
void	setFieldName(java.lang.String fldNam) Sets the possible values field name.
void	setKey(java.lang.String key) Sets the possible values key.
void	setLibraryName(java.lang.String libNam) Sets the possible values lirary name.
void	setOwnerId(int value) Sets the ID of this application's owner
void	setOwnerId(java.lang.Integer value) Sets the ID of this application's owner
void	setTableName(java.lang.String tblNam) Sets the possible values table name.
void	setType(int type) Sets the possible values type.
void	setValue(java.lang.String value) Sets the possible value's value field.
boolean	validate(ExecutingContext context) Validate this Row based on it's configuration and field values.

Methods inherited from class planetj.database.Row

add, add, addObject, addPropertyChangeListener, addPropertyChangeListener, addRowEventListener, addRowEventListeners, addTable, addToRowCollection, appendDisplayType, batchProcess, clearFields, clearTables, clearValidationException, clone, cloneRow, commitFieldValues, commitFieldValues, commitFieldValues, concatenateFieldFullLengthValues, concatenateFieldValues, containsField, copy, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonUsageIds, copyIntoRowFieldsWithGivenFieldNames, copyIntoRowFieldsWithGivenFieldNames, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, createAction, createNamedActionRequest, createRow, defaultMerge, delete, delete, delete, delete, deleteObject, divide, duplicateKey, duplicateKey, equals, equals, equalsInstance, fieldHasPossibleValuesSQLOperation, getActionDefaultLocation, getActionDescriptor, getActionRequest, getActionRequest, getActions, getActionsForFields, getActionsForOperation, getAssociation, getAssociation, getAssociationByOperationUsageId, getAssociationOperation, getAttribute, getBackgroundColor, getChangedFields, getChildren, getColumnSpan, getCompleteRow, getCompleteRow, getConfigProperty, getCopiedFieldValues, getCreationContext, getCSVRow, getCSVRow, getDatabaseRow, getDatabaseRow, getDatabaseRow, getDatabaseRow, getDBSystem, getDeleteConfirmation, getDisjointRowClass, getDisplayValue, getDisplayValueByUsageId, getDisplayValueForKey, getErrorMessageForOperation, getExternalNames, getFDFData, getFDTable, getField, getField, getField, getFieldAssociationOperation, getFieldDefaultValue, getFieldDescriptor, getFieldDescriptor, getFieldDescriptor, getFieldDescriptorsWithUsage, getFieldDescriptorsWithUsageId, getFieldDescriptorWithUsageId, getFieldDisplayComponent, getFieldDisplayOrder, getFieldDisplayValue, getFieldDisplayValue, getFieldExternalName, getFieldFieldClassParameters, getFieldIncrementor, getFieldNames, getFieldNames, getFieldPossibleValues, getFields, getFields, getFieldSearchDefaultValue, getFieldSets, getFieldSQLObject, getFieldStatusChange, getFieldsToDisplay, getFieldsToDisplayStrict, getFieldsToDisplayStrict, getFieldStyleClass, getFieldsWithUsageId, getFieldUsageIds, getFieldValue, getFieldValueWithUsageId, getFieldWithUsageId, getHeaderText, getHorizontalAlignment, getJSPFor, getKeyFieldNames, getKeyFields, getLibraryName, getMaxFieldLengths, getMaxFieldLengths, getMaxInsertRetries, getMetaDataSystemAlias, getNamed, getNamed, getNamesOfUpdatedFields, getNavigationKey, getNavigationListKey, getNextOperationToRun, getOperation, getOperation, getPercentage, getPhysicalFieldNames, getPossibleValueClass, getPossibleValueClass, getPossibleValues, getPossibleValuesOperation, getPropertyGroup, getPropertyGroups, getPropertyGroups, getReplacementFieldsToDisplay, getReplacementFieldsToDisplay, getRequiredFields, getRowCollection, getRowDisplayAttributes, getRowDisplayAttributes, getRowHandledActionNames, getRowKey, getSecuredTypeId, getSecuredTypeName, getSecurityType, getSQL, getSQLContext, getStaticAttribute, getSum, getSystemAlias, getTabbedOperation, getTable, getTable, getTableName, getTables, getTimestamp, getUpdatedFields, getUserMessageForOperation, getUserMessageForOperation, getUseWOWLibrary, getValidationExceptions, getValueAsBoolean, getValueAsByte, getValueAsDate, getValueAsDate, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsNumber, getValueAsShort, getValueAsString, getValueAsString, getValueAsStringByUsageId, getValueByUsageId, getValueForKey, getValues, getXMLData, getXMLData, getXMLHeaderData, goToNextOperation, handleAction, hasAssociationOperation, hasChildRows, hasMultipleStyleClasses, hasPossibleValuesKeyClassOrOp, hasPossibleValuesOperation, hasPropertyChangeListeners, insert, insert, insert, insert, is, isActionApplicable, isActionRepeatable, isARow, isARowCollection, isChanged, isChanged, isChangedRealTime, isChangedSinceLastCheck, isCloneNeeded, isContainsAllFields, isCopyable, isCurrent, isDeletable, isDistinctRow, isEditable, isEmpty, isFieldAuthorizedForEdit, isFieldAuthorizedForRead, isFieldAutoIncrement, isFieldPresent, isFieldReadOnly, isFieldReadOnlyOnSearch, isFieldRequiredOnSearch, isFieldsChanged, isFieldUpdateable, isFieldValueNotBlank, isFieldValuePossibleValue, isFieldValuesDatabaseDefaults, isGenerateChildRows, isGroupByRow, isGuarded, isHasColumnNames, isInARowCollection, isIncrementorResetAfterMaxInsertRetries, isInitializeDerivedFieldEnabled, isInitializeDerivedFieldsEnabled, isJoinedRow, isKeyFieldsPresent, isLogicalRow, isMultipleDeleteEnabled, isParameterRow, isPersistent, isPhysicalRow, isPrepareFieldValue, isPropertyChangeEventsEnabled, isReturningFromPossibleValuesSearch, isRowDisplayable, isRowKeyed, isSelectable, isStatusChange, isToBeSelected, isUnionRow, isUpdateable, isValidateDerivedFields, isValidateRequired, isValidationRequiredForAutoPopulate, isViewable, iterator, merge, newField, newField, newField, newField, openFor, persist, populate, postCreate, postExtract, prepareForDetails, prepareForParameters, prepareForResultsDisplay, prepareFromFieldNames, removeField, removeField, removeNavigationKey, removePropertyChangeListener, removePropertyChangeListener, removeRowEventListener, removeRowEventListeners, replaceField, replaceFieldValues, reread, rereadIfNeeded, resetDisplayValues, rollbackChanges, setAttribute, setCreationContext, setFieldInitialValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValueAsString, setFieldValueAsString, setFieldValuesAsDate, setFieldValuesToDefault, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonUsageIds, setFieldValueToDefault, setMultipleDeleteEnabled, setNavigationKey, setParameterRow, setPersistent, setPropertyChangeEventsEnabled, setPropertyGroups, setReturningFromPossibleValuesSearch, setRowDisplayAttributes, setSavepoint, setSavepoint, setSavepoint, setStaticAttribute, setTables, setTables, setUseWOWLibrary, setValidateDerivedFields, setValidateRequired, setValues, size, splitAndSetFieldValues, statusChanged, swapFieldValues, toCSV, toDOC, toDOC, toFDF, toPDF, toPDF, toString, toUpperCase, toXML, transferDataTo, transferDataTo, update, update, update, update, updateFieldValues, updateGlobalValues, updateObject, validate, validate, validateRowOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

PossibleValueRow

public PossibleValueRow()

Method Detail

setOwnerId

public void setOwnerId(int value)
                throws CMException

Sets the ID of this application's owner

Throws:

CMException

setOwnerId

public void setOwnerId(java.lang.Integer value)
                throws CMException

Sets the ID of this application's owner

Throws:

CMException

getAlias

public java.lang.String getAlias()
                          throws CMException

Returns the possible value system alias for the field.

Returns:

String

Throws:

CMException

getDeleteConfirmationMessage

public java.lang.String getDeleteConfirmationMessage()

Description copied from class: Row

Get the delete confirmation message.

Overrides:

getDeleteConfirmationMessage in class Row

getDisplayValue

public java.lang.String getDisplayValue()
                                 throws CMException

Returns the possible display value for the value.

Returns:

String

Throws:

CMException

getDisplayValueSQLType

public int getDisplayValueSQLType()
                           throws CMException

Returns the possible value's value sql type.

Returns:

int

Throws:

CMException

getFieldName

public java.lang.String getFieldName()
                              throws CMException

Returns the possible value field for the field.

Returns:

String

Throws:

CMException

getKey

public java.lang.String getKey()
                        throws CMException

Returns the possible value key for the field.

Returns:

String

Throws:

CMException

getLibrary

public java.lang.String getLibrary()
                            throws CMException

Returns the possible value library for the field.

Returns:

String

Throws:

CMException

getNameOfTable

public java.lang.String getNameOfTable()
                                throws CMException

Returns the possible value table for the field.

Returns:

String

Throws:

CMException

getPossibleValuesKey

public java.lang.String getPossibleValuesKey(Field field)
                                      throws CMException

Gets the possible values key for the given field

Overrides:

getPossibleValuesKey in class Row

Throws:

CMException

getType

public int getType()

Returns the possible value type the field.

Returns:

int

getValue

public java.lang.String getValue()
                          throws CMException

Returns the possible value for the field.

Returns:

String

Throws:

CMException

setAlias

public void setAlias(java.lang.String sysAlias)
              throws CMException

Sets the possible values system alias.

Parameters:

sysAlias - String

Throws:

CMException

setDisplayValue

public void setDisplayValue(java.lang.String dspValue)
                     throws CMException

Sets the possible value's display value field.

Throws:

CMException

setDisplayValueSQLType

public void setDisplayValueSQLType(int sqlType)
                            throws CMException

Sets the possible value's value sql type.

Parameters:

sqlType - int

Throws:

CMException

setFieldName

public void setFieldName(java.lang.String fldNam)
                  throws CMException

Sets the possible values field name.

Parameters:

fldNam - String

Throws:

CMException

setKey

public void setKey(java.lang.String key)
            throws CMException

Sets the possible values key.

Parameters:

key - String

Throws:

CMException

setLibraryName

public void setLibraryName(java.lang.String libNam)
                    throws CMException

Sets the possible values lirary name.

Parameters:

libNam - String

Throws:

CMException

setTableName

public void setTableName(java.lang.String tblNam)
                  throws CMException

Sets the possible values table name.

Parameters:

tblNam - String

Throws:

CMException

setType

public void setType(int type)
             throws CMException

Sets the possible values type.

Parameters:

type - int

Throws:

CMException

setValue

public void setValue(java.lang.String value)
              throws CMException

Sets the possible value's value field.

Parameters:

value - String

Throws:

CMException

validate

public boolean validate(ExecutingContext context)
                 throws CMException

Validate this Row based on it's configuration and field values.

Overrides:

validate in class Row

Returns:

true, if Row and Fields are valid; false otherwise.

Throws:

CMException

isUserMessage

public boolean isUserMessage()

getExternalName

public java.lang.String getExternalName(java.lang.String fieldName)
                                 throws CMException

Gets the external name of a field

Overrides:

getExternalName in class Row

Throws:

CMException

getFieldFieldSetName

public java.lang.String getFieldFieldSetName(Field field)

Description copied from class: Row

Gets the name of the given Field's FieldSet NOTE: This method will not get called unless you override the isUseRowForFieldSets method to return true.

Overrides:

getFieldFieldSetName in class Row

isUseRowForFieldSets

public boolean isUseRowForFieldSets()
                             throws CMException

Description copied from class: Row

Check to see if the row should be used to obtain field sets. Subclasses may override to allow field's to have dynamic display order and field set values.

Overrides:

isUseRowForFieldSets in class Row

Throws:

CMException

isFieldRequired

public boolean isFieldRequired(Field field,
                               ExecutingContext pContext)

Description copied from class: Row

Tests if a field is required or not. The default behavior is to ask the FD, but subclasses may override this method and implement a different behavior

Overrides:

isFieldRequired in class Row

Parameters:

field - The whose required status is being tested

pContext - The current executing context which may be null

isFieldDisplayable

public boolean isFieldDisplayable(Field field,
                                  ExecutingContext ec)
                           throws CMException

Description copied from class: Row

Check to see if this Field is displayable.

Overrides:

isFieldDisplayable in class Row

Parameters:

ec - context in which code is running.

Returns:

true if Field is displayable

Throws:

CMException

isFieldApplicable

public boolean isFieldApplicable(Field fld,
                                 ExecutingContext ec)
                          throws CMException

Description copied from class: Row

Tests if a field is applicable in the current scenario

Overrides:

isFieldApplicable in class Row

Parameters:

fld - The field which may or may not be applicable

Throws:

CMException

getKeyFields

public java.util.List getKeyFields()
                            throws CMException

Description copied from class: Row

Returns the key fields for this Row. If this Row does not contain all keys fields from its tables, then null is returned.

Overrides:

getKeyFields in class Row

Throws:

CMException