Row

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

planetj.database
Class Row

java.lang.Object
  planetj.database.Row

All Implemented Interfaces:: java.lang.Cloneable, IActionObject, IBatchProcessObject, IBusinessObject, ICSVRow, IFDFObject, IGuarded, INamedCollection, INavigationObject, IRowCreator, IXMLObject, java.io.Serializable

Direct Known Subclasses:: AdvanceToNextOperationRow, AdvanceToOperationRow, ConnectionRow, DEAuthorization, DEGroup, DEGroup2Authorization, DEUser, DEUser2Group, EmailRow, FieldDescriptorRow, FieldValueStyleRow, FlatFileReferenceRow, InitializeFieldsFromSearchRow, MessageBoardRow, MessageRow, PossibleValueRow, PropertyRow, PVSearchRow, ReportBreakRow, RetainSelectionsRow, Row.SpacingRow, SignOnAndRegistrationRow, SignonRow, UserMessageRow, VerisignPaymentRow

public class Row
extends java.lang.Object
implements java.lang.Cloneable, IActionObject, INavigationObject, IBatchProcessObject, IRowCreator, IGuarded, ICSVRow, IBusinessObject, java.io.Serializable, IXMLObject, IFDFObject, INamedCollection

Represents a logical row of a database. A Row object may be a subset (containing only some of the columns) of a row in the database. It may also contain columns from multiple tables of the database. A Row's fields can be obtained via the getFields() method. Changes can be made to a Row object, and then committed to the database with the update() method.

See Also:: Serialized Form

Nested Class Summary
`static class`	`Row.SpacingRow`

Field Summary
`static java.lang.String`	`className`
`static java.util.Comparator`	`DISPLAY_ORDER_COMPARATOR`
`static int`	`MODE_ALTER`
`static int`	`MODE_COPY`
`static int`	`MODE_DELETE`
`static int`	`MODE_INSERT`
`static int`	`MODE_READ`
`static int`	`MODE_SEARCH`
`static int`	`MODE_UNKNOWN`
`static int`	`MODE_UPDATE`
`protected java.util.List`	`mRowEventListeners`

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
`Row()`

Method Summary
`void`	`add(Field pField)` Adds the given Field to this Row's FieldCollection.
`void`	`add(RowCollection pRowCollection)` Adds the given RowCollection to the List of RowCollection's this Row belongs to.
`void`	`addObject()` Add an object to the system.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds a listener which is informed when any field of this Row which has its value changed.
`void`	`addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener)` Adds a listener which is informed when a specific property of this Row which has its value changed.
`void`	`addRowEventListener(IRowEventListener pNewListener)` Adds a new Listener to this Row.
`void`	`addRowEventListeners(java.util.List listeners)`
`void`	`addTable(Table pTable)` Sets the table to which this row belongs.
`int`	`addToRowCollection(RowCollection rc)` Adds this row to a RowCollection.
`java.lang.StringBuffer`	`appendDisplayType(java.lang.StringBuffer sb)` Deprecated. row shouldn't know how to display html stuff - moved logic back into htmltable, eventually we could check the row to see if its property group has a css to use and use that if needed
`void`	`batchProcess()` Process this Object.
`void`	`clearFields()` Removes all the Fiels from this Row.
`void`	`clearTables()` Removes all the Fiels from this Row.
`void`	`clearValidationException()` Clears any validation exceptions that have previously been set on each of this Row's Fields.
`java.lang.Object`	`clone()` Clone this Row object.
`Row`	`cloneRow()` Clones this Row object.
`void`	`commitFieldValues()` Commits the values of the Fields in this Row.
`void`	`commitFieldValues(java.util.Collection pFields)` Commits the values of the Fields in the given Collection.
`void`	`commitFieldValues(java.util.Map pFields)` Commits the values of the Fields in the given Map.
`java.lang.String`	`concatenateFieldFullLengthValues(java.lang.String[] pFieldNames, java.lang.String pSeperator)` Concat the field full length string values inserting the supplied seperator between values.
`java.lang.String`	`concatenateFieldValues(java.lang.String[] pFieldNames, java.lang.String pSeperator, boolean pTrimValues)` Concat the field values inserting the supplied seperator between values and optionally trim the values before concating.
`boolean`	`containsField(java.lang.String fieldName)` Check to see if this Row contains the Field with the given name.
`Row`	`copy(boolean pFullCopy)` Copy this Row.
`void`	`copyIntoRowFieldsWithCommonFieldNames(Row rowToCopy)` Deprecated. replaced with setFieldValuesWithCommonFieldNames(Row)
`void`	`copyIntoRowFieldsWithCommonFieldNames(Row rowToCopy, boolean ignoreCase)` Deprecated. replaced with setFieldValuesWithCommonFieldNames(Row, boolean)
`void`	`copyIntoRowFieldsWithCommonUsageIds(Row rowToCopy)` Copy the fields from the supplied Row with the same usageid into this Row.
`void`	`copyIntoRowFieldsWithGivenFieldNames(java.util.List fieldNames, Row rowToCopy)` Deprecated. replaced with setFieldValuesWithCommonFieldNames(List, Row, boolean)
`void`	`copyIntoRowFieldsWithGivenFieldNames(java.util.List fieldNames, Row rowToCopy, boolean ignoreCase)` Deprecated. replaced with setFieldValuesWithCommonFieldNames(List, Row, boolean)
`static Row`	`create(java.lang.Class rowSubClass)` Create and return a new Row of the given Class type using the given ExecutingContext to allow for security and/or personalization.
`static Row`	`create(java.util.List tables, java.lang.Class rowSubClass, java.util.List fieldNames, boolean initializeRow, ExecutingContext pExecutingContext)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(RowCollection pRowCollection)` Create and return a new Row and also set its Table.
`static Row`	`create(RowCollection pRowCollection, boolean initialRow)` Create and return a new Row and also set its Table.
`static Row`	`create(RowCollection pRowCollection, java.lang.Class rowSubClass)` Create and return a new Row and also set its Table.
`static Row`	`create(RowCollection pRowCollection, java.lang.Class rowSubClass, boolean initialRow)` Create and return a new Row and also set its Table.
`static Row`	`create(SQLContext context, java.util.List fieldNames, boolean initializeRow)` Create and return a new Row from the given SQLContext.
`static Row`	`create(Table table)` Create and return a new Row of class Row.class and initializes the row with all of the tables fields.
`static Row`	`create(Table table, boolean initializeRow)` Create and return a new Row of class Row.class and initializes the row with all of the tables fields if specified.
`static Row`	`create(Table table, boolean initializeRow, ExecutingContext ec)` Create and return a new Row and also set its Table.
`static Row`	`create(Table table, java.lang.Class rowSubClass)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(Table table, java.lang.Class rowSubClass, boolean initializeRow)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(Table table, java.lang.Class rowSubClass, boolean initializeRow, ExecutingContext pExecutingContext)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(Table table, java.lang.Class rowSubClass, ExecutingContext executingContext)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(Table table, java.lang.Class rowSubClass, java.util.List fieldNames, boolean initializeRow)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(Table table, java.lang.Class rowSubClass, java.util.List fieldNames, boolean initializeRow, ExecutingContext pExecutingContext)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(Table table, java.util.List fieldNames, boolean initialize)` Create and return a new Row for the given table and field names.
`static Row`	`create(Table table, java.util.List fieldNames, boolean initializeRow, ExecutingContext pExecutingContext)` Create and return a new Row of the given Class type and also set its Table.
`static Row`	`create(Table table, java.util.List names, ExecutingContext ec)` Create and return a new Row and also set its Table.
`AbstractAction`	`createAction(java.lang.String name, ExecutingContext ec)` Create an action for the given action name.
`AbstractActionRequest`	`createNamedActionRequest(java.lang.String name, ExecutingContext ec)`
`Row`	`createRow(Row pDefaultRow)` Creates a new Row.
`protected SQLContext`	`createSQLContextForDelete(ExecutingContext ec)` Creates a new SQLContext which will be used for deleting this row.
`protected SQLContext`	`createSQLContextForInsert(ExecutingContext ec)` Creates a new SQLContext which will be used for inserting this row.
`protected SQLContext`	`createSQLContextForUpdate(ExecutingContext ec)` Creates a new SQLContext which will be used for updating this row.
`protected void`	`dataTransferred(Row oldRow)` This method is invoked after this row has data transferred to it from another row.
`void`	`defaultMerge(RowCollection rc)` Works similar to the merge method, except all the fields that are merged into this row have the default values for that field type instead of actual values.
`int`	`delete()` Deletes the row from the database file to which it belongs.
`int`	`delete(java.sql.Connection conn)` Deletes the row from the database file to which it belongs.
`int`	`delete(java.sql.Connection conn, ExecutingContext ec)` Deletes the row from the database file to which it belongs.
`int`	`delete(ExecutingContext ec)` Deletes the row from the database file to which it belongs.
`void`	`deleteObject()` Delete an object from the system.
`double`	`divide(java.lang.String fieldName, java.lang.String fieldName2)` Get the division of the first field with the second fields.
`void`	`duplicateKey(ExecutingContext ec)` Method called when a duplicate key is encountered attempting to insert this Row.
`boolean`	`duplicateKey(int retriesLeft, ExecutingContext ec)` Method called when a duplicate key is encountered attempting to insert this Row.
`protected void`	`enforceExclusiveOr(java.util.List fieldNames)` Examines a set of fields in this Row.
`boolean`	`equals(java.lang.Object otherRow)` Tests if this Row is equal to another Row.
`boolean`	`equals(Row row, java.util.List fieldNames)` Tests if a group of fields in this row have the same values as a group of fields in another row
`boolean`	`equalsInstance(java.lang.Object otherRow)` Tests if this Row is equal to another Row.
`boolean`	`fieldHasPossibleValuesSQLOperation(Field pField, ExecutingContext pContext)` Deprecated. replaced with hasPossibleValuesOperation(Field, ExecutingContext) to keep consistancy with similar methods
`protected void`	`firePropertyChange(java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue)` Informs listeners of a property change.
`protected void`	`fireRowEvent(RowEvent pEvent)` Method to support listener events.
`java.lang.String`	`getActionDefaultLocation()` Get the location where this action is to be generated
`ActionDescriptor`	`getActionDescriptor(AbstractAction action)` Get an action descriptor for the given action type and name.
`IActionRequest`	`getActionRequest(AbstractAction action, HttpServletRequest request, HttpServletResponse response)` Get the magic request used to handle a given action.
`IActionRequest`	`getActionRequest(AbstractAction action, java.lang.Object o, HttpServletRequest request, HttpServletResponse response)` Get the magic request used to handle a given action.
`java.util.List`	`getActions(ExecutingContext ec)` Get a List of the actions this object supports.
`java.util.List`	`getActionsForFields(ExecutingContext ec)` Get a List of names of actions handled by this Row.
`java.util.List`	`getActionsForOperation(ExecutingContext ec)` Gets the Operation actions which may apply to this Row.
`java.lang.Object`	`getAssociation(java.lang.String fieldName)` Gets the association for the given Field name.
`java.lang.Object`	`getAssociation(java.lang.String fieldName, ExecutingContext ec)` Gets the association for the given Field name.
`java.lang.Object`	`getAssociationByOperationUsageId(int usageId, ExecutingContext ec)` Gets the association for the given operation usage id.
`Operation`	`getAssociationOperation(java.lang.String fieldName)` Deprecated. use getFieldAssociationOperation(Field)
`java.lang.Object`	`getAttribute(java.lang.Object key)` Map that allows general attributes about a Row to be set and retreived.
`Field`	`getAutoIncrementDatabaseDrivenField(ExecutingContext ec)` Check to see if there is a Field in this Row that is an auto increment field handled by the database.
`java.awt.Color`	`getBackgroundColor(Field field, ExecutingContext ec)` Gets the background color to use when rendering the specified field in a non-HTML way
`java.util.List`	`getChangedFields()` Gets the fields whose values have been changed
`RowCollection`	`getChildren()` Gets a RowCollection of children this Row has.
`int`	`getColumnSpan(Field field, boolean isDetails)` Get the number of columns the given field should take up.
`Row`	`getCompleteRow()` Gets a complete Row for this Row containing all of its Fields in the database.
`Row`	`getCompleteRow(java.sql.Connection pConnection)` Gets a complete Row for this Row containing all of its Fields in using the specified connection if needed.
`protected FieldCollection`	`getConcurrentFields()` Returns a FieldCollection object containing the fields in this row that do not allow for concurrent alterations
`java.lang.Object`	`getConfigProperty(java.lang.String key, ExecutingContext executingContext)` Get a config property for the given row.
`java.util.Map`	`getCopiedFieldValues()` Returns a Map of field values, keyed by field name.
`SQLContext`	`getCreationContext()` Gets the SQL context that was used when creating this Row
`java.util.List`	`getCSVRow()` Returns a List of Fields that implement ICSVField or a list of Objects that provide a toString method which returns the desired text to be written to the CSV file.
`java.util.List`	`getCSVRow(java.util.List fieldNames)` Returns a List of Fields that implement ICSVField or a list of Objects that provide a toString method which returns the desired text to be written to the CSV file.
`Row`	`getDatabaseRow(boolean originalRow, java.sql.Connection conn)` Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database.
`Row`	`getDatabaseRow(boolean originalRow, java.sql.Connection conn, boolean includeDerivedFields)` Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database.
`Row`	`getDatabaseRow(java.sql.Connection conn)` Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database.
`Row`	`getDatabaseRow(java.sql.Connection conn, boolean includeDerivedFields)` Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database.
`DBSystem`	`getDBSystem()` Get the system object this Row.
`java.lang.String`	`getDeleteConfirmation()` Deprecated.
`java.lang.String`	`getDeleteConfirmationMessage()` Get the delete confirmation message.
`java.lang.Class`	`getDisjointRowClass(Table table, int mode, ExecutingContext ec)` Gets the row class which will be used for containing the unjoined data in this row.
`java.lang.String`	`getDisplayValue(java.lang.String fieldName)` Deprecated.
`java.lang.Object`	`getDisplayValueByUsageId(int usageId)` Get a display value from this Row for the given usage id.
`java.lang.Object`	`getDisplayValueForKey(java.lang.Object valueKey)` Get a display value from this row.
`java.lang.String`	`getErrorMessageForOperation(int mode, java.lang.Throwable t)` Return a message to the user after an operation completes.
`java.lang.String`	`getExternalName(java.lang.String fieldName)` Gets the external name of a field
`java.util.List`	`getExternalNames()` Gets the external names of this RowCollection's fields
`java.lang.StringBuffer`	`getFDFData(java.lang.StringBuffer pFDFData)` This returns a StringBuffer containing all necessary FDF data for this object.
`Table`	`getFDTable()` Get's a table to use when searching for FDs.
`Field`	`getField(int pIndex)` Returns the Field at the specified index in this Row.
`Field`	`getField(java.lang.String fieldName)` Returns the Field for the given name, or null if no such Field exists.
`Field`	`getField(java.lang.String name, boolean create)` Get the Field in this Row with the given name.
`Operation`	`getFieldAssociationOperation(Field field)` Gets the association's operation for the given Field
`protected FieldCollection`	`getFieldCollection()` Returns a FieldCollection object containing a List of Field names along with a Map of Fields keyed by Field name.
`java.lang.Object`	`getFieldDefaultValue(Field field, ExecutingContext ec)` Get the field's default value as a String.
`FieldDescriptorRow`	`getFieldDescriptor(Field pField, FieldDescriptorRow pFieldDescriptor)` Row subclasses can override this method to return the a clone of the default FD added by TJH Jun 22, 2004 11 : 49 : 27 PM to allow Rows to return different FDs for this field.
`FieldDescriptorRow`	`getFieldDescriptor(java.lang.String pFieldName)` Return the IFieldDescriptor for the Field with the specified name.
`FieldDescriptorRow`	`getFieldDescriptor(java.lang.String pFieldName, Table pTable)` Return the IFieldDescriptor for the Field with the specified name.
`java.util.List`	`getFieldDescriptorsWithUsage()` Deprecated. ask for fields with usage ids rather than fielddescriptors
`java.util.List`	`getFieldDescriptorsWithUsageId(int usageId)` Deprecated. ask for fields with usage ids rather than fielddescriptors
`FieldDescriptorRow`	`getFieldDescriptorWithUsageId(int usageId)` Deprecated. ask for field with usage ids rather than fielddescriptors
`int`	`getFieldDisplayComponent(java.lang.String fieldName)` Gets the display component which should be used to display the specified field.
`int`	`getFieldDisplayOrder(Field field)` Gets the order of which the given Field will appear in its FieldSet
`java.lang.Object`	`getFieldDisplayValue(Field field)` Returns the display value for the Field with the specified name.
`java.lang.Object`	`getFieldDisplayValue(java.lang.String fldNam)` Returns the display value for the Field with the specified name.
`java.lang.String`	`getFieldExternalName(Field field)` Gets the external name of a field
`java.lang.String[]`	`getFieldFieldClassParameters(Field field)` Gets the parameters for the given 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.
`IFieldIncrementor`	`getFieldIncrementor(Field f)` Gets the incrementor for the field By default, Fields will use the same incrementor for their values.
`int`	`getFieldMaxLength(java.lang.String fieldName)` Get the max length of the Field with the given name.
`java.util.List`	`getFieldNames()` Return a List of all the Field names in this Row.
`java.util.List`	`getFieldNames(Table table)` Gets the names of all fields in this row which are from the specified table.
`RowCollection`	`getFieldPossibleValues(Field fld)` Returns a RowCollection containing the possible values for the Field.
`java.util.List`	`getFields(java.lang.Class pFieldClassType)` Returns a List of Fields for requested Class type.
`java.util.Map`	`getFields(java.util.List pFieldNames)` Returns a Map of Fields in this Row from the names given in the List.
`java.lang.Object`	`getFieldSearchDefaultValue(Field field, ExecutingContext ec)` Gets the default value for the field when it is being used in a search
`java.util.List`	`getFieldSets()` Gets a List of the FieldSet objects, containing the fields in this Row
`protected java.util.Map`	`getFieldsForInsert(ExecutingContext ec)` Gets the fields which should be inserted when this row is inserted.
`java.lang.Object`	`getFieldSQLObject(java.lang.String fieldName)` Gets this field's value as an Object in SQL format.
`int`	`getFieldStatusChange(Field field)` Returns whether or not we notify on a status change for the specified field
`java.util.List`	`getFieldsToDisplay()` Return a List of all the Field names that will be displayed by default.
`java.util.List`	`getFieldsToDisplayStrict(ExecutingContext pEc)` Return a List of all the Field names that will be displayed by default.
`java.util.List`	`getFieldsToDisplayStrict(java.util.List fieldNames, ExecutingContext ec)` Removes fields from the list that should not be displayed.
`java.lang.String`	`getFieldStyleClass(Field field, java.lang.String value, java.lang.String displayValue, ExecutingContext ec)` Get a Field's style.
`java.util.List`	`getFieldsWithUsageId(int usageId)` Get the Fields in this Row that have the specified usage id.
`int[]`	`getFieldUsageIds(Field field)` Gets the usage ids of this field.
`java.lang.Object`	`getFieldValue(java.lang.String pFieldName)` Gets a field in this Row by name.
`java.lang.Object`	`getFieldValueWithUsageId(int usageId)` Gets a field in this Row for the given usage id and returns its value.
`Field`	`getFieldWithUsageId(int usageId)` Get the Field with the given usage id from this row.
`java.lang.String`	`getHeaderText(ExecutingContext ec)` Returns information for the user that will be displayed in the header of the Row
`short`	`getHorizontalAlignment(Field field, ExecutingContext ec)` Gets the alignment for the specified field, when it is rendered in a non-HTML way
`java.lang.String`	`getJSPFor(int mode)` Get the JSP to open for the given mode when going to the Row's detail page.
`java.util.List`	`getKeyFieldNames()`
`java.util.List`	`getKeyFields()` Returns the key fields for this Row.
`java.util.List`	`getKeyFields(boolean returnPartial)` Returns the key fields for this Row.
`java.lang.String`	`getLibraryName()` Returns the Library's name to which the Table belongs to.
`int`	`getMaxFieldLengths()` Returns the max lengths of each field in this row added together.
`int`	`getMaxFieldLengths(FileDescriptor fled)` Returns the max lengths of each field in this row added together.
`int`	`getMaxInsertRetries()` Number of times to attempt to re-insert a Row when a duplicate key exception was encountered.
`java.lang.String`	`getMetaDataSystemAlias()` Returns the meta data alias of the system to which this Row belongs
`INamed`	`getNamed(int i)`
`INamed`	`getNamed(java.lang.String name)`
`java.util.List`	`getNamesOfUpdatedFields()` Return the names of all of the Fields in this Row that have been updated.
`java.lang.String`	`getNavigationKey()` Get the key used to store/retrieve this Row to/from navigation.
`java.lang.String`	`getNavigationListKey()` Get the key used to store and retrieve a List of Rows that have been put into navigation.
`java.lang.Number`	`getNextOperationToRun(Operation currentOp, ExecutingContext context)` Get the next operation number (ID) that is to be run, by default this will return the operations "completed or next operation" as specified in the WOW operation spec.
`Operation`	`getOperation()` Gets the Operation which read this row from the DB.
`Operation`	`getOperation(boolean checkCreationOp)` Gets the Operation which read this row from the DB or created this row.
`protected Operation`	`getOperationFromDB(int pId)` Gets a SQLOperation.
`protected Operation`	`getOperationFromDBByUsage(int usageId)` Get an Operation from the database for teh given usage id.
`double`	`getPercentage(java.lang.String[] fieldNames)` Gets the percentage of the first field compared with all the fields given.
`java.util.List`	`getPhysicalFieldNames()` Gets a List of the names of all Fields in this Row, excluding logical Fields
`java.lang.String`	`getPossibleValueClass(Field field)` Returns the fully qualified name for a class implementing the `IPossibleValueGetter` interface which will handle the retrieving of possible values for the specified field Default behavior is to ask the FD
`java.lang.String`	`getPossibleValueClass(java.lang.String fieldName)` Deprecated. - no longer used, pass in the Field object instead
`RowCollection`	`getPossibleValues(Field fld)` Returns a RowCollection containing the possible values for the Field.
`java.lang.String`	`getPossibleValuesKey(Field field)` Gets the possible values SQLOperation for the specified field
`Operation`	`getPossibleValuesOperation(Field field)` Gets the possible values Operation for the specified field
`protected DataEnginePropertyChangeSupport`	`getPropertyChangeSupport()` Gets the property change support object for this row.
`PropertyGroup`	`getPropertyGroup(java.lang.String groupName)` Gets the first PropertyGroup with the given property group name.
`PropertyGroupList`	`getPropertyGroups()` Get all the property groups stored in this RowCollection's attributes.
`java.util.List`	`getPropertyGroups(java.lang.String groupName)` Get this RowCollection's property groups with the given group name.
`java.util.List`	`getReplacementFieldsToDisplay(java.util.List originalFields)` Get a list of field names to override the original fields to display for this Row.
`java.util.List`	`getReplacementFieldsToDisplay(java.util.List originalFields, ExecutingContext ec)` Get a list of field names to override the original fields to display for this Row.
`java.util.Iterator`	`getRequiredFields()` Iterates through the fields in this Row which are required
`protected Row`	`getRow(java.util.List columns)` Gets a Row from this Row's SQL that contains the proper given column names.
`RowCollection`	`getRowCollection()` Gets the first RowCollection this Row is contained in.
`java.lang.String`	`getRowDisplayAttributes()` Return a String that provides HTML or other display characteristics of this Row.
`java.lang.StringBuffer`	`getRowDisplayAttributes(java.lang.StringBuffer html)` Deprecated.
`java.util.List`	`getRowHandledActionNames()` Get a list of action names handled by this Row
`RowKey`	`getRowKey()` Gets the RowKey object for this row.
`int`	`getSecuredTypeId()` Gets the id of the secured type.
`java.lang.String`	`getSecuredTypeName()` Gets the secured type name of the secured object.
`int`	`getSecurityType()` Gets the type of security being used.
`java.lang.String`	`getSQL()` Gets the SQL statement used to create this Row.
`SQLContext`	`getSQLContext()` Returns SQLContext to which the RowCollection this Row belongs has.
`java.lang.Object`	`getStaticAttribute(java.lang.Object key)`
`protected java.util.Map`	`getStaticAttributes()`
`double`	`getSum(java.lang.String[] pFieldNames)` Returns the sum of all the fields represented in pFieldNames if that field is a number
`java.lang.String`	`getSystemAlias()` Returns the alias of one of the systems to which this Row belongs.
`TabbedOperation`	`getTabbedOperation()` Gets the TabbedOperation which corresponds to this row.
`Table`	`getTable()` Get's this field's table.
`Table`	`getTable(int pTableIndex)`
`java.lang.String`	`getTableName()` Returns the name of the Table of this Row.
`TableCollection`	`getTables()` Get's this field's table.
`long`	`getTimestamp()` Gets the time when this Row was read from the database, or Long.MIN_VALUE if the time cannot be determined
`java.util.Map`	`getUpdatedFields()` Return the names of all the fields.
`java.lang.String`	`getUserMessageForOperation(int mode)` Return a message to the user after an operation completes.
`java.lang.String`	`getUserMessageForOperation(int rowsChanged, int mode)` Return a message to the user after an operation completes.
`short`	`getUseWOWLibrary()`
`ValidationExceptionCollection`	`getValidationExceptions()` Be careful when you call this method because it is derived and spins through all the fields.
`boolean`	`getValueAsBoolean(java.lang.String pFieldName)` Returns a primitive that represents the value in the specified field.
`byte`	`getValueAsByte(java.lang.String pFieldName)` Returns a primitive that represents the value in the specified field.
`java.util.Date`	`getValueAsDate(java.lang.String pFieldName)` Returns a Date
`java.util.Date`	`getValueAsDate(java.lang.String pYearFldName, java.lang.String pMonthFldName, java.lang.String pDayFldName)` Returns a Date that represents the Date value of 3 seperate fields.
`double`	`getValueAsDouble(int fieldIndex)` Gets a primitive that represents the value in the specified field.
`double`	`getValueAsDouble(java.lang.String pFieldName)` Returns a primitive that represents the value in the specified field.
`float`	`getValueAsFloat(java.lang.String pFieldName)` Returns a primitive that represents the value in the specified field.
`java.lang.String`	`getValueAsFullLengthString(java.lang.String pFieldName)` Returns a String that represents the value in the specified field.
`int`	`getValueAsInt(int index)` Returns a primitive that represents the value in the specified field.
`int`	`getValueAsInt(java.lang.String pFieldName)` Returns a primitive that represents the value in the specified field.
`long`	`getValueAsLong(java.lang.String pFieldName)` Returns a primitive that represents the value in the specified field.
`java.lang.Number`	`getValueAsNumber(int fieldIndex)` Gets a primitive that represents the value in the specified field.
`java.lang.Number`	`getValueAsNumber(java.lang.String pFieldName)` Returns a Number that represents the value in the specified field.
`short`	`getValueAsShort(java.lang.String pFieldName)` Returns a primitive that represents the value in the specified field.
`java.lang.String`	`getValueAsString(int fieldIndex)` Gets a String that represents the value in the specified field.
`java.lang.String`	`getValueAsString(java.lang.String pFieldName)` Returns a String that represents the value in the specified field.
`java.lang.String`	`getValueAsStringByUsageId(int usageId)` Get a String value from this Row for the given usage id.
`java.lang.Object`	`getValueByUsageId(int usageId)` Get a value from this Row for the given usage id.
`java.lang.Object`	`getValueForKey(java.lang.Object valueKey)` Get a value from this row.
`java.util.Iterator`	`getValues()` Returns an iterator which iterates over the values in this Row
`java.lang.StringBuffer`	`getXMLData(java.lang.StringBuffer pXMLData)` This returns a StringBuffer containing all necessary XML data for this object.
`java.lang.StringBuffer`	`getXMLData(XMLFileDescriptor pDescriptor, java.lang.StringBuffer pXMLData)` This returns a StringBuffer containing all necessary XML data for this object.
`java.lang.StringBuffer`	`getXMLHeaderData(java.lang.StringBuffer pXMLData)` This returns a StringBuffer containing all XMLHeader data for this Row.
`void`	`goToNextOperation(int rowsChanged, int mode, ExecutingContext context)` Goto the next operation if specified and execute it.
`java.lang.Object`	`handleAction(java.lang.String action, ExecutingContext ec)` Check to see if this Row has child rows.
`boolean`	`hasAssociationOperation(Field field, ExecutingContext ec)` Tests if a field has an association operation.
`boolean`	`hasChildRows()` Check to see if this Row has child rows.
`boolean`	`hasMultipleStyleClasses(Field field, ExecutingContext ec)` Check if the given Field possibly has more than one style class.
`boolean`	`hasPossibleValuesKeyClassOrOp(Field field)` Tests if the specified field has any type of Possible Values
`boolean`	`hasPossibleValuesOperation(Field field, ExecutingContext ec)` Tests if a field is possible values op.
`boolean`	`hasPropertyChangeListeners(java.lang.String pProperty)` Tests if any object are listening to this Row for changes in one of its properties.
`void`	`incrementFieldValue(Field field, ExecutingContext ec)` Increment this Field's value.
`protected void`	`initializeRow()` Creates Field's for this Row based upon the Row's Table's FieldDescriptors.
`protected void`	`initializeRow(boolean allFields)` Creates Field's for this Row based upon the Row's Table's FieldDescriptors.
`protected void`	`initializeRow(boolean allFields, ExecutingContext pExecutingContext)` Creates Field's for this Row based upon the Row's Table's FieldDescriptors.
`protected void`	`initializeRow(ExecutingContext pExecutingContext)` Creates Field's for this Row based upon the Row's Table's FieldDescriptors.
`protected void`	`initializeRow(java.util.List fieldNames)` Creates Fields for this Row for the given List of field names based upon the Row's Table's FieldDescriptors.
`protected void`	`initializeRow(java.util.List fieldNames, ExecutingContext ec)` Creates Fields for this Row for the given List of field names based upon the Row's Table's FieldDescriptors.
`int`	`insert()` Inserts this Row into its table.
`int`	`insert(java.sql.Connection conn)` Inserts this Row into its table.
`int`	`insert(ExecutingContext ec)` Inserts this Row into the specified database.
`int`	`insert(SQLContext context)` Inserts this Row into the specified database.
`boolean`	`is(java.lang.String pFieldName)` Gets the specified field and returns the boolean value.
`boolean`	`isActionApplicable(java.lang.String actionName, ExecutingContext ec)` Check to see if the action is applicable in the Row's current state
`boolean`	`isActionRepeatable(java.lang.String action, ExecutingContext ec)`
`boolean`	`isARow()` Return a boolean indicating if this object is a Row
`boolean`	`isARowCollection()` Return a boolean indicating if this object is a RowCollection
`boolean`	`isChanged()` Returns whether or not this Row's Fields have changed.
`boolean`	`isChanged(boolean ignoreLogical)` Returns whether or not this Row's Fields have changed.
`boolean`	`isChangedRealTime(boolean realTimeCheck)` Deprecated.
`boolean`	`isChangedSinceLastCheck()` This method has been created as a temporary fix.
`boolean`	`isCloneNeeded()` Test to see if tiis navigation object should be clone upon storing and retrieving.
`boolean`	`isContainsAllFields()` Returns whether or not this Row contains all the Fields of its Table.
`boolean`	`isCopyable(ExecutingContext ec)` Check to see if this Row may be copyable.
`boolean`	`isCurrent()` Tests if any of this row's tables have been updated via the DataEngine since this row was read from the DB
`boolean`	`isDeletable(ExecutingContext ec)` Check to see if this Row may be deletable.
`boolean`	`isDistinctRow()` Test to see if this Row was created with distinct values.
`boolean`	`isEditable(ExecutingContext ec)` Check to see if this Row may be edited.
`boolean`	`isEmpty()` Returns whether or not this Row has any Fields.
`boolean`	`isFieldApplicable(Field fld, ExecutingContext ec)` Tests if a field is applicable in the current scenario
`boolean`	`isFieldAuthorizedForEdit(Field pField, ExecutingContext pContext)` Tests if a field is authorized for edit.
`boolean`	`isFieldAuthorizedForRead(Field pField, ExecutingContext pContext)` Tests if a field is authorized for read.
`boolean`	`isFieldAutoIncrement(Field field, ExecutingContext ec)` Is the specified field an auto-increment field?
`boolean`	`isFieldAutoIncrementDatabaseDriven(Field field, ExecutingContext ec)` Is the given Field a database driven auto increment field.
`boolean`	`isFieldAutoIncrementWOWDriven(Field field, ExecutingContext ec)` Is the given Field a WOW driven auto increment field.
`boolean`	`isFieldDisplayable(Field field, ExecutingContext ec)` Check to see if this Field is displayable.
`boolean`	`isFieldPresent(java.lang.String fieldName)` Tests if a field with the specified name is present in this Row or not
`boolean`	`isFieldReadOnly(Field pField, ExecutingContext pContext)` Tests if a field is read only.
`boolean`	`isFieldReadOnlyOnSearch(Field field, ExecutingContext ec)` Test if the field is read only on search.
`boolean`	`isFieldRequired(Field pField, ExecutingContext pContext)` Tests if a field is required or not.
`boolean`	`isFieldRequiredOnSearch(Field pField, ExecutingContext pContext)` Tests if a field is required or not.
`boolean`	`isFieldsChanged(java.util.List names)` Check to see if any of this Row's Fields have changed for the given list of Field names.
`boolean`	`isFieldUpdateable(Field f)` Tests if the field is updateable.
`boolean`	`isFieldValueNotBlank(java.lang.String fieldName)` Returns whether or not this Field is not blank
`boolean`	`isFieldValuePossibleValue(Field field, ExecutingContext ec)` Tests if the field's value is a possible value.
`boolean`	`isFieldValuesDatabaseDefaults(java.lang.String[] pFieldNames)` Deprecated. We should use the default value from the field descriptor instead.
`boolean`	`isGenerateChildRows()` Check to see if this Row has child rows and if they should be generated when this Row generates.
`boolean`	`isGroupByRow()` Return whether or not this Row was created with a group by in the SQL clause.
`boolean`	`isGuarded()` Check whether this Row is protected (secured)
`boolean`	`isHasColumnNames(java.util.List columns)` Checks to see if this RowCollection has all the columns in the given List.
`boolean`	`isInARowCollection()` Returns whether or not this Row belongs to a RowCollection.
`boolean`	`isIncrementorResetAfterMaxInsertRetries(Field field)` Check if the FieldIncrementor for the given Field should be reset after the max number of insert retries is attempted.
`boolean`	`isInitializeDerivedFieldEnabled(java.lang.String fieldName)` Tells whether or not to initialize a Derived FD upon row creation.
`boolean`	`isInitializeDerivedFieldsEnabled()` Deprecated. This method isn't so good because it doesn't let you specify which fields get initialized & which don't. But there might be subclassses that implemented it, so I guess we're stuck with it for now. isInitializeDerivedFieldEnabled(String) is the replacement which subclasses should override
`boolean`	`isJoinedRow()` Check if Row was created from a join.
`boolean`	`isKeyFieldsPresent()` Returns whether or not this Row contains all the key Fields of its Table.
`boolean`	`isLogicalRow()` Tests if this Row is a logical Row.
`boolean`	`isMultipleDeleteEnabled()` Returns whether or not multiple record deletes are allowed.
`boolean`	`isParameterRow()` Tests if this row is used to generate parameters
`boolean`	`isPersistent()` Tests if this row has been persisted to the database.
`boolean`	`isPhysicalRow()` Tests if this Row is a physical Row.
`boolean`	`isPrepareFieldValue(Field f, ExecutingContext ec)` Tests if the field's display value needs to be prepared before being displayed.
`boolean`	`isPropertyChangeEventsEnabled()` Tests whether the changing of the value in one of this Row's fields will cause this Row to fire a PropertyChangeEvent or not.
`boolean`	`isReturningFromPossibleValuesSearch()` Creation date: (2/9/2003 2:02:05 PM)
`boolean`	`isRowDisplayable(ExecutingContext ec)` Tests if the row can be displayed
`boolean`	`isRowKeyed()` Tests if this row has a key
`boolean`	`isSelectable()` Tests if the user may select a Row of this type.
`boolean`	`isStatusChange(Field field)` Check to see if this field is status change.
`boolean`	`isToBeSelected()` Tests if the Row should be pre-marked as selected before presented in a RowCollection.
`boolean`	`isUnionRow()` Check if Row was created with a union.
`boolean`	`isUpdateable()` Tests if this row can be updated.
`boolean`	`isUseRowForFieldSets()` Check to see if the row should be used to obtain field sets.
`boolean`	`isValidateDerivedFields()` Tests if this Row must validate its derived fields Defaults to false, Subclasses can override this method or set this value via setValidateDerivedFields(true)
`boolean`	`isValidateRequired()` Tests if this Row must be validated before it is inserted/updated
`boolean`	`isValidationRequiredForAutoPopulate(Field pField, ExecutingContext pEC)` Tells whether or not the Field's validate method will be called before the Auto Populate action is executed.
`boolean`	`isViewable(ExecutingContext ec)` Check to see if this Row may be viewed.
`java.util.Iterator`	`iterator()` Creates and returns an iterator which iterates over the fields in this Row
`protected int`	`joinedDatabaseAccessFailure(java.sql.Connection conn, Row disjointRow, TableCollection affectedTables, int mode, java.lang.Throwable t, ExecutingContext ec)` Invoked whenever a update, insert, or delete fails on a disjoint row during a joined DB access.
`protected int`	`joinedDelete(java.sql.Connection connection, boolean useTransactions, ExecutingContext ec)` Deletes this row from the database.
`protected int`	`joinedDelete(java.sql.Connection connection, ExecutingContext ec)` Deletes this row from the database.
`protected int`	`joinedInsert(java.sql.Connection connection, boolean useTransactions, ExecutingContext ec)` Inserts the values in this row into the database with the values in this Row.
`protected int`	`joinedInsert(java.sql.Connection connection, ExecutingContext ec)` Inserts the values in this row into the database with the values in this Row.
`protected int`	`joinedUpdate(java.sql.Connection connection, boolean useTransactions, ExecutingContext ec)` Updates the database with the values in this Row.
`protected int`	`joinedUpdate(java.sql.Connection connection, ExecutingContext ec)` Updates the database with the values in this Row.
`void`	`merge(Row row)` Merges the fields of another row into this one.
`Field`	`newField(FieldDescriptorRow pFD)` Creates and adds a Field to this Row, then returns the Field.
`Field`	`newField(java.lang.String pFieldName, FieldDescriptorRow pFD)` Creates and adds a Field to this Row, then returns the Field.
`Field`	`newField(java.lang.String pFieldName, int pSQLType)` Creates and adds a Field to this Row, then returns the Field.
`Field`	`newField(java.lang.String pFieldName, java.lang.String pFieldClassName)` Creates and adds a Field to this Row, then returns the Field.
`void`	`openFor(int mode, ExecutingContext ec)`
`boolean`	`persist()` Inserts this row into the DB, or updates it in the DB if it is already there
`void`	`populate(java.sql.ResultSet pResults)` Populates this Row with the data from the result set.
`protected void`	`populate(java.sql.ResultSet pResults, java.util.List pPhysicalNames, java.sql.ResultSetMetaData pMetaData, SQLContext pContext)` Populates this Row with the data from the result set.
`protected void`	`populate(java.sql.ResultSet pResults, java.sql.ResultSetMetaData pMetaData, SQLContext pContext)` Populates this Row with the data from the result set.
`protected void`	`populateFD(java.sql.ResultSet pResults, java.util.List pColumnNames)` This method is called by a RowCollection when creating its Rows.
`void`	`postCreate()` Handles actions taken immidately after creation of this object Creation date: (7/11/2002 7:06:46 PM)
`protected void`	`postDelete(int changed, ExecutingContext ec)` This method provides a "hook" for altering the current Row after a delete is performed.
`void`	`postExtract(java.lang.String[] fieldNames, ExecutingContext ec)` Invoked after a row has had values extracted from the screen and set into it
`protected void`	`postInsert(ExecutingContext exContext)` Deprecated. replaced with postInsert(int, ExecutingContext)
`protected void`	`postInsert(int changed, ExecutingContext exContext)` This method provides a "hook" for altering the current row after an insert is performed.
`protected void`	`postUpdate(ExecutingContext exContext)` Deprecated. replaced with postUpdate(int, ExecutingContext)
`protected void`	`postUpdate(int changed, ExecutingContext exContext)` This method provides a "hook" for altering the current row after an update is performed.
`protected void`	`preDelete(ExecutingContext ec)` This method provides a "hook" for altering the current Row before a delete is performed.
`protected void`	`preInsert(ExecutingContext exContext)` This method provides a "hook" for altering the current row before an insert is performed.
`Row`	`prepareForDetails(ExecutingContext ec)` Gets the a proper Row for viewing this Rows details.
`void`	`prepareForParameters(AbstractContext context, ExecutingContext pEc)` This method is invoked on a parameter row just before it is displayed to the user.
`Row`	`prepareForResultsDisplay(ExecutingContext ec)` Allows the current row to handle any necessary actions before being displayed in a results table.
`Row`	`prepareFromFieldNames(java.util.List pNames)` Gets the a proper Row for viewing this Rows details.
`protected void`	`preUpdate(ExecutingContext exContext)` This method provides a "hook" for altering the current row before an update is performed.
`Field`	`removeField(Field field)` Removes the specified field from this row.
`Field`	`removeField(java.lang.String fieldName)` Removes the field with the specified name from this row.
`void`	`removeNavigationKey()` Clears out any navigation key that may have been set on this Row.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Removes a property change listener that was added via the `addPropertyChangeListener()` method.
`void`	`removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener)` Removes a property change listener that was added via the `addPropertyChangeListener()` method.
`void`	`removeRowEventListener(IRowEventListener pNewListener)` Removes a Listener from this Row
`void`	`removeRowEventListeners(java.util.List listeners)` Removes a Listener from this Row
`void`	`replaceField(Field newField)` Replace a Field with the given Field.
`protected void`	`replaceFields()` This method is invoked after a Row is read from the DB.
`java.util.List`	`replaceFieldValues(java.util.Map nameValueMap)` Replaces the values in one or more fields.
`protected static java.util.List`	`replaceNumbersWithNames(java.util.List names, java.util.List rowFieldNames)` Gets the field name for the given Strings in the List.
`Row`	`reread()` Rereads this row, returning a new Row with fresh values from the DB.
`Row`	`rereadIfNeeded()` Rereads this row, returning a new Row with fresh values from the DB, but only if this Row's table has been updated from the DataEngine since it was read; otherwise this same row is returned.
`void`	`resetDisplayValues()` Resets the display values in this row to null so they can be recomputed when needed.
`Row`	`rollbackChanges()` Undoes any changes that have been made to this Row since it was read from or written to the database.
`protected RowCollection`	`runSQLQuery(java.lang.String sqlStatement)` Convenience method for running an SQL query statement against tables on the same machine.
`protected RowCollection`	`runSQLQuery(java.lang.String sqlStatement, java.lang.Class rowClass)` Convenience method for running an SQL query statement against tables on the same machine.
`protected void`	`runSQLStatement(java.lang.String sql)` Convenience method for running an SQL statement against tables on the same machine.
`protected void`	`runSQLStatement(java.lang.String sql, ExecutingContext ec)` Convenience method for running an SQL statement against tables on the same machine.
`void`	`setAttribute(java.lang.Object key, java.lang.Object value)` Map that allows general attributes about a Row to be set and retreived.
`protected void`	`setAutoUpdateFieldValues(ExecutingContext ec)` Set auto update Field values.
`void`	`setCreationContext(SQLContext context)` Sets the SQL context that was used when creating this Row
`void`	`setCreationOperation(Operation op)` Sets the operation responsible for creating this row
`void`	`setFieldInitialValue(java.lang.String fldNam, java.lang.Object value)` Sets the value of the specified field.
`void`	`setFieldValue(java.lang.String fldNam, boolean bool)` Sets the value of the specified boolean field
`void`	`setFieldValue(java.lang.String fldNam, double pDouble)` Sets the current value of the Field to the specified value, and also sets the old value to the previous value.
`void`	`setFieldValue(java.lang.String fldNam, long pLong)` Sets the current value of the Field to the specified value, and also sets the old value to the previous value.
`void`	`setFieldValue(java.lang.String fldNam, java.lang.Object value)` Sets the value of the specified field.
`void`	`setFieldValueAsString(java.lang.String fldNam, java.lang.String value)` Sets the value of the specified field.
`void`	`setFieldValueAsString(java.lang.String fldNam, java.lang.String value, int startPos)` Sets the value of the specified field from the starting position (zero indexed) without affecting other positions in this field.
`void`	`setFieldValuesAsDate(java.lang.String[] fieldNames, java.util.Date date)` This method is for cases when the date is stored in 3 fields (year{2002}, month{5}, day{10}) in the database.
`void`	`setFieldValuesToDefault(java.util.List fieldNames, boolean ignoreCase, ExecutingContext ec)` Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.
`void`	`setFieldValuesWithCommonFieldNames(java.util.List targetNames, Row source, boolean ignoreCase)` Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.
`void`	`setFieldValuesWithCommonFieldNames(Row source)` Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.
`void`	`setFieldValuesWithCommonFieldNames(Row source, boolean ignoreCase)` Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.
`void`	`setFieldValuesWithCommonUsageIds(Row rowToCopy)` Copy the field values from the supplied Row with the same usageid into this Row.
`void`	`setFieldValueToDefault(java.lang.String pName, ExecutingContext ec)` Sets the fields value back to the default value Creation date: Jun 24, 2004 - 3:14:48 PM
`void`	`setMultipleDeleteEnabled(boolean pMultipleDeleteEnabled)` Sets whether or not multiple record deletes are allowed.
`void`	`setNavigationKey(java.lang.String key)` Set the key used to store/retrieve this Row to/from navigation.
`void`	`setParameterRow(boolean isParameterRow)` Sets if this row is being used to generate parameter inputs
`void`	`setPersistent(boolean persistent)` Sets if this row has been persisted to the database.
`void`	`setPropertyChangeEventsEnabled(boolean newPropertyChangeEventsEnabled)` Sets whether the changing of the value in one of this Row's fields will cause this Row to fire a PropertyChangeEvent or not.
`void`	`setPropertyGroups(PropertyGroupList propertyGroups)` Set the property groups stored in this RowCollection's attributes.
`void`	`setReturningFromPossibleValuesSearch(boolean value)` Insert the method's description here.
`void`	`setRowDisplayAttributes(java.lang.String displayAttributes)` Sets a String that provides HTML or other display characteristics of this Row.
`void`	`setSavepoint()` Sets savepoints for the Fields in the this Row.
`void`	`setSavepoint(java.util.Collection pFields)` Sets savepoints for the Fields in the given Collection.
`void`	`setSavepoint(java.util.Map pFields)` Sets savepoints for the Fields in the given Map.
`void`	`setStaticAttribute(java.lang.Object key, java.lang.Object value)`
`void`	`setTables(java.util.List pTables)` Deprecated. Pass in a table collection instead
`void`	`setTables(TableCollection pTables)` Sets the table to which this row belongs.
`void`	`setUseWOWLibrary(short newWOWSystemLibrary)` Sets which WOW library should be used to execute this Row's context.
`void`	`setValidateDerivedFields(boolean newValidateDerivedFields)` Sets if this Row must validate its derived fields Defaults to false, Subclasses can override this method or set this value via setValidateDerivedFields(true)
`void`	`setValidateRequired(boolean newValidateRequired)` Sets if this Row must be validated before it is inserted/updated
`void`	`setValues(java.util.List pData)` Sets the values of this Row
`int`	`size()` Returns the number of fields in this Row.
`void`	`splitAndSetFieldValues(java.lang.String[] fieldNames, int[] splitIndices, java.lang.String valueToSplit)` This method takes the specified value and splits it into mulitple values and then sets those values on the fields with the given field names.
`Row`	`statusChanged(Field pField, ExecutingContext ec)` Invoked when a status change takes place on of this Row's fields.
`void`	`swapFieldValues(java.lang.String fieldNameA, java.lang.String fieldNameB)` Swaps the values of the two fields
`java.lang.StringBuffer`	`toCSV(boolean pIncludeColumnHeadings, CSVFileDescriptor pCSVFileDescriptor)` Returns a StringBuffer in CSV format containing all data in this Row Creation date: (2/6/2002 5:14:39 PM)
`java.lang.StringBuffer`	`toDOC(boolean pIncludeColumnHeadings, CSVFileDescriptor pFileDescriptor)` Deprecated. Use the single argument method instead
`java.lang.StringBuffer`	`toDOC(CSVFileDescriptor pFileDescriptor)` Returns a StringBuffer in Microsoft Word .doc format containing all data in this RowCollection.
`java.lang.StringBuffer`	`toFDF(FDFFileDescriptor pFileDescriptor)` Returns a StringBuffer in FDF format containing all data in this Row.
`void`	`toPDF(boolean pIncludeColumnHeadings, PDFFileDescriptor pFileDescriptor)` Deprecated. Use the single argument method instead
`void`	`toPDF(PDFFileDescriptor pFileDescriptor)` Generates a PDF file from this Row.
`java.lang.String`	`toString(boolean includeTable)` Returns a String representation of this Row.
`void`	`toUpperCase()` This method will UPPERCASE all the fields values in this Row if it is stored in the databse as a Char or it is a StringField.
`java.lang.StringBuffer`	`toXML(XMLFileDescriptor pFileDescriptor)` Returns a StringBuffer in XML format containing all data in this Row.
`Row`	`transferDataTo(java.lang.Class pNewRowClass)` Transfers all the data in this Row into a different Row.
`Row`	`transferDataTo(Row pDestinationRow)` Transfers all the data in this Row into a different Row.
`int`	`update()` Updates the database with the values in this Row.
`int`	`update(java.sql.Connection conn)` Updates the database with the values in this Row.
`int`	`update(java.sql.Connection connection, ExecutingContext ec)` Updates the database with the values in this Row.
`int`	`update(ExecutingContext ec)` Updates the database with the values in this Row.
`void`	`updateFieldValues(java.util.Map fields)` Updates the values of any Fields in this Row with the value in the given Map that has the same key as the Field's name.
`void`	`updateGlobalValues(ExecutingContext ec)` Updates any global values this Row might have.
`void`	`updateObject()` Deprecated. by WK on (8/10/2003 7:58:28 AM) because there were no references to this method in VAJ any where and all it does is call update()
`boolean`	`validate(ExecutingContext ec)` Validate this Row based on it's configuration and field values.
`boolean`	`validate(ExecutingContext pContext, java.security.Principal pUser)` Deprecated. by WK on (8/9/2003 9:24:24 AM) because the executing context contains the user. Replaced with validate(ExecutingContext). This method will no longer be supported as of WOW 7.0.
`boolean`	`validate(int pOperation, java.security.Principal pUser)` Deprecated. Use the validate() method which takes in an ExecutingContext
`boolean`	`validateField(Field field, ExecutingContext ec)` Validates the given Field and returns whether or not the Field is valid.
`void`	`validateRowOperation(int pOperation, java.security.Principal pUser)` Validate if the operation can be performed on this Row.

Methods inherited from class java.lang.Object

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

Field Detail

className

public static final java.lang.String className

MODE_COPY

public static final int MODE_COPY

See Also:: Constant Field Values

MODE_DELETE

public static final int MODE_DELETE

See Also:: Constant Field Values

MODE_INSERT

public static final int MODE_INSERT

See Also:: Constant Field Values

MODE_READ

public static final int MODE_READ

See Also:: Constant Field Values

MODE_SEARCH

public static final int MODE_SEARCH

See Also:: Constant Field Values

MODE_UNKNOWN

public static final int MODE_UNKNOWN

See Also:: Constant Field Values

MODE_UPDATE

public static final int MODE_UPDATE

See Also:: Constant Field Values

MODE_ALTER

public static final int MODE_ALTER

See Also:: Constant Field Values

mRowEventListeners

protected transient java.util.List mRowEventListeners

DISPLAY_ORDER_COMPARATOR

public static final java.util.Comparator DISPLAY_ORDER_COMPARATOR

Constructor Detail

Row

public Row()

Method Detail

create

public static Row create(java.lang.Class rowSubClass)
                  throws DataEngineException

Create and return a new Row of the given Class type using the given ExecutingContext to allow for security and/or personalization.

Parameters:: rowSubClass - subclass of Row to create
Returns:: Row
Throws:: DataEngineException

create

public static Row create(RowCollection pRowCollection)
                  throws DataEngineException

Create and return a new Row and also set its Table.

Returns:: Row
Throws:: DataEngineException

create

public static Row create(RowCollection pRowCollection,
                         java.lang.Class rowSubClass)
                  throws DataEngineException

Create and return a new Row and also set its Table.

Parameters:: rowSubClass - Class
Returns:: Row
Throws:: DataEngineException

create

public static Row create(RowCollection pRowCollection,
                         boolean initialRow)
                  throws DataEngineException

Create and return a new Row and also set its Table.

Returns:: Row
Throws:: DataEngineException

create

public static Row create(RowCollection pRowCollection,
                         java.lang.Class rowSubClass,
                         boolean initialRow)
                  throws DataEngineException

Create and return a new Row and also set its Table.

Parameters:: rowSubClass - Class
Returns:: Row
Throws:: DataEngineException

create

public static Row create(java.util.List tables,
                         java.lang.Class rowSubClass,
                         java.util.List fieldNames,
                         boolean initializeRow,
                         ExecutingContext pExecutingContext)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table. The executing context allows for security and personalization.

Parameters:: rowSubClass - Class; pExecutingContext - ExecutingContext
Returns:: Row
Throws:: DataEngineException

create

public static Row create(SQLContext context,
                         java.util.List fieldNames,
                         boolean initializeRow)
                  throws DataEngineException

Create and return a new Row from the given SQLContext. The tables, Class type, and ExecutingContext are all retrieved from the SQLContext.

Throws:: DataEngineException

create

public static Row create(Table table)
                  throws DataEngineException

Create and return a new Row of class Row.class and initializes the row with all of the tables fields.

Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         boolean initializeRow)
                  throws DataEngineException

Create and return a new Row of class Row.class and initializes the row with all of the tables fields if specified.

Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         boolean initializeRow,
                         ExecutingContext ec)
                  throws DataEngineException

Create and return a new Row and also set its Table.

Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.lang.Class rowSubClass)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table.

Parameters:: table - Table; rowSubClass - Class
Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.lang.Class rowSubClass,
                         boolean initializeRow)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table.

Parameters:: table - Table; rowSubClass - Class
Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.lang.Class rowSubClass,
                         boolean initializeRow,
                         ExecutingContext pExecutingContext)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table. The executing context allows for security and personalization.

Parameters:: table - Table; rowSubClass - Class; pExecutingContext - ExecutingContext
Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.lang.Class rowSubClass,
                         ExecutingContext executingContext)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table.

Parameters:: table - Table; rowSubClass - Class
Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.lang.Class rowSubClass,
                         java.util.List fieldNames,
                         boolean initializeRow)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table. The executing context allows for security and personalization.

Parameters:: table - Table; rowSubClass - Class
Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.lang.Class rowSubClass,
                         java.util.List fieldNames,
                         boolean initializeRow,
                         ExecutingContext pExecutingContext)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table. The executing context allows for security and personalization.

Parameters:: table - Table; rowSubClass - Class; pExecutingContext - ExecutingContext
Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.util.List fieldNames,
                         boolean initialize)
                  throws DataEngineException

Create and return a new Row for the given table and field names.

Parameters:: table - Table to create Row from; fieldNames - names of Fields to initialize Row with if specified; initialize - whethor or not to initialize the Row
Returns:: newly created Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.util.List fieldNames,
                         boolean initializeRow,
                         ExecutingContext pExecutingContext)
                  throws DataEngineException

Create and return a new Row of the given Class type and also set its Table. The executing context allows for security and personalization.

Parameters:: table - Table; pExecutingContext - ExecutingContext
Returns:: Row
Throws:: DataEngineException

create

public static Row create(Table table,
                         java.util.List names,
                         ExecutingContext ec)
                  throws DataEngineException

Create and return a new Row and also set its Table.

Returns:: Row
Throws:: DataEngineException

replaceNumbersWithNames

protected static java.util.List replaceNumbersWithNames(java.util.List names,
                                                        java.util.List rowFieldNames)

Gets the field name for the given Strings in the List. If a String in the list is a number, then the proper field name for that column is replaced. If the column is specified by number and does not resolve to a field name it is removed from the list. This method does not alter the list that is passed in.

add

public void add(Field pField)
         throws DataEngineException

Adds the given Field to this Row's FieldCollection.

Parameters:: pField - Field
Throws:: DataEngineException

add

public void add(RowCollection pRowCollection)

Adds the given RowCollection to the List of RowCollection's this Row belongs to.

Parameters:: pRowCollection - RowCollection

addObject

public void addObject()
               throws java.lang.Exception

Add an object to the system.

Specified by:: addObject in interface IBusinessObject

Throws:: java.lang.Exception

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a listener which is informed when any field of this Row which has its value changed. The source of any PropertyChangeEvent passed to a listener is this object; the name of the Field whose value was changed will be included in the PropertyChangeObject.

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String property,
                                      java.beans.PropertyChangeListener listener)

Adds a listener which is informed when a specific property of this Row which has its value changed. The source of any PropertyChangeEvent passed to a listener is this object; the name of the Field whose value was changed will be included in the PropertyChangeObject.

Parameters:: property - The name of the property (or field) to which the listener will listen; listener - The object which to listen to the property

addRowEventListener

public void addRowEventListener(IRowEventListener pNewListener)

Adds a new Listener to this Row.

addRowEventListeners

public void addRowEventListeners(java.util.List listeners)

addTable

public void addTable(Table pTable)

Sets the table to which this row belongs.

addToRowCollection

public int addToRowCollection(RowCollection rc)
                       throws CMException

Adds this row to a RowCollection. This method is here so subclasses can override and provide their own implementation.

Parameters:: rc - The rowcollection to which this row should be added
Returns:: The number of rows which were added to the RowCollection
Throws:: CMException

appendDisplayType

public java.lang.StringBuffer appendDisplayType(java.lang.StringBuffer sb)

Deprecated. row shouldn't know how to display html stuff - moved logic back into htmltable, eventually we could check the row to see if its property group has a css to use and use that if needed

Appends a String describing the display type for this row. In HTML, this correpsonds to the CSS class that will be used to display this row. For example, if this method returned the String "XYZ" then the CSS class for displaying this Row would be "tr.results-XYZ-even" for even rows and "tr.results-XYZ-odd" for odd rows.

batchProcess

public void batchProcess()
                  throws CMException

Process this Object. This method may be overridden by subclasses to provide for special case processing of the Row.

Specified by:: batchProcess in interface IBatchProcessObject

Throws:: CMException

clearFields

public void clearFields()

Removes all the Fiels from this Row.

clearTables

public void clearTables()

Removes all the Fiels from this Row.

clearValidationException

public void clearValidationException()

Clears any validation exceptions that have previously been set on each of this Row's Fields.

clone

public java.lang.Object clone()

Clone this Row object.

Specified by:: clone in interface INavigationObject

cloneRow

public Row cloneRow()
             throws CMException

Clones this Row object.

Throws:: CMException

commitFieldValues

public void commitFieldValues()

Commits the values of the Fields in this Row. After invoking this method any fields with "old values" will have their old values removed, and will treat their current values as if they had been read from the database.

commitFieldValues

public void commitFieldValues(java.util.Collection pFields)

Commits the values of the Fields in the given Collection. After invoking this method any fields with "old values" will have their old values remove, and will treat their current values as if they had been read from the database.

commitFieldValues

public void commitFieldValues(java.util.Map pFields)

Commits the values of the Fields in the given Map. After invoking this method any fields with "old values" will have their old values remove, and will treat their current values as if they had been read from the database.

concatenateFieldFullLengthValues

public java.lang.String concatenateFieldFullLengthValues(java.lang.String[] pFieldNames,
                                                         java.lang.String pSeperator)
                                                  throws CMException

Concat the field full length string values inserting the supplied seperator between values.

Parameters:: pFieldNames - String[] fieldNames to concat; pSeperator - String value to insert between fields
Returns:: FieldDescriptorRow
Throws:: CMException

concatenateFieldValues

public java.lang.String concatenateFieldValues(java.lang.String[] pFieldNames,
                                               java.lang.String pSeperator,
                                               boolean pTrimValues)
                                        throws CMException

Concat the field values inserting the supplied seperator between values and optionally trim the values before concating. Example: custRow.concatenateFieldValues({"fname", "lname", " ", true) This will concat the first name to the last name with a space between triming both prior to concating

Parameters:: pFieldNames - String[] fieldNames to concat; pSeperator - String value to insert between fields; pTrimValues - boolean trim the values before concating
Returns:: FieldDescriptorRow
Throws:: CMException

containsField

public boolean containsField(java.lang.String fieldName)

Check to see if this Row contains the Field with the given name.

Parameters:: fieldName - name of Field to see if Row contains.
Returns:: true if Row contains a Field for the given name; false otherwise.

copy

public Row copy(boolean pFullCopy)
         throws CMException

Copy this Row. If specified, copy all of its Fields from the database.

Parameters:: pFullCopy - whether or not to copy the complete Row
Returns:: Row
Throws:: CMException

copyIntoRowFieldsWithCommonFieldNames

public void copyIntoRowFieldsWithCommonFieldNames(Row rowToCopy)
                                           throws CMException

Deprecated. replaced with setFieldValuesWithCommonFieldNames(Row)

Copy the fields from the supplied Row with the same field name into this Row.

Parameters:: rowToCopy - the row that the values will be copied from
Throws:: CMException

copyIntoRowFieldsWithCommonFieldNames

public void copyIntoRowFieldsWithCommonFieldNames(Row rowToCopy,
                                                  boolean ignoreCase)
                                           throws CMException

Deprecated. replaced with setFieldValuesWithCommonFieldNames(Row, boolean)

Copy the fields from the supplied Row with the same field name into this Row.

Parameters:: rowToCopy - the row that the values will be copied from; ignoreCase - whether or not to ignore the case of the field names
Throws:: CMException

copyIntoRowFieldsWithCommonUsageIds

public void copyIntoRowFieldsWithCommonUsageIds(Row rowToCopy)
                                         throws CMException

Copy the fields from the supplied Row with the same usageid into this Row.

Throws:: CMException

copyIntoRowFieldsWithGivenFieldNames

public void copyIntoRowFieldsWithGivenFieldNames(java.util.List fieldNames,
                                                 Row rowToCopy)
                                          throws CMException

Deprecated. replaced with setFieldValuesWithCommonFieldNames(List, Row, boolean)

Copy the fields from the supplied Row that has a name in the given list.

Parameters:: fieldNames - the names of the fields that will be eligible for the copy; rowToCopy - the row that the values will be copied from
Throws:: CMException

copyIntoRowFieldsWithGivenFieldNames

public void copyIntoRowFieldsWithGivenFieldNames(java.util.List fieldNames,
                                                 Row rowToCopy,
                                                 boolean ignoreCase)
                                          throws CMException

Deprecated. replaced with setFieldValuesWithCommonFieldNames(List, Row, boolean)

Copy the fields from the supplied Row that has a name in the given list.

Parameters:: fieldNames - the names of the fields that will be eligible for the copy; rowToCopy - the row that the values will be copied from; ignoreCase - whether or not to ignore the case of the field names
Throws:: CMException

createRow

public Row createRow(Row pDefaultRow)
              throws CMException

Creates a new Row. Information from the database is read into a default Row by the DataEngine; this method is then invoked to get a Row of the correct type based on the information in the default Row. Typically the data in the Row is examined by this method, a Row of the appropriate type is created, and then the transferDataTo() method is used to move the data from the default Row to the newly created Row. Override this method if the type of Row to add needs to be dynamically determined from the retrieved data.

Specified by:: createRow in interface IRowCreator

Parameters:: pDefaultRow - A Row containing data read from the database (it will always be equal to this)
Returns:: A Row which the DataEngine will add to a RowCollection
Throws:: CMException

createSQLContextForDelete

protected SQLContext createSQLContextForDelete(ExecutingContext ec)
                                        throws CMException

Creates a new SQLContext which will be used for deleting this row. Subclasses may override if necessary

Throws:: CMException

createSQLContextForInsert

protected SQLContext createSQLContextForInsert(ExecutingContext ec)
                                        throws CMException

Creates a new SQLContext which will be used for inserting this row. Subclasses may override if necessary

Throws:: CMException

createSQLContextForUpdate

protected SQLContext createSQLContextForUpdate(ExecutingContext ec)
                                        throws CMException

Creates a new SQLContext which will be used for updating this row. Subclasses may override if necessary

Throws:: CMException

dataTransferred

protected void dataTransferred(Row oldRow)

This method is invoked after this row has data transferred to it from another row. Subclasses may override.

defaultMerge

public void defaultMerge(RowCollection rc)
                  throws CMException

Works similar to the merge method, except all the fields that are merged into this row have the default values for that field type instead of actual values.

Throws:: CMException

delete

public final int delete()
                 throws CMException

Deletes the row from the database file to which it belongs. If it cannot be deleted because concurrent alterations to the database row prevent its deletion, a ConcurrentAlterationException is thrown.

Returns:: The number of row that were deleted.
Throws:: CMException

delete

public final int delete(java.sql.Connection conn)
                 throws CMException

Deletes the row from the database file to which it belongs. If it cannot be deleted because concurrent alterations to the database row prevent its deletion, a ConcurrentAlterationException is thrown.

Parameters:: conn - The connection to use for the deletion.
Returns:: The number of row that were deleted.
Throws:: CMException

delete

public int delete(java.sql.Connection conn,
                  ExecutingContext ec)
           throws CMException

Deletes the row from the database file to which it belongs. If it cannot be deleted because concurrent alterations to the database row prevent its deletion, a ConcurrentAlterationException is thrown.

Parameters:: conn - The connection to use for the deletion.
Returns:: The number of row that were deleted.
Throws:: CMException

delete

public final int delete(ExecutingContext ec)
                 throws CMException

Deletes the row from the database file to which it belongs. If it cannot be deleted because concurrent alterations to the database row prevent its deletion, a ConcurrentAlterationException is thrown.

Returns:: The number of row that were deleted.
Throws:: CMException

deleteObject

public void deleteObject()
                  throws java.lang.Exception

Delete an object from the system. First call the BusinessObjectManager who can either delete it or veto the delete by throwing an Exception.

Specified by:: deleteObject in interface IBusinessObject

Throws:: java.lang.Exception

divide

public double divide(java.lang.String fieldName,
                     java.lang.String fieldName2)
              throws CMException

Get the division of the first field with the second fields. Example: double value = row.divide("NumeratorField", "DenominatorField");

Parameters:: fieldName - field name of numerator.; fieldName2 - field name of denominator.
Returns:: double representing the division of the two fields.
Throws:: CMException

duplicateKey

public void duplicateKey(ExecutingContext ec)
                  throws CMException

Method called when a duplicate key is encountered attempting to insert this Row. Subclasses may override to provide additional logic before insert is attempted again.

Parameters:: ec - context in which the Row is being processed.
Throws:: CMException

duplicateKey

public boolean duplicateKey(int retriesLeft,
                            ExecutingContext ec)
                     throws CMException

Method called when a duplicate key is encountered attempting to insert this Row. Subclasses may override to provide additional logic before insert is attempted again.

Parameters:: retriesLeft - The number of retry attemps left; ec - context in which the Row is being processed.
Returns:: true if the insert should be attempted again, false if the insert should fail without any warnings or messages
Throws:: CMException

enforceExclusiveOr

protected void enforceExclusiveOr(java.util.List fieldNames)
                           throws CMException

Examines a set of fields in this Row. If more than one of these fields has a value and only one of the fields with a value has been changed, then all of the other specified fields with a value have their value removed. If more than one of these values has a value, and multiple (or none) of these fields have been changed, a validation exception is thrown

Throws:: CMException

equals

public boolean equals(java.lang.Object otherRow)

Tests if this Row is equal to another Row. Two Rows are equal if for every field in Row A, there is a corresponding field in Row B to which the field in Row A is equal.

equals

public boolean equals(Row row,
                      java.util.List fieldNames)

Tests if a group of fields in this row have the same values as a group of fields in another row

equalsInstance

public boolean equalsInstance(java.lang.Object otherRow)

Tests if this Row is equal to another Row.

fieldHasPossibleValuesSQLOperation

public final boolean fieldHasPossibleValuesSQLOperation(Field pField,
                                                        ExecutingContext pContext)

Deprecated. replaced with hasPossibleValuesOperation(Field, ExecutingContext) to keep consistancy with similar methods

Tests if a field is possible values op. The default behavior is to ask the FD, but subclasses may override this method and implement a different behavior.

Parameters:: pField - The whose read only status is being tested; pContext - The current executing context which may be null

hasPossibleValuesOperation

public boolean hasPossibleValuesOperation(Field field,
                                          ExecutingContext ec)

Tests if a field is possible values op. The default behavior is to ask the FD, but subclasses may override this method and implement a different behavior.

firePropertyChange

protected void firePropertyChange(java.lang.String name,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Informs listeners of a property change. Note that invoking this method will always inform the listeners, even if isPropertyChangeEventsEnabled() returns false.

fireRowEvent

protected void fireRowEvent(RowEvent pEvent)

Method to support listener events.

getActionDefaultLocation

public java.lang.String getActionDefaultLocation()

Description copied from interface: IActionObject

Get the location where this action is to be generated

Specified by:: getActionDefaultLocation in interface IActionObject

getActionDescriptor

public ActionDescriptor getActionDescriptor(AbstractAction action)

Description copied from interface: IActionObject

Get an action descriptor for the given action type and name.

Specified by:: getActionDescriptor in interface IActionObject

createAction

public AbstractAction createAction(java.lang.String name,
                                   ExecutingContext ec)

Description copied from interface: IActionObject

Create an action for the given action name.

Specified by:: createAction in interface IActionObject

createNamedActionRequest

public AbstractActionRequest createNamedActionRequest(java.lang.String name,
                                                      ExecutingContext ec)
                                               throws CMException

Throws:: CMException

getActions

public java.util.List getActions(ExecutingContext ec)

Description copied from interface: IActionObject

Get a List of the actions this object supports.

Specified by:: getActions in interface IActionObject

getActionsForFields

public final java.util.List getActionsForFields(ExecutingContext ec)

Get a List of names of actions handled by this Row. Any List returned by this method must be modifiable, as subclasses may override and add their own actions to the List. A null List may be returned. Subclasses should usually invoke the superclass method and add their actions to this List as opposed to creating and returning their own List

getActionsForOperation

public java.util.List getActionsForOperation(ExecutingContext ec)

Gets the Operation actions which may apply to this Row. Operation actions returned in the List may or may not be displayed with this Row, depending on the locations specified for those actions

getRowHandledActionNames

public java.util.List getRowHandledActionNames()

Get a list of action names handled by this Row

getAssociation

public java.lang.Object getAssociation(java.lang.String fieldName)
                                throws CMException

Gets the association for the given Field name. If the association is 1 to 1, then a Row is returned. If it is 1 to Many, then a RowCollection is returned. Note: to retrieve any association containing user parameters, getAssociation(String, ExecutingContext) should be called passing in the current executing context which contians the current user.

Parameters:: fieldName - name of Field containing association
Returns:: Object retrieved from executing the association operation
Throws:: CMException

getAssociation

public java.lang.Object getAssociation(java.lang.String fieldName,
                                       ExecutingContext ec)
                                throws CMException

Gets the association for the given Field name. If the association is 1 to 1, then a Row is returned. If it is 1 to Many, then a RowCollection is returned.

Parameters:: fieldName - name of Field containing association; ec - current context in which user is executing
Returns:: Object as a result of executing the association
Throws:: CMException

getAssociationByOperationUsageId

public java.lang.Object getAssociationByOperationUsageId(int usageId,
                                                         ExecutingContext ec)
                                                  throws CMException

Gets the association for the given operation usage id. If the association is 1 to 1, then a Row is returned. If it is 1 to Many, then a RowCollection is returned.

Parameters:: usageId - usage id of the operation; ec - current context in which user is executing
Returns:: Object as a result of executing the association
Throws:: CMException

getAssociationOperation

public Operation getAssociationOperation(java.lang.String fieldName)
                                  throws CMException

Deprecated. use getFieldAssociationOperation(Field)

Gets the association's operation for the Field having the given name.

Parameters:: fieldName - name of Field to get association operation from.
Returns:: association operation for the field.
Throws:: CMException

getAttribute

public java.lang.Object getAttribute(java.lang.Object key)

Map that allows general attributes about a Row to be set and retreived. Return the object with the specified key Creation date: (2/19/2002 3:10:01 PM)

Returns:: Object

getBackgroundColor

public java.awt.Color getBackgroundColor(Field field,
                                         ExecutingContext ec)
                                  throws CMException

Gets the background color to use when rendering the specified field in a non-HTML way

Throws:: CMException

getChangedFields

public java.util.List getChangedFields()

Gets the fields whose values have been changed

getChildren

public RowCollection getChildren()
                          throws CMException

Gets a RowCollection of children this Row has.

Throws:: CMException

getColumnSpan

public int getColumnSpan(Field field,
                         boolean isDetails)

Get the number of columns the given field should take up.

Parameters:: field - to get column span for; isDetails - whether or not its details or results table being generated

getCompleteRow

public Row getCompleteRow()
                   throws CMException

Gets a complete Row for this Row containing all of its Fields in the database. NOTE: WK (4/12/2002 5:45:27 PM) method will not work for joined row.

Returns:: Row
Throws:: CMException

getCompleteRow

public Row getCompleteRow(java.sql.Connection pConnection)
                   throws CMException

Gets a complete Row for this Row containing all of its Fields in using the specified connection if needed. NOTE: WK (4/12/2002 5:45:27 PM) method will not work for joined row.

Returns:: Row
Throws:: CMException

getConcurrentFields

protected FieldCollection getConcurrentFields()
                                       throws CMException

Returns a FieldCollection object containing the fields in this row that do not allow for concurrent alterations

Returns:: FieldCollection
Throws:: CMException

getConfigProperty

public final java.lang.Object getConfigProperty(java.lang.String key,
                                                ExecutingContext executingContext)

Get a config property for the given row.

getCopiedFieldValues

public java.util.Map getCopiedFieldValues()
                                   throws CMException

Returns a Map of field values, keyed by field name. The returned Map is independent of the Row - alterations of the fields in the Row or the values in the Row's fields will not affect the values in the Map. Logical fields are not included in the Map

Throws:: CMException

getCreationContext

public SQLContext getCreationContext()

Gets the SQL context that was used when creating this Row

getCSVRow

public java.util.List getCSVRow()

Returns a List of Fields that implement ICSVField or a list of Objects that provide a toString method which returns the desired text to be written to the CSV file. Each row has a List of fields. Below is an example would return a List that has 5 elements (5 rows). Each row is a List with 2 elements (2 fields).

Tyler,Holm Justin,Epstein Paul,Holm Wes,King Nate,Levis

Creation date: (12/5/2001 1:52:02 AM)

Specified by:: getCSVRow in interface ICSVRow

Returns:: java.util.List that is unmodifiable

getCSVRow

public java.util.List getCSVRow(java.util.List fieldNames)

Tyler,Holm Justin,Epstein Paul,Holm Wes,King Nate,Levis

Specified by:: getCSVRow in interface ICSVRow

Parameters:: fieldNames - Only the fields specified by the names in this argument should be returned in the List Creation date: (12/5/2001 1:52:02 AM)
Returns:: java.util.List that is unmodifiable

getAutoIncrementDatabaseDrivenField

public Field getAutoIncrementDatabaseDrivenField(ExecutingContext ec)
                                          throws CMException

Check to see if there is a Field in this Row that is an auto increment field handled by the database.

Parameters:: ec -
Returns:
Throws:: CMException

getDatabaseRow

public Row getDatabaseRow(java.sql.Connection conn)
                   throws CMException

Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database. Derived fields will NOT be returned from this method.

Parameters:: conn - the connection to the database
Throws:: CMException

getDatabaseRow

public Row getDatabaseRow(boolean originalRow,
                          java.sql.Connection conn)
                   throws CMException

Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database. Derived fields will NOT be returned from this method.

Parameters:: originalRow - If the row should be looked for in the DB using its original values, as opposed to its current values; conn - the connection to the database
Throws:: CMException

getDatabaseRow

public Row getDatabaseRow(java.sql.Connection conn,
                          boolean includeDerivedFields)
                   throws CMException

Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database.

Parameters:: conn - the connection to the database
Throws:: CMException

getDatabaseRow

public Row getDatabaseRow(boolean originalRow,
                          java.sql.Connection conn,
                          boolean includeDerivedFields)
                   throws CMException

Rereads and returns this row as it exists in the database, or null if it doesn't exist in the database.

Parameters:: originalRow - If the row should be looked for in the DB using its original values, as opposed to its current values; conn - the connection to the database
Throws:: CMException

getDeleteConfirmation

public java.lang.String getDeleteConfirmation()

Deprecated.

Get the delete confirmation method to call.

getDeleteConfirmationMessage

public java.lang.String getDeleteConfirmationMessage()

Get the delete confirmation message.

getDisjointRowClass

public java.lang.Class getDisjointRowClass(Table table,
                                           int mode,
                                           ExecutingContext ec)
                                    throws CMException

Gets the row class which will be used for containing the unjoined data in this row. Multiple disjoint rows are created when a joined row needs to be inserted, updated, or deleted. Each disjoint row contains fields from a single table, and is used to send that data to the table

Parameters:: table - The table whose data is being altered; mode - A constant defined in Row which specifies if the row will be used for inserting, deleting, or updating; ec - The current executing context
Returns:: By default Row.class is returned, subclass may override and return a subclass of Row
Throws:: CMException

getDisplayValue

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

Deprecated.

Gets the display value for the field with the given name.

Throws:: CMException

getDisplayValueByUsageId

public java.lang.Object getDisplayValueByUsageId(int usageId)
                                          throws CMException

Get a display value from this Row for the given usage id.

Throws:: CMException

getDisplayValueForKey

public java.lang.Object getDisplayValueForKey(java.lang.Object valueKey)

Get a display value from this row. Note: Subclasses may override and use this method to return any value for a given key. Allows for a row subclass to handle complex computations and return their values in one central location.

getExternalName

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

Gets the external name of a field

Throws:: CMException

getExternalNames

public java.util.List getExternalNames()
                                throws CMException

Gets the external names of this RowCollection's fields

Throws:: CMException

getFDFData

public java.lang.StringBuffer getFDFData(java.lang.StringBuffer pFDFData)

This returns a StringBuffer containing all necessary FDF data for this object. Creation date: (2/4/2002 4:11:45 PM)

Specified by:: getFDFData in interface IFDFObject

getFDTable

public Table getFDTable()

Get's a table to use when searching for FDs. This allows the user to override in cases where a View should use the same FDs as a physical table.

getField

public Field getField(int pIndex)

Returns the Field at the specified index in this Row. The first Field has an index of 1.

Parameters:: pIndex - int
Returns:: Field

getField

public Field getField(java.lang.String fieldName)

Returns the Field for the given name, or null if no such Field exists.

getField

public Field getField(java.lang.String name,
                      boolean create)

Get the Field in this Row with the given name. If the Field doesn't exist and the flag is set to create the Field, then the Field will be created. If the Field is derived it will be created no matter what if it doesn't exist.

Parameters:: name - name of Field; create - flag indicating if Field should be created.
Returns:: Field for the given name. null if doesn't exist.

getFieldAssociationOperation

public Operation getFieldAssociationOperation(Field field)
                                       throws CMException

Gets the association's operation for the given Field

Throws:: CMException

getFieldCollection

protected FieldCollection getFieldCollection()

Returns a FieldCollection object containing a List of Field names along with a Map of Fields keyed by Field name.

Returns:: FieldCollection

getFieldDefaultValue

public java.lang.Object getFieldDefaultValue(Field field,
                                             ExecutingContext ec)
                                      throws CMException

Get the field's default value as a String.

Throws:: CMException

getFieldDescriptor

public FieldDescriptorRow getFieldDescriptor(Field pField,
                                             FieldDescriptorRow pFieldDescriptor)
                                      throws CMException

Row subclasses can override this method to return the a clone of the default FD added by TJH Jun 22, 2004 11 : 49 : 27 PM to allow Rows to return different FDs for this field. This is useful in the case where the same field may be used for more than one case.

Parameters:: pField - Field; pFieldDescriptor - FieldDescriptorRow
Returns:: FieldDescriptorRow
Throws:: CMException

getFieldDescriptor

public FieldDescriptorRow getFieldDescriptor(java.lang.String pFieldName)
                                      throws CMException

Return the IFieldDescriptor for the Field with the specified name.

Parameters:: pFieldName - String
Returns:: IFieldDescriptor
Throws:: CMException

getFieldDescriptor

public FieldDescriptorRow getFieldDescriptor(java.lang.String pFieldName,
                                             Table pTable)
                                      throws CMException

Return the IFieldDescriptor for the Field with the specified name.

Parameters:: pFieldName - String
Returns:: IFieldDescriptor
Throws:: CMException

getFieldDescriptorsWithUsage

public java.util.List getFieldDescriptorsWithUsage()
                                            throws CMException

Deprecated. ask for fields with usage ids rather than fielddescriptors

Get a Collection of FieldDescriptorRows for this Row that have a UsageId defined for them.

Returns:: List
Throws:: CMException

getFieldDescriptorsWithUsageId

public java.util.List getFieldDescriptorsWithUsageId(int usageId)
                                              throws CMException

Deprecated. ask for fields with usage ids rather than fielddescriptors

Get a Collection of FieldDescriptorRows for this Row that have the given UsageId defined for them.

Returns:: List
Throws:: CMException

getFieldDescriptorWithUsageId

public FieldDescriptorRow getFieldDescriptorWithUsageId(int usageId)
                                                 throws CMException

Deprecated. ask for field with usage ids rather than fielddescriptors

Get a FieldDescriptorRow for this Row that have the given usage id defined for them. If more than one FD has the given usage id, the first one is returned.

Returns:: FieldDescriptorRow
Throws:: CMException

getFieldDisplayComponent

public int getFieldDisplayComponent(java.lang.String fieldName)
                             throws CMException

Gets the display component which should be used to display the specified field. Display component constants are defined in IFieldData

Throws:: CMException

getFieldDisplayOrder

public int getFieldDisplayOrder(Field field)

Gets the order of which the given Field will appear in its FieldSet

getFieldDisplayValue

public java.lang.Object getFieldDisplayValue(java.lang.String fldNam)

Returns the display value for the Field with the specified name.

Returns:: Object

getFieldDisplayValue

public java.lang.Object getFieldDisplayValue(Field field)
                                      throws CMException

Returns the display value for the Field with the specified name.

Throws:: CMException

getFieldExternalName

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

Gets the external name of a field

Throws:: CMException

getFieldFieldClassParameters

public java.lang.String[] getFieldFieldClassParameters(Field field)

Gets the parameters for the given Field.

getFieldFieldSetName

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

getFieldIncrementor

public IFieldIncrementor getFieldIncrementor(Field f)

Gets the incrementor for the field By default, Fields will use the same incrementor for their values. There are special cases where users might want to have a special incrementor. For example, Wabash wanted to have an auto increment field that tacked the year onto the number. So, for auto incremented #'s 100, 101, and 102, for the year 2003 they would want the incrementor to return 10003, 10103, and 10203.

getFieldMaxLength

public int getFieldMaxLength(java.lang.String fieldName)
                      throws CMException

Get the max length of the Field with the given name. If Field does not exist, -1 is returned.

Parameters:: fieldName -
Returns:
Throws:: CMException

getFieldNames

public java.util.List getFieldNames()

Return a List of all the Field names in this Row.

Returns:: List

getFieldNames

public java.util.List getFieldNames(Table table)
                             throws CMException

Gets the names of all fields in this row which are from the specified table. When a given field name is present in more than one of this row's tables, it will be returned in the Lists for all such tables.

Throws:: CMException

getFieldPossibleValues

public RowCollection getFieldPossibleValues(Field fld)
                                     throws CMException

Returns a RowCollection containing the possible values for the Field.

Parameters:: fld - Field
Returns:: RowCollection
Throws:: CMException

getFields

public java.util.List getFields(java.lang.Class pFieldClassType)

Returns a List of Fields for requested Class type.

getFields

public java.util.Map getFields(java.util.List pFieldNames)
                        throws CMException

Returns a Map of Fields in this Row from the names given in the List.

Parameters:: pFieldNames - List of Field names
Returns:: Map
Throws:: CMException

getFieldSearchDefaultValue

public java.lang.Object getFieldSearchDefaultValue(Field field,
                                                   ExecutingContext ec)

Gets the default value for the field when it is being used in a search

getFieldSets

public java.util.List getFieldSets()
                            throws CMException

Gets a List of the FieldSet objects, containing the fields in this Row

Throws:: CMException

getFieldsForInsert

protected java.util.Map getFieldsForInsert(ExecutingContext ec)
                                    throws CMException

Gets the fields which should be inserted when this row is inserted. They are returned in a Map, where the field name is mapped to the Field object. A return value of null means to use all non-derived fields.

Throws:: CMException

getFieldSQLObject

public java.lang.Object getFieldSQLObject(java.lang.String fieldName)
                                   throws CMException

Gets this field's value as an Object in SQL format.

Throws:: CMException

getFieldsToDisplay

public java.util.List getFieldsToDisplay()

Return a List of all the Field names that will be displayed by default.

Returns:: List

getFieldsToDisplayStrict

public java.util.List getFieldsToDisplayStrict(ExecutingContext pEc)

Return a List of all the Field names that will be displayed by default. Same as getFieldsToDisplayExcept checks for DISPLAY_RULE_NEVER and !isAuthorizedForRead();

Returns:: List

getFieldsToDisplayStrict

public java.util.List getFieldsToDisplayStrict(java.util.List fieldNames,
                                               ExecutingContext ec)

Removes fields from the list that should not be displayed.

Returns:: List

getFieldStatusChange

public int getFieldStatusChange(Field field)
                         throws CMException

Returns whether or not we notify on a status change for the specified field

Throws:: CMException

getFieldStyleClass

public java.lang.String getFieldStyleClass(Field field,
                                           java.lang.String value,
                                           java.lang.String displayValue,
                                           ExecutingContext ec)

Get a Field's style. Row subclasses may override to special case handle custom styles for Fields.

Parameters:: field - The Field in which to get the style of
Returns:: Field's style.

getFieldsWithUsageId

public java.util.List getFieldsWithUsageId(int usageId)

Get the Fields in this Row that have the specified usage id.

getFieldUsageIds

public int[] getFieldUsageIds(Field field)

Gets the usage ids of this field. Note: Subclasses may override, but usage id methods on the field parameter should never be called.

getFieldValue

public java.lang.Object getFieldValue(java.lang.String pFieldName)

Gets a field in this Row by name.

Returns:: The field whose name was passed in, or Null if no such field exists in this Row

getFieldValueWithUsageId

public java.lang.Object getFieldValueWithUsageId(int usageId)

Gets a field in this Row for the given usage id and returns its value.

getFieldWithUsageId

public Field getFieldWithUsageId(int usageId)

Get the Field with the given usage id from this row.

getHeaderText

public java.lang.String getHeaderText(ExecutingContext ec)

Returns information for the user that will be displayed in the header of the Row

Returns:: String

getHorizontalAlignment

public short getHorizontalAlignment(Field field,
                                    ExecutingContext ec)
                             throws CMException

Gets the alignment for the specified field, when it is rendered in a non-HTML way

Throws:: CMException

getJSPFor

public java.lang.String getJSPFor(int mode)

Get the JSP to open for the given mode when going to the Row's detail page.

getKeyFields

public java.util.List getKeyFields()
                            throws CMException

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

Throws:: CMException

getKeyFieldNames

public java.util.List getKeyFieldNames()
                                throws CMException

Throws:: CMException

getKeyFields

public java.util.List getKeyFields(boolean returnPartial)
                            throws CMException

Returns the key fields for this Row.

Parameters:: returnPartial - If this is false, and this Row does not contain all keys fields from its tables, then null is returned. If it is true, then a partial listing of the all of the key fields contained in this row is returned.
Throws:: CMException

getLibraryName

public java.lang.String getLibraryName()

Returns the Library's name to which the Table belongs to.

Returns:: String

getMaxFieldLengths

public int getMaxFieldLengths()
                       throws CMException

Returns the max lengths of each field in this row added together. Heading information is not included when calculating this value. Creation date: (1/24/2002 12:03:58 PM)

Throws:: CMException

getMaxFieldLengths

public int getMaxFieldLengths(FileDescriptor fled)
                       throws CMException

Returns the max lengths of each field in this row added together.

Throws:: CMException

getMaxInsertRetries

public int getMaxInsertRetries()

Number of times to attempt to re-insert a Row when a duplicate key exception was encountered. Upon duplicate key, autoincrement Fields are incremented and the insert is attempted again. Subclasses may override to allow for a different number insert retry attempts.

Returns:: number of retries on insert.

getMetaDataSystemAlias

public java.lang.String getMetaDataSystemAlias()

Returns the meta data alias of the system to which this Row belongs

Returns:: String

getNamed

public INamed getNamed(int i)

Specified by:: getNamed in interface INamedCollection

getNamed

public INamed getNamed(java.lang.String name)

Specified by:: getNamed in interface INamedCollection

getNamesOfUpdatedFields

public java.util.List getNamesOfUpdatedFields()
                                       throws CMException

Return the names of all of the Fields in this Row that have been updated.

Throws:: CMException

getNavigationKey

public java.lang.String getNavigationKey()

Get the key used to store/retrieve this Row to/from navigation.

Specified by:: getNavigationKey in interface INavigationObject

getNavigationListKey

public java.lang.String getNavigationListKey()

Get the key used to store and retrieve a List of Rows that have been put into navigation. If any subclasses need to be grouped separate, they can override this method and specify their own navigation list key.

Specified by:: getNavigationListKey in interface INavigationObject

getNextOperationToRun

public java.lang.Number getNextOperationToRun(Operation currentOp,
                                              ExecutingContext context)
                                       throws CMException

Get the next operation number (ID) that is to be run, by default this will return the operations "completed or next operation" as specified in the WOW operation spec. Subclasses may override to programically return a different operation to run. Returning NULL indicates that their is no next operation.

Throws:: CMException

goToNextOperation

public void goToNextOperation(int rowsChanged,
                              int mode,
                              ExecutingContext context)
                       throws CMException

Goto the next operation if specified and execute it. In WOW's SQL Operation, a completed operation can be set on an operation.

Throws:: CMException

getOperation

public Operation getOperation()

Gets the Operation which read this row from the DB. If there is no such operation, then null is returned

getOperation

public Operation getOperation(boolean checkCreationOp)
                       throws CMException

Gets the Operation which read this row from the DB or created this row. If there is no such operation, then null is returned

Parameters:: checkCreationOp - If this row does not have an operation which read it from the DB and this parameter is true, then the operation which created the row is returned (if such an operation exists). If this parameter is false and there is no operation which read this row from the DB, the create op is not examined, and null is returned.
Throws:: CMException

getOperationFromDB

protected Operation getOperationFromDB(int pId)
                                throws CMException

Gets a SQLOperation. This method should only be invoked inside a synchronized block

Throws:: CMException

getOperationFromDBByUsage

protected Operation getOperationFromDBByUsage(int usageId)
                                       throws CMException

Get an Operation from the database for teh given usage id.

Throws:: CMException

getPercentage

public double getPercentage(java.lang.String[] fieldNames)
                     throws CMException

Gets the percentage of the first field compared with all the fields given.

Example: {"A", "B"} would result in A / (A+B), and {"C", "A", "B"} would result in C / (C + A + B)

Parameters:: fieldNames - String[] of fields names to get percentage for.
Throws:: CMException

getPhysicalFieldNames

public java.util.List getPhysicalFieldNames()
                                     throws CMException

Gets a List of the names of all Fields in this Row, excluding logical Fields

Throws:: CMException

getPossibleValueClass

public java.lang.String getPossibleValueClass(Field field)

Returns the fully qualified name for a class implementing the IPossibleValueGetter interface which will handle the retrieving of possible values for the specified field Default behavior is to ask the FD

getPossibleValueClass

public final java.lang.String getPossibleValueClass(java.lang.String fieldName)

Deprecated. - no longer used, pass in the Field object instead

Returns:: String

getPossibleValues

public RowCollection getPossibleValues(Field fld)
                                throws CMException

Returns a RowCollection containing the possible values for the Field.

Parameters:: fld - Field
Returns:: RowCollection
Throws:: CMException

getPossibleValuesKey

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

Gets the possible values SQLOperation for the specified field

Throws:: CMException

getPossibleValuesOperation

public Operation getPossibleValuesOperation(Field field)
                                     throws CMException

Gets the possible values Operation for the specified field

Throws:: CMException

getPropertyChangeSupport

protected DataEnginePropertyChangeSupport getPropertyChangeSupport()

Gets the property change support object for this row.

getPropertyGroup

public PropertyGroup getPropertyGroup(java.lang.String groupName)

Gets the first PropertyGroup with the given property group name.

getPropertyGroups

public PropertyGroupList getPropertyGroups()

Get all the property groups stored in this RowCollection's attributes.

getPropertyGroups

public java.util.List getPropertyGroups(java.lang.String groupName)

Get this RowCollection's property groups with the given group name.

getReplacementFieldsToDisplay

public java.util.List getReplacementFieldsToDisplay(java.util.List originalFields)

Get a list of field names to override the original fields to display for this Row.

Parameters:: originalFields - The fields that will normally be displayed
Returns:: A List containing the field names to display, or null if WOW should use the default display fields

getReplacementFieldsToDisplay

public java.util.List getReplacementFieldsToDisplay(java.util.List originalFields,
                                                    ExecutingContext ec)

Get a list of field names to override the original fields to display for this Row.

Parameters:: originalFields - The fields that will normally be displayed; ec - The executing context
Returns:: A List containing the field names to display, or null if WOW should use the default display fields

getRequiredFields

public java.util.Iterator getRequiredFields()

Iterates through the fields in this Row which are required

getRow

protected Row getRow(java.util.List columns)
              throws CMException

Gets a Row from this Row's SQL that contains the proper given column names. If this Row already contains all the given names, it will return itself.

Throws:: CMException

getRowCollection

public RowCollection getRowCollection()

Gets the first RowCollection this Row is contained in. (Null if no RowCollection)

Returns:: RowCollection

getRowDisplayAttributes

public java.lang.String getRowDisplayAttributes()
                                         throws CMException

Returns a String containing style information which should be used when displaying this Row (for Rows displayed using HTML, this is the name of a CSS style class).

Throws:: CMException

getRowDisplayAttributes

public java.lang.StringBuffer getRowDisplayAttributes(java.lang.StringBuffer html)
                                               throws CMException

Deprecated. This method is no longer used

Return a String that provides HTML or other display characteristics of this Row. Subclasses can override and return a String such as "class=\"pjr-yellow\"" which will be included in the HTMLGenerator.generateTable() method.

Throws:: CMException

getRowKey

public RowKey getRowKey()
                 throws CMException

Gets the RowKey object for this row. This will be null if this row does not have a key

Throws:: CMException

getSecuredTypeId

public int getSecuredTypeId()

Gets the id of the secured type.

Specified by:: getSecuredTypeId in interface IGuarded

getSecuredTypeName

public java.lang.String getSecuredTypeName()

Gets the secured type name of the secured object.

Specified by:: getSecuredTypeName in interface IGuarded

getSecurityType

public int getSecurityType()

Gets the type of security being used. Below is a list of possible securities.

0 - Unsecured 1 - Secured 2 - Admins Only 3 - PJ Admins Only

Specified by:: getSecurityType in interface IGuarded

Returns:: security type

getSQL

public java.lang.String getSQL()

Gets the SQL statement used to create this Row.

getSQLContext

public SQLContext getSQLContext()

Returns SQLContext to which the RowCollection this Row belongs has.

getStaticAttribute

public java.lang.Object getStaticAttribute(java.lang.Object key)

getStaticAttributes

protected java.util.Map getStaticAttributes()

getSum

public double getSum(java.lang.String[] pFieldNames)
              throws CMException

Returns the sum of all the fields represented in pFieldNames if that field is a number

Example: double totalCash = bankRow.getSum(new String[]{"TotalChecking", "TotalSavings", "TotalBonds");

Parameters:: pFieldNames - String[] fieldNames to add together
Throws:: CMException

getSystemAlias

public java.lang.String getSystemAlias()

Returns the alias of one of the systems to which this Row belongs.

Returns:: String

getDBSystem

public DBSystem getDBSystem()

Get the system object this Row.

getTabbedOperation

public TabbedOperation getTabbedOperation()

Gets the TabbedOperation which corresponds to this row. If this row does not correspond to any tabbed operation then null is returned.

getTable

public Table getTable()

Get's this field's table. If row has more than one table, the first one is returned

getTable

public Table getTable(int pTableIndex)

getTableName

public java.lang.String getTableName()

Returns the name of the Table of this Row.

Returns:: String

getTables

public TableCollection getTables()

Get's this field's table.

getTimestamp

public long getTimestamp()

Gets the time when this Row was read from the database, or Long.MIN_VALUE if the time cannot be determined

getUpdatedFields

public java.util.Map getUpdatedFields()
                               throws CMException

Return the names of all the fields.

Returns:: Map
Throws:: CMException

getUserMessageForOperation

public java.lang.String getUserMessageForOperation(int mode)

Return a message to the user after an operation completes. This allows you to return something besides the generic "1 row updated, etc" By default, return null which will use the default message from the request.

See Also:: (see Row constants to find the modes.

getUserMessageForOperation

public java.lang.String getUserMessageForOperation(int rowsChanged,
                                                   int mode)

See Also:: (see Row constants to find the modes.

getErrorMessageForOperation

public java.lang.String getErrorMessageForOperation(int mode,
                                                    java.lang.Throwable t)

See Also:: (see Row constants to find the modes.

getUseWOWLibrary

public short getUseWOWLibrary()

getValidationExceptions

public ValidationExceptionCollection getValidationExceptions()

Be careful when you call this method because it is derived and spins through all the fields. This will return a collection of al the Exceptions of each field Creation date: (4/5/2002 2:01:13 PM)

Returns:: planetj.exception.ValidationExceptionCollection

getValueAsBoolean

public boolean getValueAsBoolean(java.lang.String pFieldName)

Returns a primitive that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: boolean

getValueAsByte

public byte getValueAsByte(java.lang.String pFieldName)

Returns a primitive that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: byte

getValueAsDate

public java.util.Date getValueAsDate(java.lang.String pFieldName)

Returns a Date

Parameters:: pFieldName - String that must be the field name of a DateField
Returns:: java.util.Date

getValueAsDate

public java.util.Date getValueAsDate(java.lang.String pYearFldName,
                                     java.lang.String pMonthFldName,
                                     java.lang.String pDayFldName)

Returns a Date that represents the Date value of 3 seperate fields.

Returns:: java.util.Date

getValueAsDouble

public double getValueAsDouble(int fieldIndex)

Gets a primitive that represents the value in the specified field.

Parameters:: fieldIndex - Index of the Field in this Row
Returns:: double

getValueAsDouble

public double getValueAsDouble(java.lang.String pFieldName)

Returns a primitive that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: double

getValueAsFloat

public float getValueAsFloat(java.lang.String pFieldName)

Returns a primitive that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: float

getValueAsFullLengthString

public java.lang.String getValueAsFullLengthString(java.lang.String pFieldName)
                                            throws CMException

Returns a String that represents the value in the specified field. Pads any numberic fields with leading/trailing zeros to match their max defined sizes. Example: a Numberic 7 long will be returned as "0000044" while a Decimal 5,2 will be "00044.12"

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: String
Throws:: CMException

getValueAsInt

public int getValueAsInt(int index)

Returns a primitive that represents the value in the specified field.

Returns:: int

getValueAsInt

public int getValueAsInt(java.lang.String pFieldName)

Returns a primitive that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: int

getValueAsLong

public long getValueAsLong(java.lang.String pFieldName)

Returns a primitive that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: long

getValueAsNumber

public java.lang.Number getValueAsNumber(int fieldIndex)

Gets a primitive that represents the value in the specified field.

Parameters:: fieldIndex - Index of the Field in this Row
Returns:: Number

getValueAsNumber

public java.lang.Number getValueAsNumber(java.lang.String pFieldName)

Returns a Number that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: Number

getValueAsShort

public short getValueAsShort(java.lang.String pFieldName)

Returns a primitive that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: short

getValueAsString

public java.lang.String getValueAsString(int fieldIndex)

Gets a String that represents the value in the specified field.

Parameters:: fieldIndex - Index of the Field in this Row
Returns:: String

getValueAsString

public java.lang.String getValueAsString(java.lang.String pFieldName)

Returns a String that represents the value in the specified field.

Parameters:: pFieldName - java.lang.String The name of the field
Returns:: String

getValueAsStringByUsageId

public java.lang.String getValueAsStringByUsageId(int usageId)

Get a String value from this Row for the given usage id.

getValueByUsageId

public java.lang.Object getValueByUsageId(int usageId)
                                   throws CMException

Get a value from this Row for the given usage id.

Throws:: CMException

getValueForKey

public java.lang.Object getValueForKey(java.lang.Object valueKey)

Get a value from this row. Note: Subclasses may override and use this method to return any value for a given key. Allows for a row subclass to handle complex computations and return their values in one central location.

getValues

public java.util.Iterator getValues()

Returns an iterator which iterates over the values in this Row

getXMLData

public java.lang.StringBuffer getXMLData(java.lang.StringBuffer pXMLData)

This returns a StringBuffer containing all necessary XML data for this object. Creation date: (1/21/2002 8:16:25 PM)

Specified by:: getXMLData in interface IXMLObject

getXMLData

public java.lang.StringBuffer getXMLData(XMLFileDescriptor pDescriptor,
                                         java.lang.StringBuffer pXMLData)

This returns a StringBuffer containing all necessary XML data for this object. Creation date (1/21/2002 8:16:25 PM)

Parameters:: pDescriptor - Describes what XML data to output; pXMLData - StringBuffer to write to
Returns:: StringBuffer containing all necessary XML data for this object

getXMLHeaderData

public java.lang.StringBuffer getXMLHeaderData(java.lang.StringBuffer pXMLData)

This returns a StringBuffer containing all XMLHeader data for this Row. This information will be commented in the XML file and used for information only

Creation date: (2/12/2002 5:42:05 PM)

handleAction

public java.lang.Object handleAction(java.lang.String action,
                                     ExecutingContext ec)
                              throws CMException

Description copied from interface: IActionObject

Check to see if this Row has child rows.

Specified by:: handleAction in interface IActionObject

Throws:: CMException

isActionRepeatable

public boolean isActionRepeatable(java.lang.String action,
                                  ExecutingContext ec)

hasAssociationOperation

public boolean hasAssociationOperation(Field field,
                                       ExecutingContext ec)

Tests if a field has an association operation.

Parameters:: field -; ec -

hasChildRows

public boolean hasChildRows()

Check to see if this Row has child rows.

hasMultipleStyleClasses

public boolean hasMultipleStyleClasses(Field field,
                                       ExecutingContext ec)

Check if the given Field possibly has more than one style class.

Parameters:: field - Field to see if more than one style class exists; ec - current context in which code is executing
Returns:: whether or not Field has multiple styles

hasPossibleValuesKeyClassOrOp

public boolean hasPossibleValuesKeyClassOrOp(Field field)

Tests if the specified field has any type of Possible Values

hasPropertyChangeListeners

public boolean hasPropertyChangeListeners(java.lang.String pProperty)

Tests if any object are listening to this Row for changes in one of its properties.

Parameters:: pProperty - The property whose listeners are of interest

incrementFieldValue

public void incrementFieldValue(Field field,
                                ExecutingContext ec)
                         throws CMException

Increment this Field's value.

Parameters:: field -; ec -
Throws:: CMException

initializeRow

protected final void initializeRow()
                            throws CMException

Creates Field's for this Row based upon the Row's Table's FieldDescriptors. The Fields are then set to their default value.

Throws:: CMException

initializeRow

protected final void initializeRow(boolean allFields)
                            throws CMException

Creates Field's for this Row based upon the Row's Table's FieldDescriptors. The Fields are then set to their default value.

Throws:: CMException

initializeRow

protected final void initializeRow(boolean allFields,
                                   ExecutingContext pExecutingContext)
                            throws CMException

Creates Field's for this Row based upon the Row's Table's FieldDescriptors. The Fields are then set to their default value.

Throws:: CMException

initializeRow

protected final void initializeRow(ExecutingContext pExecutingContext)
                            throws CMException

Creates Field's for this Row based upon the Row's Table's FieldDescriptors. The Fields are then set to their default value.

Throws:: CMException

initializeRow

protected final void initializeRow(java.util.List fieldNames)
                            throws CMException

Creates Fields for this Row for the given List of field names based upon the Row's Table's FieldDescriptors. The Fields are then set to their default value.

Throws:: CMException

initializeRow

protected void initializeRow(java.util.List fieldNames,
                             ExecutingContext ec)
                      throws CMException

Creates Fields for this Row for the given List of field names based upon the Row's Table's FieldDescriptors. The Fields are then set to their default value.

Throws:: CMException

insert

public final int insert()
                 throws CMException

Inserts this Row into its table.

Returns:: The number of Rows that were inserted
Throws:: CMException

insert

public final int insert(java.sql.Connection conn)
                 throws CMException

Inserts this Row into its table.

Returns:: The number of Rows that were inserted
Throws:: CMException

insert

public int insert(ExecutingContext ec)
           throws CMException

Inserts this Row into the specified database.

Returns:: The number of Rows that were inserted
Throws:: CMException

insert

public int insert(SQLContext context)
           throws CMException

Inserts this Row into the specified database.

Returns:: The number of Rows that were inserted
Throws:: CMException

is

public boolean is(java.lang.String pFieldName)
           throws DataEngineException

Gets the specified field and returns the boolean value. This method assumes that this field is a boolean field that has it's value specified as either 'true' or 'false'.

Parameters:: pFieldName - java.lang.String
Returns:: boolean
Throws:: java.lang.Exception; DataEngineException

isActionApplicable

public boolean isActionApplicable(java.lang.String actionName,
                                  ExecutingContext ec)
                           throws CMException

Check to see if the action is applicable in the Row's current state

Specified by:: isActionApplicable in interface IActionObject

Throws:: CMException

isARow

public final boolean isARow()

Return a boolean indicating if this object is a Row

Returns:: boolean

isARowCollection

public final boolean isARowCollection()

Return a boolean indicating if this object is a RowCollection

Returns:: boolean

isChanged

public boolean isChanged()

Returns whether or not this Row's Fields have changed. Ignore CURRENT VALUE fields.

Returns:: boolean

isChanged

public boolean isChanged(boolean ignoreLogical)

Returns whether or not this Row's Fields have changed. Ignore CURRENT VALUE fields.

Parameters:: ignoreLogical - When true the logical fields are not examined
Returns:: boolean

isChangedRealTime

public boolean isChangedRealTime(boolean realTimeCheck)

Deprecated.

Returns whether or not this Row's Fields have changed. Accepts boolean to determine if RealTimeFields should be checked for change.

Returns:: boolean

isChangedSinceLastCheck

public boolean isChangedSinceLastCheck()

This method has been created as a temporary fix. Not safe concurrently. Should be remove after email issues resolved. Returns whether or not this Row's Fields have changed since the last time checked. Always set to false after check is performed.

Returns:: boolean

isCloneNeeded

public boolean isCloneNeeded()

Description copied from interface: INavigationObject

Test to see if tiis navigation object should be clone upon storing and retrieving.

Specified by:: isCloneNeeded in interface INavigationObject

isContainsAllFields

public boolean isContainsAllFields()
                            throws CMException

Returns whether or not this Row contains all the Fields of its Table.

Returns:: boolean
Throws:: CMException

isCopyable

public boolean isCopyable(ExecutingContext ec)

Check to see if this Row may be copyable. By default, all Rows may be copyable. Subclasses may override to implement a different behavior.

Parameters:: ec - context in which application is executing.
Returns:: true if Row may be copyable; false otherwise.

isCurrent

public boolean isCurrent()

Tests if any of this row's tables have been updated via the DataEngine since this row was read from the DB

isDeletable

public boolean isDeletable(ExecutingContext ec)

Check to see if this Row may be deletable. By default, all Rows may be deletable. Subclasses may override to implement a different behavior.

Parameters:: ec - context in which application is executing.
Returns:: true if Row may be deletable; false otherwise.

isDistinctRow

public boolean isDistinctRow()

Test to see if this Row was created with distinct values.

Returns:: boolean

isEditable

public boolean isEditable(ExecutingContext ec)

Check to see if this Row may be edited. By default, all Rows may be edited. Subclasses may override to implement a different behavior.

Parameters:: ec - context in which application is executing.
Returns:: true if Row may be edited; false otherwise.

isEmpty

public boolean isEmpty()

Returns whether or not this Row has any Fields.

isFieldApplicable

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

Tests if a field is applicable in the current scenario

Parameters:: fld - The field which may or may not be applicable
Throws:: CMException

isFieldAuthorizedForEdit

public boolean isFieldAuthorizedForEdit(Field pField,
                                        ExecutingContext pContext)

Tests if a field is authorized for edit. The default behavior is to ask the FD, but subclasses may override this method and implement a different behavior.

Parameters:: pField - The whose read only status is being tested; pContext - The current executing context which may be null

isFieldAuthorizedForRead

public boolean isFieldAuthorizedForRead(Field pField,
                                        ExecutingContext pContext)

Tests if a field is authorized for read. The default behavior is to ask the FD, but subclasses may override this method and implement a different behavior.

Parameters:: pField - The whose read only status is being tested; pContext - The current executing context which may be null

isFieldAutoIncrement

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

Is the specified field an auto-increment field?

Parameters:: field -; ec -
Returns:
Throws:: CMException

isFieldAutoIncrementWOWDriven

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

Is the given Field a WOW driven auto increment field.

Parameters:: field -; ec -
Returns:
Throws:: CMException

isFieldAutoIncrementDatabaseDriven

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

Is the given Field a database driven auto increment field.

Parameters:: field -; ec -
Returns:
Throws:: CMException

isFieldPresent

public boolean isFieldPresent(java.lang.String fieldName)

Tests if a field with the specified name is present in this Row or not

isFieldDisplayable

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

Check to see if this Field is displayable.

Parameters:: ec - context in which code is running.
Returns:: true if Field is displayable
Throws:: CMException

isFieldReadOnly

public boolean isFieldReadOnly(Field pField,
                               ExecutingContext pContext)

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

Parameters:: pField - The whose read only status is being tested; pContext - The current executing context which may be null

isFieldReadOnlyOnSearch

public boolean isFieldReadOnlyOnSearch(Field field,
                                       ExecutingContext ec)

Test if the field is read only on search. By default, no Field is read only.

Parameters:: field - The whose read only status is being tested; ec - The current executing context which may be null

isFieldRequired

public boolean isFieldRequired(Field pField,
                               ExecutingContext pContext)

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

Parameters:: pField - The whose required status is being tested; pContext - The current executing context which may be null

isFieldRequiredOnSearch

public boolean isFieldRequiredOnSearch(Field pField,
                                       ExecutingContext pContext)

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

Parameters:: pField - The whose required status is being tested; pContext - The current executing context which may be null

isFieldsChanged

public boolean isFieldsChanged(java.util.List names)

Check to see if any of this Row's Fields have changed for the given list of Field names.

Parameters:: names - names of Fields to check if changed. If null, all Fields are checked.
Returns:: true if any of this Row's Fields for the given names have changed

isFieldUpdateable

public boolean isFieldUpdateable(Field f)

Tests if the field is updateable. By default all fields are updateable

isFieldValueNotBlank

public boolean isFieldValueNotBlank(java.lang.String fieldName)

Returns whether or not this Field is not blank

isFieldValuePossibleValue

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

Tests if the field's value is a possible value. When this method returns true and the field is rendered as an editable select then the select portion of the editable select will be initially enabled. When this method returns false, the text field/area portion of the editable select will be initially enabled. (This method is only invoked for rendering editable selects.)

Throws:: CMException

isFieldValuesDatabaseDefaults

public boolean isFieldValuesDatabaseDefaults(java.lang.String[] pFieldNames)
                                      throws CMException

Deprecated. We should use the default value from the field descriptor instead.

Checks each field value of fieldNames[] to see if it matches the database default for that field

Parameters:: pFieldNames - String[] fieldNames to compare to default values
Returns:: boolean true if every value for each fieldNames[] equals(getDatabaseDefaultValue())
Throws:: CMException

isGenerateChildRows

public boolean isGenerateChildRows()

Check to see if this Row has child rows and if they should be generated when this Row generates.

isGroupByRow

public boolean isGroupByRow()

Return whether or not this Row was created with a group by in the SQL clause.

Returns:: boolean

isGuarded

public boolean isGuarded()

Check whether this Row is protected (secured)

Specified by:: isGuarded in interface IGuarded

Returns:: boolean

isHasColumnNames

public boolean isHasColumnNames(java.util.List columns)
                         throws CMException

Checks to see if this RowCollection has all the columns in the given List.

Throws:: CMException

isInARowCollection

public boolean isInARowCollection()

Returns whether or not this Row belongs to a RowCollection.

Returns:: boolean

isIncrementorResetAfterMaxInsertRetries

public boolean isIncrementorResetAfterMaxInsertRetries(Field field)

Check if the FieldIncrementor for the given Field should be reset after the max number of insert retries is attempted.

Returns:: if incrementor should be reset for the given Field.

isInitializeDerivedFieldEnabled

public boolean isInitializeDerivedFieldEnabled(java.lang.String fieldName)

Tells whether or not to initialize a Derived FD upon row creation. The default behavior is false. Subclassing rows can change this behavior.

isInitializeDerivedFieldsEnabled

public final boolean isInitializeDerivedFieldsEnabled()

Deprecated. This method isn't so good because it doesn't let you specify which fields get initialized & which don't. But there might be subclassses that implemented it, so I guess we're stuck with it for now. isInitializeDerivedFieldEnabled(String) is the replacement which subclasses should override

Tells whether or not to initialize Derived FDs upon row creation. The default behavior is false. Subclassing rows can change this behavior (but shouldn't use this method since it is deprecated).

isJoinedRow

public boolean isJoinedRow()

Check if Row was created from a join.

Returns:: boolean

isKeyFieldsPresent

public boolean isKeyFieldsPresent()
                           throws CMException

Returns whether or not this Row contains all the key Fields of its Table. This method only checks the first table of the Row. To check and see if this Row contains all key fields from all of its tables, you should use the getKeyFields() method instead.

Returns:: boolean
Throws:: CMException

isLogicalRow

public boolean isLogicalRow()

Tests if this Row is a logical Row. A logical Row cannot exist in the database. Subclasses may override this method

isMultipleDeleteEnabled

public boolean isMultipleDeleteEnabled()

Returns whether or not multiple record deletes are allowed.

isParameterRow

public boolean isParameterRow()

Tests if this row is used to generate parameters

isPersistent

public boolean isPersistent()

Tests if this row has been persisted to the database. The main purpose of this method is to determine if this row has ever been in the DB, or if it only lives in memory. For performance reasons this method does not check the database, and instead relies upon its last known state. If this row was read from or written to the DB this method will return true, even though another user may have subsequently deleted it.

isPhysicalRow

public final boolean isPhysicalRow()

Tests if this Row is a physical Row. A physical Row may exist in the database.

isPrepareFieldValue

public boolean isPrepareFieldValue(Field f,
                                   ExecutingContext ec)

Tests if the field's display value needs to be prepared before being displayed. Preparation replaces any formatting chars (like greater than or less than signs in HTML) will be replaced with the appropriate escape chars. When this return false no preparation is done, and any formating chars will remain in the display value

isPropertyChangeEventsEnabled

public boolean isPropertyChangeEventsEnabled()

Tests whether the changing of the value in one of this Row's fields will cause this Row to fire a PropertyChangeEvent or not. The default is true, but if a customized PropertyChangeSupport is used, it may help performance to turn the default PropertyChangeSupport off.

isReturningFromPossibleValuesSearch

public boolean isReturningFromPossibleValuesSearch()

Creation date: (2/9/2003 2:02:05 PM)

Returns:: boolean

isRowDisplayable

public boolean isRowDisplayable(ExecutingContext ec)

Tests if the row can be displayed

isRowKeyed

public boolean isRowKeyed()
                   throws CMException

Tests if this row has a key

Throws:: CMException

isSelectable

public boolean isSelectable()

Tests if the user may select a Row of this type.

isStatusChange

public boolean isStatusChange(Field field)

Check to see if this field is status change.

isToBeSelected

public boolean isToBeSelected()

Tests if the Row should be pre-marked as selected before presented in a RowCollection. The user can override when there is a need to have one or more rows already selected.

isUnionRow

public boolean isUnionRow()

Check if Row was created with a union.

Returns:: boolean

isUpdateable

public boolean isUpdateable()

Tests if this row can be updated. Certain rows (such as those resulting from a join or a GROUP BY) cannot be updated in the usual manner. This method tests whether the row structure allows updates - to control updates based on information contained in the row or the current user profile you should use the isEditable(ExecutingContext) method. Subclasses may override this method only if they have also overridden the update(Connection, ExecutingContext) method - if this method would normally return false, then the update method will normally fail on any update attempts.

isUseRowForFieldSets

public boolean isUseRowForFieldSets()
                             throws CMException

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.

Throws:: CMException

isValidateDerivedFields

public boolean isValidateDerivedFields()

Tests if this Row must validate its derived fields Defaults to false, Subclasses can override this method or set this value via setValidateDerivedFields(true)

isValidateRequired

public boolean isValidateRequired()

Tests if this Row must be validated before it is inserted/updated

isValidationRequiredForAutoPopulate

public boolean isValidationRequiredForAutoPopulate(Field pField,
                                                   ExecutingContext pEC)
                                            throws CMException

Tells whether or not the Field's validate method will be called before the Auto Populate action is executed. The default behavior is true. Creation date: (11/25/2003 9:50:51 AM)

Parameters:: pField - planetj.database.Field; pEC - planetj.dataengine.ExecutingContext
Returns:: boolean
Throws:: CMException

isViewable

public boolean isViewable(ExecutingContext ec)

Check to see if this Row may be viewed. By default, all Rows may be viewed. Subclasses may override to implement a different behavior.

Parameters:: ec - context in which application is executing.
Returns:: true if Row may be viewable; false otherwise.

iterator

public java.util.Iterator iterator()

Creates and returns an iterator which iterates over the fields in this Row

joinedDelete

protected int joinedDelete(java.sql.Connection connection,
                           ExecutingContext ec)
                    throws CMException

Deletes this row from the database. This method is only used when the row contains data from multiple tables. If concurrent alterations to the database prevent this row from being deleted, a ConcurrentAlterationException is thrown.

In general, this method should not be directly invoked, instead one of the delete() methods should be invoked when a joined row needs to be deleted

Parameters:: connection - The connection to use for the delete; ec - The current executing context
Returns:: The total number of records which were deleted in the database. Deleting a single joined row may result in multiple records in different tables being deleted, therefore this method may return a value greater than 1.
Throws:: CMException

joinedInsert

protected int joinedInsert(java.sql.Connection connection,
                           boolean useTransactions,
                           ExecutingContext ec)
                    throws CMException

Inserts the values in this row into the database with the values in this Row. This method is only used when the row contains data from multiple tables. In general, this method should be be directly invoked. One of the insert() methods should be invoked when a joined row needs to be inserted into the database.

Parameters:: connection - The connection to use for the update; useTransactions - Should all of the disjoint inserts be sent to the DB in a single transaction?; ec - The current executing context
Returns:: The total number of records which were inserted in the database. Inserting a single joined row may result in multiple records in different tables being inserted, therefore this method may return a value greater than 1.
Throws:: CMException

joinedInsert

protected int joinedInsert(java.sql.Connection connection,
                           ExecutingContext ec)
                    throws CMException

Parameters:: connection - The connection to use for the update; ec - The current executing context
Returns:: The total number of records which were inserted in the database. Inserting a single joined row may result in multiple records in different tables being inserted, therefore this method may return a value greater than 1.
Throws:: CMException

joinedUpdate

protected int joinedUpdate(java.sql.Connection connection,
                           boolean useTransactions,
                           ExecutingContext ec)
                    throws CMException

Updates the database with the values in this Row. This method is only used when the row contains data from multiple tables. If concurrent alterations to the database prevent this row from being updated, a ConcurrentAlterationException is thrown. In general, this method should not be directly invoked; instead one of the update() methods should be invoked when updating a joined row.

Parameters:: connection - The connection to use for the update; useTransactions - Should all of the disjoint updates be sent to the DB in a single transaction?; ec - The current executing context
Returns:: The total number of records which were updated in the database. Updating a single joined row may result in multiple records in different tables being updated, therefore this method may return a value greater than 1.
Throws:: CMException

joinedUpdate

protected int joinedUpdate(java.sql.Connection connection,
                           ExecutingContext ec)
                    throws CMException

Parameters:: connection - The connection to use for the update; ec - The current executing context
Returns:: The total number of records which were updated in the database. Updating a single joined row may result in multiple records in different tables being updated, therefore this method may return a value greater than 1.
Throws:: CMException

joinedDatabaseAccessFailure

protected int joinedDatabaseAccessFailure(java.sql.Connection conn,
                                          Row disjointRow,
                                          TableCollection affectedTables,
                                          int mode,
                                          java.lang.Throwable t,
                                          ExecutingContext ec)
                                   throws CMException

Invoked whenever a update, insert, or delete fails on a disjoint row during a joined DB access. (A joined DB access is split up into multiple disjoint DB accesses, each of which affects only a single table.) There are two ways a disjoint DB access can fail: either due to an exception, or because it affected 0 rows in the database.

If this method returns normally, then it is assumed that the failure was corrected and the system proceeds with the joined DB access as if this disjoint DB access had been successful. If an exception is thrown then that exception is propagated back up the stack to the invoker, and the joined DB access is aborted. When this method throws an exception, it should also attempt to restore the database to the state it was in before the joined DB access began.

The default behavior is to always throw an exception. If transactions are being used, then the current transaction is rolled back.

This method is always invoked on the joined row, never the disjoint row.

Parameters:: conn - The connection which was used for the database access; disjointRow - The disjoint row which was being used to access the database when the failure occurred. You can invoke the getTable() method on it to get the table being accessed. To get the fields in this row which correspond to that table, you can use the getFieldNames(Table) method.; affectedTables - Contains the tables whose data had already been affected by other disjoint DB accesses before the failure occurred; mode - A constant defined in Row which indicates if an insert, update, or delete caused the failure. (This may be different than the current mode contained in the ExecutingContext.); t - This is the exception describing the failure. It will be null in the case where the DB access was processed okay, but affected 0 rows; ec - The current executing context
Returns:: The number of rows in the DB which were altered as a result of running this method.
Throws:: CMException

joinedDelete

protected int joinedDelete(java.sql.Connection connection,
                           boolean useTransactions,
                           ExecutingContext ec)
                    throws CMException

In general, this method should not be directly invoked, instead one of the delete() methods should be invoked when a joined row needs to be deleted

Parameters:: connection - The connection to use for the delete; useTransactions - Should all of the disjoint deletes be sent to the DB in a single transaction?; ec - The current executing context
Returns:: The total number of records which were deleted in the database. Deleting a single joined row may result in multiple records in different tables being deleted, therefore this method may return a value greater than 1.
Throws:: CMException

merge

public void merge(Row row)
           throws CMException

Merges the fields of another row into this one. Fields that are merged into this row retain their original table and FD. Fields in the other row that are named the same as fields in this row are not merged. The transfer of fields may leave the other row in an unstable condition.

Throws:: CMException

newField

public Field newField(FieldDescriptorRow pFD)
               throws CMException

Creates and adds a Field to this Row, then returns the Field.

Throws:: CMException

newField

public Field newField(java.lang.String pFieldName,
                      FieldDescriptorRow pFD)
               throws CMException

Creates and adds a Field to this Row, then returns the Field.

Parameters:: pFieldName - String; pFD - planetj.fielddescriptors.FieldDescriptorRow
Returns:: Field
Throws:: CMException

newField

public Field newField(java.lang.String pFieldName,
                      int pSQLType)
               throws CMException

Creates and adds a Field to this Row, then returns the Field.

Parameters:: pFieldName - String; pSQLType - int
Returns:: Field
Throws:: CMException

newField

public Field newField(java.lang.String pFieldName,
                      java.lang.String pFieldClassName)
               throws CMException

Creates and adds a Field to this Row, then returns the Field.

Parameters:: pFieldName - String; pFieldClassName - String
Returns:: Field
Throws:: CMException

openFor

public final void openFor(int mode,
                          ExecutingContext ec)
                   throws CMException

Throws:: CMException

persist

public boolean persist()
                throws CMException

Inserts this row into the DB, or updates it in the DB if it is already there

Returns:: true If the row was inserted, false if it was updated
Throws:: CMException

populate

public void populate(java.sql.ResultSet pResults)
              throws CMException

Populates this Row with the data from the result set. This method will completely wipe out any existing values in this row.

Parameters:: pResults - The result set containing data which will be used to populate this Row. The cursor must be pointing to the row in the result set which will be used to populate this Row object.
Throws:: CMException

populate

protected void populate(java.sql.ResultSet pResults,
                        java.util.List pPhysicalNames,
                        java.sql.ResultSetMetaData pMetaData,
                        SQLContext pContext)
                 throws CMException

Populates this Row with the data from the result set. This method will completely wipe out any existing values in this row.

Parameters:: pResults - The result set containing data which will be used to populate this Row. The cursor must be pointing to the row in the result set which will be used to populate this Row object.; pMetaData - The result set's metadata.
Returns:: The populated Row. If the returned Row is different than this Row, the returned Row is used instead of this Row.
Throws:: CMException

populate

protected void populate(java.sql.ResultSet pResults,
                        java.sql.ResultSetMetaData pMetaData,
                        SQLContext pContext)
                 throws CMException

Populates this Row with the data from the result set. This method will completely wipe out any existing values in this row.

Parameters:: pResults - The result set containing data which will be used to populate this Row. The cursor must be pointing to the row in the result set which will be used to populate this Row object.; pMetaData - The result set's metadata.
Returns:: The populated Row. If the returned Row is different than this Row, the returned Row is used instead of this Row.
Throws:: CMException

populateFD

protected void populateFD(java.sql.ResultSet pResults,
                          java.util.List pColumnNames)
                   throws CMException

This method is called by a RowCollection when creating its Rows.

Throws:: CMException

postCreate

public void postCreate()

Handles actions taken immidately after creation of this object Creation date: (7/11/2002 7:06:46 PM)

postDelete

protected void postDelete(int changed,
                          ExecutingContext ec)
                   throws CMException

This method provides a "hook" for altering the current Row after a delete is performed.

Parameters:: ec - current context in which code is running
Throws:: CMException

postExtract

public void postExtract(java.lang.String[] fieldNames,
                        ExecutingContext ec)
                 throws CMException

Invoked after a row has had values extracted from the screen and set into it

Parameters:: fieldNames - The names of field which have had their values set from the screen. This does not necessarily mean these fields have had their values changed; ec - The current ExecutingContext
Throws:: CMException

postInsert

protected final void postInsert(ExecutingContext exContext)
                         throws CMException

Deprecated. replaced with postInsert(int, ExecutingContext)

This method provides a "hook" for altering the current row after an insert is performed.

Throws:: CMException

postInsert

protected void postInsert(int changed,
                          ExecutingContext exContext)
                   throws CMException

This method provides a "hook" for altering the current row after an insert is performed.

Throws:: CMException

postUpdate

protected final void postUpdate(ExecutingContext exContext)
                         throws CMException

Deprecated. replaced with postUpdate(int, ExecutingContext)

This method provides a "hook" for altering the current row after an update is performed.

Throws:: CMException

postUpdate

protected void postUpdate(int changed,
                          ExecutingContext exContext)
                   throws CMException

This method provides a "hook" for altering the current row after an update is performed.

Throws:: CMException

preDelete

protected void preDelete(ExecutingContext ec)
                  throws CMException

This method provides a "hook" for altering the current Row before a delete is performed.

Parameters:: ec - current context in which code is running
Throws:: CMException

preInsert

protected void preInsert(ExecutingContext exContext)
                  throws CMException

This method provides a "hook" for altering the current row before an insert is performed.

Throws:: CMException

prepareForDetails

public Row prepareForDetails(ExecutingContext ec)
                      throws CMException

Gets the a proper Row for viewing this Rows details. Includes actions like skinnying or getting additional fields not already included.

Throws:: CMException

prepareForParameters

public void prepareForParameters(AbstractContext context,
                                 ExecutingContext pEc)
                          throws CMException

This method is invoked on a parameter row just before it is displayed to the user. Subclasses may override.

Throws:: CMException

prepareForResultsDisplay

public Row prepareForResultsDisplay(ExecutingContext ec)
                             throws CMException

Allows the current row to handle any necessary actions before being displayed in a results table.

Throws:: CMException

prepareFromFieldNames

public Row prepareFromFieldNames(java.util.List pNames)
                          throws CMException

Gets the a proper Row for viewing this Rows details. Includes actions like skinnying or getting additional fields not already included.

Throws:: CMException

preUpdate

protected void preUpdate(ExecutingContext exContext)
                  throws CMException

This method provides a "hook" for altering the current row before an update is performed.

Throws:: CMException

removeField

public Field removeField(Field field)

Removes the specified field from this row. The removed field is returned (or null if no such field was found)

removeField

public Field removeField(java.lang.String fieldName)

Removes the field with the specified name from this row. The removed field is returned (or null if no such field was found)

removeNavigationKey

public void removeNavigationKey()

Clears out any navigation key that may have been set on this Row.

Specified by:: removeNavigationKey in interface INavigationObject

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a property change listener that was added via the addPropertyChangeListener() method.

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String property,
                                         java.beans.PropertyChangeListener listener)

Removes a property change listener that was added via the addPropertyChangeListener() method.

removeRowEventListener

public void removeRowEventListener(IRowEventListener pNewListener)

Removes a Listener from this Row

removeRowEventListeners

public void removeRowEventListeners(java.util.List listeners)

Removes a Listener from this Row

replaceField

public void replaceField(Field newField)

Replace a Field with the given Field. If the Row does not contain the same Field as the given one, then the given Field is added to the Row.

replaceFieldValues

public java.util.List replaceFieldValues(java.util.Map nameValueMap)
                                  throws CMException

Replaces the values in one or more fields. You should avoid invoking this method unless you are fairly certain all of the replacement values will be accepted by their field - if setting a replacement value causes an exception to be thrown the fields may be left in an inconsistent state, some containing their original values, some containing their replacement values.

Parameters:: nameValueMap - A mapping of field names (String objects) to values. Every field in this Row whose name is in the key set of the Map has its value replaced by the corresponding value in the Map.
Returns:: A List containing the names in the Map for which there were no fields in this Row, and whose values were therefore not added.
Throws:: CMException

replaceFields

protected void replaceFields()
                      throws CMException

This method is invoked after a Row is read from the DB. By default, it does nothing, but subclasses may override this method if they need to replace any fields in this Row with fields of a different type, possibly using the FieldDescriptorRow.createField(String,Class) method

Throws:: CMException

reread

public Row reread()
           throws CMException

Rereads this row, returning a new Row with fresh values from the DB. (The new Row may possibly be of a different Row subclass than this Row.) Unlike the refresh() method, this method does not alter this row. You should only invoke this method when this Row contains all of its potential key fields

Throws:: CMException

rereadIfNeeded

public Row rereadIfNeeded()
                   throws CMException

Rereads this row, returning a new Row with fresh values from the DB, but only if this Row's table has been updated from the DataEngine since it was read; otherwise this same row is returned. (The new Row may possibly be of a different Row subclass than this Row.) This method does not alter this row. You should only invoke this method when this Row contains all of its potential key fields

Throws:: CMException

resetDisplayValues

public void resetDisplayValues()

Resets the display values in this row to null so they can be recomputed when needed.

rollbackChanges

public Row rollbackChanges()
                    throws CMException

Undoes any changes that have been made to this Row since it was read from or written to the database. This method will not undo any changes that have been saved to the database.

Returns:: This object
Throws:: CMException

runSQLQuery

protected RowCollection runSQLQuery(java.lang.String sqlStatement)
                             throws CMException

Convenience method for running an SQL query statement against tables on the same machine. Only works to select data - if runnin insert, updates, or deletes use runSQLStatement.

Returns:: RowCollection
Throws:: CMException

runSQLQuery

protected RowCollection runSQLQuery(java.lang.String sqlStatement,
                                    java.lang.Class rowClass)
                             throws CMException

Convenience method for running an SQL query statement against tables on the same machine. Only works to select data - if runnin insert, updates, or deletes use runSQLStatement.

Returns:: RowCollection of specified class type
Throws:: CMException

runSQLStatement

protected void runSQLStatement(java.lang.String sql)
                        throws CMException

Convenience method for running an SQL statement against tables on the same machine. If statement contains(???) then call method runSQLStatement(sql, executingContext).

Parameters:: sql - SQL String to run
Throws:: CMException

runSQLStatement

protected void runSQLStatement(java.lang.String sql,
                               ExecutingContext ec)
                        throws CMException

Convenience method for running an SQL statement against tables on the same machine.

Parameters:: sql - SQL String to run; ec - context in which the current request is being run
Throws:: CMException

setAttribute

public void setAttribute(java.lang.Object key,
                         java.lang.Object value)

Map that allows general attributes about a Row to be set and retreived. Sets the value object at the specified key Creation date: (2/19/2002 3:10:01 PM)

setAutoUpdateFieldValues

protected void setAutoUpdateFieldValues(ExecutingContext ec)
                                 throws CMException

Set auto update Field values.

Parameters:: ec - context in which application is running.
Throws:: CMException

setFieldInitialValue

public void setFieldInitialValue(java.lang.String fldNam,
                                 java.lang.Object value)
                          throws CMException

Sets the value of the specified field.

Parameters:: fldNam - The name of the field to set. If no such field exists in this Row, a skeleton field will be created to hold the value, and added to this row.; value - The value to set the field to.
Throws:: CMException

setFieldValue

public void setFieldValue(java.lang.String fldNam,
                          boolean bool)
                   throws CMException

Sets the value of the specified boolean field

Throws:: CMException

setFieldValue

public void setFieldValue(java.lang.String fldNam,
                          double pDouble)
                   throws CMException

Sets the current value of the Field to the specified value, and also sets the old value to the previous value. NOTE: This method will take int types also. If called and the Field is not updatable a CMException is thrown.

Throws:: CMException

setFieldValue

public void setFieldValue(java.lang.String fldNam,
                          long pLong)
                   throws CMException

Throws:: CMException

setFieldValue

public void setFieldValue(java.lang.String fldNam,
                          java.lang.Object value)
                   throws CMException

Sets the value of the specified field.

Parameters:: fldNam - The name of the field to set. If no such field exists in this Row, a skeleton field will be created to hold the value, and added to this row.; value - The value to set the field to.
Throws:: CMException

setFieldValueAsString

public void setFieldValueAsString(java.lang.String fldNam,
                                  java.lang.String value)
                           throws CMException

Sets the value of the specified field.

Parameters:: fldNam - The name of the field to set. If no such field exists in this Row, a skeleton field will be created to hold the value, and added to this row.; value - The value to set the field to.
Throws:: CMException

setFieldValueAsString

public void setFieldValueAsString(java.lang.String fldNam,
                                  java.lang.String value,
                                  int startPos)
                           throws CMException

Sets the value of the specified field from the starting position (zero indexed) without affecting other positions in this field.

Parameters:: fldNam - The name of the field to set. If no such field exists in this Row, a skeleton field will be created to hold the value, and added to this row.; value - The value to set the field to.
Throws:: CMException

setFieldValuesAsDate

public void setFieldValuesAsDate(java.lang.String[] fieldNames,
                                 java.util.Date date)
                          throws CMException

This method is for cases when the date is stored in 3 fields (year{2002}, month{5}, day{10}) in the database. You simply have to pass in the 3 field names and the date and this method will handle the rest. Creation date: (5/10/2002 11:11:27 AM)

Throws:: CMException

setFieldValuesToDefault

public void setFieldValuesToDefault(java.util.List fieldNames,
                                    boolean ignoreCase,
                                    ExecutingContext ec)
                             throws CMException

Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.

Throws:: CMException

setFieldValuesWithCommonFieldNames

public void setFieldValuesWithCommonFieldNames(Row source)
                                        throws CMException

Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.

Throws:: CMException

setFieldValuesWithCommonFieldNames

public void setFieldValuesWithCommonFieldNames(Row source,
                                               boolean ignoreCase)
                                        throws CMException

Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.

Throws:: CMException

setFieldValuesWithCommonFieldNames

public void setFieldValuesWithCommonFieldNames(java.util.List targetNames,
                                               Row source,
                                               boolean ignoreCase)
                                        throws CMException

Sets values from the source Row into this Row (the target) for all Fields that BOTH the source and the target have.

Throws:: CMException

setFieldValuesWithCommonUsageIds

public void setFieldValuesWithCommonUsageIds(Row rowToCopy)
                                      throws CMException

Copy the field values from the supplied Row with the same usageid into this Row.

Throws:: CMException

setFieldValueToDefault

public void setFieldValueToDefault(java.lang.String pName,
                                   ExecutingContext ec)
                            throws CMException

Sets the fields value back to the default value Creation date: Jun 24, 2004 - 3:14:48 PM

Throws:: CMException

updateGlobalValues

public void updateGlobalValues(ExecutingContext ec)
                        throws CMException

Updates any global values this Row might have.

Throws:: CMException

setMultipleDeleteEnabled

public void setMultipleDeleteEnabled(boolean pMultipleDeleteEnabled)

Sets whether or not multiple record deletes are allowed.

setNavigationKey

public void setNavigationKey(java.lang.String key)

Set the key used to store/retrieve this Row to/from navigation.

Specified by:: setNavigationKey in interface INavigationObject

setParameterRow

public void setParameterRow(boolean isParameterRow)

Sets if this row is being used to generate parameter inputs

setPersistent

public void setPersistent(boolean persistent)

Sets if this row has been persisted to the database. The main purpose of this method is to determine if this rows has ever been in the DB, or if it only lives in memory. For performance reasons this method does not check the database, and instead relies upon its last known state. If this row was read from or written to the DB this method will return true, even though another user may have subsequently deleted it.

setPropertyChangeEventsEnabled

public void setPropertyChangeEventsEnabled(boolean newPropertyChangeEventsEnabled)

Sets whether the changing of the value in one of this Row's fields will cause this Row to fire a PropertyChangeEvent or not. The default is true, but if a customized PropertyChangeSupport is used, it may help performance to turn the default PropertyChangeSupport off.

setPropertyGroups

public void setPropertyGroups(PropertyGroupList propertyGroups)

Set the property groups stored in this RowCollection's attributes.

setReturningFromPossibleValuesSearch

public void setReturningFromPossibleValuesSearch(boolean value)

Insert the method's description here. Creation date: (2/9/2003 2:02:31 PM)

Parameters:: value - boolean

setRowDisplayAttributes

public void setRowDisplayAttributes(java.lang.String displayAttributes)
                             throws CMException

Sets a String that provides HTML or other display characteristics of this Row.

Throws:: CMException

setSavepoint

public void setSavepoint()

Sets savepoints for the Fields in the this Row. After invoking this method fields "old values" will be replaced with their new values. A rollback will reset the values to when their savepoint was set.

setSavepoint

public void setSavepoint(java.util.Collection pFields)

Sets savepoints for the Fields in the given Collection. After invoking this method fields "old values" will be replaced with their new values. A rollback will reset the values to when their savepoint was set.

setSavepoint

public void setSavepoint(java.util.Map pFields)

Sets savepoints for the Fields in the given Map. After invoking this method fields "old values" will be replaced with their new values. A rollback will reset the values to when their savepoint was set.

setCreationContext

public void setCreationContext(SQLContext context)

Sets the SQL context that was used when creating this Row

Parameters:: context -

setCreationOperation

public void setCreationOperation(Operation op)

Sets the operation responsible for creating this row

setStaticAttribute

public void setStaticAttribute(java.lang.Object key,
                               java.lang.Object value)

setTables

public void setTables(java.util.List pTables)

Deprecated. Pass in a table collection instead

Sets the table to which this row belongs.

setTables

public void setTables(TableCollection pTables)

Sets the table to which this row belongs.

setUseWOWLibrary

public void setUseWOWLibrary(short newWOWSystemLibrary)

Sets which WOW library should be used to execute this Row's context.

setValidateDerivedFields

public void setValidateDerivedFields(boolean newValidateDerivedFields)

Sets if this Row must validate its derived fields Defaults to false, Subclasses can override this method or set this value via setValidateDerivedFields(true)

setValidateRequired

public void setValidateRequired(boolean newValidateRequired)

Sets if this Row must be validated before it is inserted/updated

setValues

public void setValues(java.util.List pData)
               throws CMException

Sets the values of this Row

Parameters:: pData - A List of values. The first field in this Row will be set to the first value in the List, the second field to the second value, etc.
Throws:: CMException

size

public int size()

Returns the number of fields in this Row.

Specified by:: size in interface INamedCollection

splitAndSetFieldValues

public void splitAndSetFieldValues(java.lang.String[] fieldNames,
                                   int[] splitIndices,
                                   java.lang.String valueToSplit)
                            throws CMException

This method takes the specified value and splits it into mulitple values and then sets those values on the fields with the given field names. Note: the splitIndices array will always be 1 less then the number of field names. This is because the beginning and ending indices are the values start and end. The split indices mark the beginning of each field's value except excluding the first field. 0 is the first position in the value.

e.g. (scenario) 3 field names ["Month", Day", "Year"] Value to split = "04072002" Split indices = [2, 4] (result) Field "Month" = "04" "Day" = "07" "Year" = "2002" 01 23 4567 8 } Indices ------------ 04|07|2002

Parameters:: fieldNames - String[] of Field names to set values for; splitIndices - int[] of indices of where to split the given value; valueToSplit - String value to split into mulitple values
Throws:: CMException

statusChanged

public Row statusChanged(Field pField,
                         ExecutingContext ec)
                  throws CMException

Invoked when a status change takes place on of this Row's fields. Subclasses may override this method, but they should call it on the superclass when they do.

Parameters:: pField - The field whose status has changed; ec - The current executing context
Returns:: The "new" row resulting from the status change. Usually this is this same row, but a row may choose to replace itself with another row and return that other row.
Throws:: CMException

swapFieldValues

public void swapFieldValues(java.lang.String fieldNameA,
                            java.lang.String fieldNameB)
                     throws CMException

Swaps the values of the two fields

Throws:: CMException

toCSV

public java.lang.StringBuffer toCSV(boolean pIncludeColumnHeadings,
                                    CSVFileDescriptor pCSVFileDescriptor)
                             throws CMException

Returns a StringBuffer in CSV format containing all data in this Row Creation date: (2/6/2002 5:14:39 PM)

Throws:: CMException

toDOC

public java.lang.StringBuffer toDOC(boolean pIncludeColumnHeadings,
                                    CSVFileDescriptor pFileDescriptor)
                             throws CMException

Deprecated. Use the single argument method instead

Returns a StringBuffer in Microsoft Word .doc format containing all data in this RowCollection. Creation date: (2/13/2002 1:09:43 PM)

Throws:: CMException

toDOC

public java.lang.StringBuffer toDOC(CSVFileDescriptor pFileDescriptor)
                             throws CMException

Returns a StringBuffer in Microsoft Word .doc format containing all data in this RowCollection. Creation date: (2/13/2002 1:09:43 PM)

Throws:: CMException

toFDF

public java.lang.StringBuffer toFDF(FDFFileDescriptor pFileDescriptor)
                             throws CMException

Returns a StringBuffer in FDF format containing all data in this Row. Creation date: (2/11/2002 4:26:03 PM)

Throws:: CMException

toPDF

public void toPDF(boolean pIncludeColumnHeadings,
                  PDFFileDescriptor pFileDescriptor)
           throws CMException

Deprecated. Use the single argument method instead

Generates a PDF file from this Row. The output will be sent to the ServletOutputStream if there is no fileName specified in pFileDescriptor, else the output will be sent to that file.

Creation date: (2/7/2002 12:39:11 PM)

Throws:: CMException

toPDF

public void toPDF(PDFFileDescriptor pFileDescriptor)
           throws CMException

Generates a PDF file from this Row. The output will be sent to the ServletOutputStream if there is no fileName specified in pFileDescriptor, else the output will be sent to that file.

Creation date: (2/7/2002 12:39:11 PM)

Throws:: CMException

toString

public java.lang.String toString(boolean includeTable)

Returns a String representation of this Row.

Returns:: String

toUpperCase

public void toUpperCase()
                 throws CMException

This method will UPPERCASE all the fields values in this Row if it is stored in the databse as a Char or it is a StringField. Dates must be UPPERCASED incase the date format in the DB contains acutal month or day or timezone info Example: Tue May 14 12:23:53 PDT 2002 Times must be UPPERCASED incase the date format in the DB contains acutal month or day or timezone info Example: 14 May 2002 19:26:13 GMT Creation date: (5/14/2002 12:42:43 PM)

Throws:: CMException

toXML

public java.lang.StringBuffer toXML(XMLFileDescriptor pFileDescriptor)
                             throws CMException

Returns a StringBuffer in XML format containing all data in this Row. Creation date: (2/7/2002 12:28:56 PM)

Throws:: CMException

transferDataTo

public Row transferDataTo(java.lang.Class pNewRowClass)
                   throws CMException

Transfers all the data in this Row into a different Row. If this Row is part of one or more RowCollections, it is replaced in those RowCollections with the destination Row. This row will no longer contain any information after this method completes; any further operations involving this Row will fail or behave in unexpected ways. Note that property change listeners are removed from this Row, but are NOT transferred to the destination Row.

Parameters:: pNewRowClass - The new type of Row to copy the data to.
Returns:: The destination Row, containing the data from this Row. This same Row will be returned if it is already of the specified type
Throws:: CMException

transferDataTo

public Row transferDataTo(Row pDestinationRow)
                   throws DataEngineException

Parameters:: pDestinationRow - The Row to copy the data to.
Returns:: The destination Row, containing the data from this Row.
Throws:: DataEngineException

update

public final int update()
                 throws CMException

Updates the database with the values in this Row. If concurrent alterations to the database prevent this row from being updated, a ConcurrentAlterationException is thrown.

Returns:: The number of updated rows
Throws:: CMException

update

public final int update(java.sql.Connection conn)
                 throws CMException

Updates the database with the values in this Row. If concurrent alterations to the database prevent this row from being updated, a ConcurrentAlterationException is thrown.

Parameters:: conn - The connection to use for the update
Returns:: The number of updated rows
Throws:: CMException

update

public int update(java.sql.Connection connection,
                  ExecutingContext ec)
           throws CMException

Updates the database with the values in this Row. If concurrent alterations to the database prevent this row from being updated, a ConcurrentAlterationException is thrown.

Returns:: The number of updated rows
Throws:: CMException

update

public final int update(ExecutingContext ec)
                 throws CMException

Updates the database with the values in this Row. If concurrent alterations to the database prevent this row from being updated, a ConcurrentAlterationException is thrown.

Parameters:: ec - context in which to update this Row
Returns:: number of rows updated in database
Throws:: CMException

updateFieldValues

public void updateFieldValues(java.util.Map fields)
                       throws CMException

Updates the values of any Fields in this Row with the value in the given Map that has the same key as the Field's name.

Throws:: CMException

updateObject

public void updateObject()
                  throws java.lang.Exception

Deprecated. by WK on (8/10/2003 7:58:28 AM) because there were no references to this method in VAJ any where and all it does is call update()

update an object from the system.

Specified by:: updateObject in interface IBusinessObject

Throws:: java.lang.Exception

validate

public boolean validate(ExecutingContext ec)
                 throws CMException

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

Parameters:: ec - current context in which application is executing
Returns:: true, if Row and Fields are valid; false otherwise.
Throws:: CMException

validateField

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

Validates the given Field and returns whether or not the Field is valid.

Parameters:: field -
Returns:
Throws:: CMException

validate

public final boolean validate(ExecutingContext pContext,
                              java.security.Principal pUser)
                       throws CMException

Deprecated. by WK on (8/9/2003 9:24:24 AM) because the executing context contains the user. Replaced with validate(ExecutingContext). This method will no longer be supported as of WOW 7.0.

Validate this Row based on its configuration and field values. If the field values are valid, return true, if not return an exception that encapsulates the error.

Throws:: CMException

validate

public boolean validate(int pOperation,
                        java.security.Principal pUser)
                 throws CMException

Deprecated. Use the validate() method which takes in an ExecutingContext

Validate this Row based on its configuration and field values. If the field values are valid, return true, if not return an exception that encapsulates the error.

Returns:: boolean true if valid else and exception will be thrown
Throws:: CMException

validateRowOperation

public void validateRowOperation(int pOperation,
                                 java.security.Principal pUser)
                          throws DataEngineException

Validate if the operation can be performed on this Row.

Throws:: DataEngineException

getActionRequest

public final IActionRequest getActionRequest(AbstractAction action,
                                             HttpServletRequest request,
                                             HttpServletResponse response)

Description copied from interface: IActionObject

Get the magic request used to handle a given action.

Specified by:: getActionRequest in interface IActionObject

getActionRequest

public IActionRequest getActionRequest(AbstractAction action,
                                       java.lang.Object o,
                                       HttpServletRequest request,
                                       HttpServletResponse response)

Description copied from interface: IActionObject

Get the magic request used to handle a given action.

Specified by:: getActionRequest in interface IActionObject

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

planetj.database Class Row

className

MODE_COPY

MODE_DELETE

MODE_INSERT

MODE_READ

MODE_SEARCH

MODE_UNKNOWN

MODE_UPDATE

MODE_ALTER

mRowEventListeners

DISPLAY_ORDER_COMPARATOR

Row

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

replaceNumbersWithNames

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

createRow

createSQLContextForDelete

createSQLContextForInsert

createSQLContextForUpdate

dataTransferred

defaultMerge

delete

delete

delete

delete

deleteObject

divide

duplicateKey

duplicateKey

enforceExclusiveOr

equals

equals

equalsInstance

fieldHasPossibleValuesSQLOperation

planetj.database
Class Row