planetj.dataengine.operation
Class Operation

java.lang.Object
  planetj.database.Row
      planetj.dataengine.PropertyRow
          planetj.dataengine.operation.Operation

All Implemented Interfaces:

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

Direct Known Subclasses:

AssociatedExecutionGroupOperation, HTMLOperation, JavaOperation, SelectionOperation, SQLOperation, UserAuthenticationListOperation, UserAuthorizationListOperation

public class Operation

extends PropertyRow

implements IOperation, IActionObject

Represents an operation that can be executed. An operation may be contained in an Application, or may run independent of any Application. Note that a single Operation object is often shared by multiple users of an Application, so user specific data should not be stored in an Operation.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Row

Row.SpacingRow

Field Summary

static java.lang.String

className Class name.

Fields inherited from class planetj.database.Row

DISPLAY_ORDER_COMPARATOR, MODE_ALTER, MODE_COPY, MODE_DELETE, MODE_INSERT, MODE_READ, MODE_SEARCH, MODE_UNKNOWN, MODE_UPDATE, mRowEventListeners

Fields inherited from interface planetj.dataengine.operation.IOperation

ALLOW_DELETES, ALLOW_DETAILS, ALLOW_INSERTS, ALLOW_UPDATES, APPLICABLE_CODE_ONLY, APPLICABLE_ONLY_FOR_DISPLAY, APPLICABLE_ONLY_FOR_SQL, APPLICATION_ID, AUTHORIZE_EXECUTE_OPERATION, AUTO_RUN_ID, AUTO_RUN_STATUS, CACHE_LEVEL, CONNECTION_ALIAS, CSS_LINK_CLASS, CURRENT_FIELD, CURRENT_REQUEST, CURRENT_RESPONSE, CURRENT_ROW, CURRENT_ROW_COLLECTION, CURRENT_SERVLET, CURRENT_USER, DEPENDS_ON_ID, DESCRIPTION, DETAILS_JSP_FILE, DISPLAY_COLUMNS, DISPLAY_LOCATION, DISPLAY_LOCATION_LEFT, DISPLAY_LOCATION_TOP, DISPLAY_ORDER, DISPLAY_RULE, DISPLAY_RULE_HIDE, DISPLAY_RULE_UNKNOWN, ENCRYPTION_ID, EXECUTION_MODE, EXECUTION_MODE_NO, EXECUTION_MODE_YES, EXECUTION_RULE, EXECUTION_RULE_EXECUTE_ONLY, EXECUTION_RULE_EXECUTE_THEN_PROMPT, EXECUTION_RULE_PROMPT_THEN_EXECUTE, INSTRUCTIONS, JSP_FILE, LABEL, OPERATION_CLASS, OPERATION_CODE, OPERATION_DISPLAY_MODE, OPERATION_DISPLAY_MODE_FULL, OPERATION_DISPLAY_MODE_SKINNY, OPERATION_HTTP_ID, OPERATION_ID, OPERATION_SET, OPERATION_SQL, OPERATION_TABLE_NAME, OUTPUT_ALIAS, OWNER_ID, PARAMETERS_JSP_FILE, PARENT_ID, PERFORMACE_STATISTICS_ID, PROPERTIES, ROW_CLASS, ROW_COLLECTION_CLASS, ROW_COUNT, SECURITY_ID, SECURITY_TYPE, SET_NAME, THEME_ID, TITLE, TYPE, TYPE_ASSOCIATED_EXECUTION_GROUP, TYPE_ASSOCIATED_JAVA_OPERATION, TYPE_ASSOCIATED_JOIN, TYPE_ASSOCIATION_1_TO_1, TYPE_ASSOCIATION_1_TO_MANY, TYPE_AUTHENTICATION, TYPE_AUTO_POPULATE, TYPE_AUTORUN_BATCH_PROCESS, TYPE_AUTORUN_EMAIL, TYPE_BLOB_DOWNLOAD, TYPE_EMAIL, TYPE_EXECUTION_GROUP, TYPE_FILE_UPLOAD, TYPE_HTML_CODE, TYPE_HTML_CODE_ASSOCIATION, TYPE_HTML_REFERENCE, TYPE_HTML_REFERENCE_ASSOCIATION, TYPE_JAVA_OPERATION, TYPE_JSP_REFERENCE, TYPE_JSP_REFERENCE_ASSOCIATION, TYPE_POSSIBLE_VALUES, TYPE_POSSIBLE_VALUES_SEARCH, TYPE_POSSIBLE_VALUES_SELECTOR, TYPE_REFERER_AUTHORIZATION_OPERATION, TYPE_SQL, TYPE_TABBED, TYPE_TABBED_ASSOCIATION, TYPE_UNKNOWN, TYPE_USER_AUTHENTICATION_LIST_OPERATION, TYPE_USER_AUTHORIZATION_LIST_OPERATION, TYPE_USER_AUTHORIZATION_OPERATION, TYPE_VIEW_SELECTED_ASSOCIATION, USAGE_ID

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

Operation()

Method Summary

void	adjustRequest(IMagicRequest mr, java.lang.Object result, HttpServletRequest req, HttpServletResponse res) Some magic requests may invoke this method to adjust their settings
AbstractAction	createAction(java.lang.String name, ExecutingContext ec) Create an action for the given action name.
IMagicRequest	createMagicRequest(Field basedOnField, Row basedOnRow, HttpServletRequest request, HttpServletResponse response) Creates a MagicRequest for viewing this operation.
IMagicRequest	createMagicRequest(HttpServletRequest request, HttpServletResponse response) Creates a MagicRequest for viewing this operation.
IMagicRequest	createMagicRequest(java.lang.String id, Field basedOnField, Row basedOnRow, HttpServletRequest request, HttpServletResponse response) Deprecated. id no longer needed - used createMagicRequest(Field, Row, request, response)
IMagicRequest	createMagicRequest(java.lang.String id, HttpServletRequest request, HttpServletResponse response) Deprecated. id no longer needed used createMagicRequest(request, response)
IMagicRequest	createMagicRequest(java.lang.String id, Row row, HttpServletRequest request, HttpServletResponse response) Deprecated. method is no longer supported
Row	createRow(Row row) Initializes this SQLOperation as it is retrieved from the DB
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.
java.lang.Object	execute() Executes this operation.
java.lang.Object	execute(ExecutingContext ec) Executes this operation from the given executing context and Field.
java.lang.Object	execute(ExecutingContext ec, Field field) Executes this operation from the given executing context and Field.
java.lang.Object	execute(ExecutingContext ec, Row row) Executes this operation from the given executing context and Row.
java.lang.Object	execute(Field field) Executes this operation from the given executing context and Field.
java.lang.Object	execute(Field field, Row row, ExecutingContext ec) Executes this operation from the given executing context and Row.
java.lang.String	getActionDefaultLocation() Gets the default location for OperationActions
ActionDescriptor	getActionDescriptor(AbstractAction action) Gets the action descriptor for the specified action
java.util.List	getActions(ExecutingContext ec) Get a List of the actions this object supports.
java.util.List	getActionsForType(java.lang.String type) Gets any actions for the given type of action that this operation contains.
Application	getApplication() Gets the Application assoicated with this Operation (may be null if there is no such application).
int	getApplicationId() Gets the ID of this SQLOperation's Application
java.lang.Integer	getApplicationIdAsInteger() Gets the ID of this SQLOperation's Application
int	getAutoRunId() Gets the autorun ID of this SQLOperation
AutoRunOperation	getAutoRunOperation() Get this operation's auto-run operation, which describes how and if this operation should be automatically run.
int	getAutoRunStatus() Gets the autorun status of this operation.
RowCollection	getChildren() Gets the children Operations of this Operation (may be null if Operation does not have any children)
java.lang.String	getConnectionAlias() Get the alias of the system where this Operation's data is located.
java.lang.String	getConnectionAlias(boolean checkApp) Get the alias of the system where this Operation's data is located.
ConnectionRow	getConnectionRow() Gets the ConnectionRow assoicated with this Operation
ConnectionRow	getConnectionRow(boolean checkApp) Gets the ConnectionRow assoicated with this Operation
java.lang.String	getCSSLinkClass() Gets the CSS class to use when displaying this operation's link in the TOC
java.lang.String	getCurrentTab(HttpServletRequest req) Gets the name of this operation's current tab.
java.lang.String	getDefaultOperationCode() Return a default string to use on the operation field.
java.lang.String	getDeleteConfirmationMessage() Get the message used when deleting an operation.
RowCollection	getDependants() Gets the dependant Operations of this Operation (may be null if Operation does not have any children)
Operation	getDependsOn() Gets the Operation this Operation depends on (may be null if Operation does not depend on another Operation)
int	getDependsOnId() Get the id of the Operation this Operation depends on.
java.lang.Integer	getDependsOnIdAsInteger() Get the id of the Operation this Operation depends on.
java.lang.String	getDetailsJspFile() Gets the JSP used to display this SQLOperation's details
java.util.List	getDisplayColumns() Gets the display columns as Strings in a List
java.lang.String	getDisplayColumnsAsString() Gets the display columns, separated by commas in a String
java.lang.String[]	getDisplayColumnsAsStringArray() Gets the display columns as Strings in an Array.
java.lang.String	getDisplayLocation() Gets this operation's display location, which section in the layout it should be listed.
int	getDisplayOrder() Gets this SQLOperation's display order.
int	getDisplayRule() Field for future expansion.
int	getExecutionRule() Gets the execution rule, either PROMPT_THEN_EXECUTE or EXECUTE_THEN_PROMPT
java.lang.Object	getFieldDefaultValue(Field field, ExecutingContext ec) Get the field's default value as a String.
int	getId() Gets the id of this Operation
java.lang.Integer	getIdAsInteger() Gets the id of this operation.
java.lang.String	getInstructions() Gets this Operation's instructions
java.lang.String	getJspFile() Gets this Operation's JSP file
java.lang.String	getLabel() Gets the label for this SQLOperation .
LayoutDisplayPropertyGroup	getLayoutProperties() Gets this Operation's layout properties.
java.lang.String	getNavigationSuffix() Gets the navigation suffix to use for this operation.
IOperationContext	getNewContext() Gets a new IOperationContext for this operation.
IOperationContext	getNewContext(Field field, Row row, ExecutingContext ec) Gets a new IOperationContext for this operation.
protected IOperationContext	getNewContextInternal() Deprecated.
protected IOperationContext	getNewContextInternal(Field field, Row row, ExecutingContext ec) Gets a new IOperationContext for this operation.
static java.lang.Class	getOperationClass(int operationType) Gets the Operation java class which should be used to represent an operation of the specified type
java.lang.String	getOperationCode() Gets this Operation's code
java.util.List	getOperationHandledActionNames(ExecutingContext ec) Get a List of names of actions handled by this Operation.
java.lang.String	getOperationSetName() Gets this SQLOperation's operation set name.
java.lang.String	getOriginalInstructions() Gets this Operation's instructions, exactly as they were entered by the user before any parameter substitution
java.lang.String	getOutputAlias() Gets this SQLOperation's Output Alias
int	getOwnerId() Gets the owner ID of this SQLOperation
Field	getOwnerIdField() Returns the Owner Id Field
java.lang.String	getParametersJspFile() Gets the JSP used to query the user for this Operation's parameters
Operation	getParent() Gets the parent Operation of this Operation (may be null if Operation does not have a parent)
int	getParentId() Get the parent id of this Operation.
java.lang.Integer	getParentIdAsInteger() Get the parent id of this operation.
java.lang.String	getPropertyFieldName() Get the name of the Field containing this Row's properties..
java.lang.Class	getRowClass() Gets the Row class to use when this SQLOperation's query is run (may be null)
java.lang.String	getRowClassName() Gets the name of the Row class to use when this SQLOperation's query is run (may be null)
java.lang.Class	getRowCollectionClass() Gets the RowCollection class to use when this SQLOperation's query is run (may be null)
java.lang.String	getRowCollectionClassName() Gets the name of the RowCollection class to use when this SQLOperation's query is run (may be null)
int	getRowCount() Gets the row count to use when retrieving rows for this SQLOperation
PropertyGroupList	getRowPropertyGroups() Gets this SQLOperation's operation set name.
int	getSecurityId() Gets the security ID of this SQLOperation
int	getSecurityType() Check whether this Operation is protected (secured)
java.lang.String	getTitle() Gets the title for this Operation, exactly as it was entered by the user, before parameter substitution
java.lang.String	getTitleForDisplay() Gets the title for this Operation, exactly as it was entered by the user, before parameter substitution
int	getType() Gets the type of this Operation.
int	getUsageId() Gets the usageId of the field.
java.lang.String	getUserMessageForOperation(int changeCount, int mode) Returns a message for the user based on the Mode of the Row
boolean	hasDependants() Tests to see if this Operation has any dependant operations.
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(SQLContext context) Inserts this Row into its table.
boolean	isAllowDeletes() Tests whether or not rows can be deleted from this results of this SQLOperation if this SQLOperation is a query
boolean	isAllowDetails() Tests whether or not the details of a row in this ListView can be viewed
boolean	isAllowInserts() Tests whether or not rows can be inserted into the results of this SQLOperation
boolean	isAllowUpdates() Tests whether or not the results of this SQLOperation can be updated, if this SQLOperation is a query
boolean	isAssociation() Check if this Operation is an association.
boolean	isAuthentication() Test if this SQLOperation is a Authentication type.
boolean	isAuthorizedForExecution(ExecutingContext ec) Test for authority to execute this operation.
boolean	isAutoPopulate() Test if this SQLOperation is an Auto Populate.
boolean	isAutoRunOperation() Tests if this operation is an autorun operation.
boolean	isBlobDownload() Test if this SQLOperation is a Blob Download.
boolean	isChild() Test to see if this Operation has a parent Operation.
boolean	isContextCurrent(IOperationContext context) Test if the context was created from this operation, and if the contents of the context are still valid.
boolean	isDependant() Test to see if this Operation depends on another Operation.
boolean	isDisplayable(ExecutingContext pEc) Test if this SQLOperation is displayable
boolean	isDisplayRule(int displayRuleId, ExecutingContext ec) Check to see if this operation is part of the given layout section.
boolean	isExecutionGroup() Check to see if this operation is an execution group.
boolean	isFileUpload() Test if this SQLOperation is a File Upload.
boolean	isHide() Test if this operation should be hidden from the menus.
boolean	isHtml() Tests if this operation is an HTML operation
boolean	isHTMLAssociation() Check if this Operation is an HTML assocation type.
boolean	isHtmlCode() Check to see if this operation is HTML code.
boolean	isHtmlCodeAssocation() Check to see if this operation is an HTML code association.
boolean	isHtmlReference() Check to see if this operation is a HTML reference.
boolean	isHtmlReferenceAssociation() Check to see if this operation is an HTML reference association.
boolean	isJava() Tests if this operation is an Java operation
boolean	isJavaAssociation() Check to see if this operation is a Associated Java Operation
boolean	isJSPReference() Check to see if this operation is a JSP reference.
boolean	isJSPReferenceAssociation() Check to see if this operation is a JSP reference.
boolean	isOneToManyAssociation() Test if this SQLOperation is a 1-Many association.
boolean	isOneToOneAssociation() Test if this SQLOperation is a 1-1 association.
boolean	isParent() Test to see if this Operation has any children Operations.
boolean	isPleaseWait(ExecutingContext ec) Is this operation a please wait operation?
boolean	isPossibleValues() Test if this SQLOperation is a Possible Values type.
boolean	isPossibleValuesSearch() Test if this SQLOperation is a Possible Values Search type.
boolean	isPossibleValuesSelector() Test if this SQLOperation is a PossibleValuesSelector.
boolean	isSQL() Test if this SQLOperation is a SQL type.
boolean	isSQLAssociation() Test if this SQLOperation is a Association type.
boolean	isTabDataOperation() Tests if this is a tab data operation (i.e.
boolean	isUserAuthenticationListOperation() Test if this SQLOperation is a User Authentication List Operation type.
boolean	isUserAuthorizationListOperation() Test if this SQLOperation is a User Authorization List Operation type.
boolean	isUserAuthorizationOperation() Test if this SQLOperation is a User Authorization Operation type.
boolean	isUserPromptingRequired() Does the user need to be prompted for input.
void	openForExecution(Row associatedRow, ExecutingContext ec)
protected void	postDelete(int changed, ExecutingContext ec) This method provides a "hook" for altering the current Row after a delete is performed.
protected void	postInsert(int changed, ExecutingContext exContext) This method provides a "hook" for altering the current row after an insert is performed.
void	prepareForRun(IOperationContext context, ExecutingContext ec) Invoked on an operation each time prior to its being run.
void	setApplicationId(int id) Sets the id of this operation's application.
void	setConnectionAlias(java.lang.String newConnectionAlias) Sets the connection alias for this operation
void	setCurrentTab(java.lang.String tab, HttpServletRequest req) Sets the name of this operation's current tab.
void	setDefaultOperationCode() Sets the default operation code for this operation instance.
void	setDisplayColumns(java.util.List cols) Sets the display columns as Strings in a List
void	setDisplayColumns(java.lang.String value) Sets this display columns for this SQLOperation as a String, containing the column names separated by commas
void	setDisplayColumns(java.lang.String[] cols) Sets the display columns as Strings in an Array
void	setId(int value) Sets the id of this Operation
void	setId(java.lang.Integer value) Sets the id of this Operation
void	setOperationCode(java.lang.String code) Sets this Operation's code
void	setOwnerId(int id) Sets the id of this operation's owner.
void	setRowClass(java.lang.Class newRowClass) Sets the Java class to use when retrieving this SQLOperation's rows
protected void	setRowClassInternal(java.lang.Class newRowClass) Sets the Java class to use when retrieving this SQLOperation's rows
void	setRowClassName(java.lang.String rowClass) Sets the Java class to use when retrieving this SQLOperations's rows
protected void	setRowClassNameInternal(java.lang.String rowClass) Sets the Java class to use when retrieving this SQLOperation's rows
void	setRowCollectionClass(java.lang.Class newRowCollectionClass) Sets the Java class to use when retrieving this SQLOperation's row collection
protected void	setRowCollectionClassInternal(java.lang.Class newRowCollectionClass) Sets the Java class to use when retrieving this SQLOperation's row collection
void	setRowCollectionClassName(java.lang.String rowCollectionClass) Sets the Java class to use when retrieving this SQLOperation's row collection
protected void	setRowCollectionClassNameInternal(java.lang.String rowCollectionClass) Sets the Java class to use when retrieving this listview's row collection
void	setRowCount(int value) Sets this SQLOperation's row count
void	setUsageId(int usageid) Gets the usageId of the field.
Row	statusChanged(Field pField, ExecutingContext ec) Invoked when a status change takes place on of this Row's fields.
java.lang.String	toString() Returns a String representation of this Row.
int	update(java.sql.Connection conn, ExecutingContext ec) Updates the database with the values in this Row.
boolean	validate(ExecutingContext ec) Validate this Operation.
protected boolean	validateOperationCode(ExecutingContext ec) Validate the operations code.

Methods inherited from class planetj.dataengine.PropertyRow

getProperties, getRowPropertyGroup, getRowPropertyGroups, setProperties, setPropertiesInternal, setRowPropertyGroups, setRowPropertyGroupsInternal, transferDataTo, transferPropertiesTo

Methods inherited from class planetj.database.Row

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.dataengine.action.IActionObject

getActionRequest, getActionRequest, handleAction, isActionApplicable

Field Detail

className

public static final java.lang.String className

Class name.

Constructor Detail

Operation

public Operation()

Method Detail

getTitle

public java.lang.String getTitle()

Gets the title for this Operation, exactly as it was entered by the user, before parameter substitution

getTitleForDisplay

public java.lang.String getTitleForDisplay()

Gets the title for this Operation, exactly as it was entered by the user, before parameter substitution

adjustRequest

public void adjustRequest(IMagicRequest mr,
                          java.lang.Object result,
                          HttpServletRequest req,
                          HttpServletResponse res)
                   throws CMException

Some magic requests may invoke this method to adjust their settings

Parameters:

mr - The magic request invoking this method

result - The result of executing the magic request

Throws:

CMException

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

Overrides:

createAction in class Row

getDeleteConfirmationMessage

public java.lang.String getDeleteConfirmationMessage()

Get the message used when deleting an operation.

Overrides:

getDeleteConfirmationMessage in class Row

createMagicRequest

public final IMagicRequest createMagicRequest(java.lang.String id,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException

Deprecated. id no longer needed used createMagicRequest(request, response)

Creates a MagicRequest for viewing this operation.

Throws:

CMException

createMagicRequest

public final IMagicRequest createMagicRequest(java.lang.String id,
                                              Row row,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException

Deprecated. method is no longer supported

Throws:

CMException

createMagicRequest

public final IMagicRequest createMagicRequest(Field basedOnField,
                                              Row basedOnRow,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException

Creates a MagicRequest for viewing this operation.

Throws:

CMException

createMagicRequest

public final IMagicRequest createMagicRequest(java.lang.String id,
                                              Field basedOnField,
                                              Row basedOnRow,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException

Deprecated. id no longer needed - used createMagicRequest(Field, Row, request, response)

Creates a MagicRequest for viewing this operation.

Throws:

CMException

createMagicRequest

public IMagicRequest createMagicRequest(HttpServletRequest request,
                                        HttpServletResponse response)
                                 throws CMException

Creates a MagicRequest for viewing this operation.

Throws:

CMException

createRow

public Row createRow(Row row)
              throws CMException

Initializes this SQLOperation as it is retrieved from the DB

Specified by:

createRow in interface IRowCreator

Overrides:

createRow in class PropertyRow

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

Overrides:

createSQLContextForDelete in class Row

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

Overrides:

createSQLContextForInsert in class Row

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

Overrides:

createSQLContextForUpdate in class Row

Throws:

CMException

execute

public final java.lang.Object execute()
                               throws CMException

Executes this operation. Subclasses may override as needed. This method primarily servers as a convenience method for execute(ExecutingContext, Row).

Throws:

CMException

execute

public final java.lang.Object execute(ExecutingContext ec)
                               throws CMException

Executes this operation from the given executing context and Field. Subclasses may override as needed. This method primarily servers as a convenience method for execute(ExecutingContext, Row).

Parameters:

ec - ExecutingContext in which to execute this Operation

Throws:

CMException

execute

public final java.lang.Object execute(Field field)
                               throws CMException

Executes this operation from the given executing context and Field. Subclasses may override as needed. This method primarily servers as a convenience method for execute(ExecutingContext, Row).

Throws:

CMException

execute

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

Executes this operation from the given executing context and Field. Subclasses may override as needed. This method primarily servers as a convenience method for execute(ExecutingContext, Row).

Parameters:

ec - ExecutingContext in which to execute this Operation

field - Field containing a value and Row with values that may be used in execution of this Operation

Throws:

CMException

execute

public final java.lang.Object execute(ExecutingContext ec,
                                      Row row)
                               throws CMException

Executes this operation from the given executing context and Row. Subclasses should override to provide functionality.

Parameters:

ec - ExecutingContext in which to execute this Operation

row - Row containing values that may be used in execution of this Operation

Throws:

CMException

execute

public java.lang.Object execute(Field field,
                                Row row,
                                ExecutingContext ec)
                         throws CMException

Executes this operation from the given executing context and Row. Subclasses should override to provide functionality.

Parameters:

ec - ExecutingContext in which to execute this Operation

row - Row containing values that may be used in execution of this Operation

Throws:

CMException

getActionDefaultLocation

public java.lang.String getActionDefaultLocation()

Gets the default location for OperationActions

Specified by:

getActionDefaultLocation in interface IActionObject

Overrides:

getActionDefaultLocation in class Row

getActionDescriptor

public ActionDescriptor getActionDescriptor(AbstractAction action)

Gets the action descriptor for the specified action

Specified by:

getActionDescriptor in interface IActionObject

Overrides:

getActionDescriptor in class Row

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

Overrides:

getActions in class Row

getActionsForType

public java.util.List getActionsForType(java.lang.String type)
                                 throws CMException

Gets any actions for the given type of action that this operation contains.

Throws:

CMException

getApplication

public Application getApplication()
                           throws CMException

Gets the Application assoicated with this Operation (may be null if there is no such application).

Throws:

CMException

getApplicationId

public int getApplicationId()

Gets the ID of this SQLOperation's Application

getApplicationIdAsInteger

public java.lang.Integer getApplicationIdAsInteger()

Gets the ID of this SQLOperation's Application

getAutoRunStatus

public int getAutoRunStatus()

Gets the autorun status of this operation. If no value is set, the operation's auto run status is enabled

getAutoRunId

public int getAutoRunId()

Gets the autorun ID of this SQLOperation

getAutoRunOperation

public AutoRunOperation getAutoRunOperation()
                                     throws CMException

Get this operation's auto-run operation, which describes how and if this operation should be automatically run. Null is returned if this operation does not have a auto-run operation

Throws:

CMException

getChildren

public RowCollection getChildren()
                          throws CMException

Gets the children Operations of this Operation (may be null if Operation does not have any children)

Overrides:

getChildren in class Row

Returns:

children Operations (null if no children exists)

Throws:

CMException

getConnectionAlias

public java.lang.String getConnectionAlias()

Get the alias of the system where this Operation's data is located. This may be different than the alias of the system where the Operation table itself is located, which is returned by the getSystemAlias() method. If no connection alias has been specified for this Operation, then the connection alias of this Operation's application (if this Operation has an application) is returned.

Returns:

alias for system where this Operation's data resides.

getConnectionAlias

public java.lang.String getConnectionAlias(boolean checkApp)

Get the alias of the system where this Operation's data is located. This may be different than the alias of the system where the Operation table itself is located, which is returned by the getSystemAlias() method. If no connection alias has been specified for this Operation and specified, then the connection alias of this Operation's application (if this Operation has an application) is returned.

Returns:

alias for system where this Operation's data resides.

getConnectionRow

public ConnectionRow getConnectionRow()
                               throws CMException

Gets the ConnectionRow assoicated with this Operation

Throws:

CMException

getConnectionRow

public ConnectionRow getConnectionRow(boolean checkApp)
                               throws CMException

Gets the ConnectionRow assoicated with this Operation

Throws:

CMException

getCSSLinkClass

public java.lang.String getCSSLinkClass()

Gets the CSS class to use when displaying this operation's link in the TOC

getCurrentTab

public java.lang.String getCurrentTab(HttpServletRequest req)

Gets the name of this operation's current tab. (This is the name of the field whose associated operation is the tab's operation).

dataTransferred

protected void dataTransferred(Row oldRow)

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

Overrides:

dataTransferred in class Row

getDefaultOperationCode

public java.lang.String getDefaultOperationCode()

Return a default string to use on the operation field. Subclasses can override to provide a context sensitive op code. NOTE: This statement is used because on the iSeries, all systems have a table in library QIWS called QCUSTCDT.

getDependants

public RowCollection getDependants()
                            throws CMException

Gets the dependant Operations of this Operation (may be null if Operation does not have any children)

Returns:

dependant Operations (null if no dependants exists)

Throws:

CMException

getDependsOn

public Operation getDependsOn()
                       throws CMException

Gets the Operation this Operation depends on (may be null if Operation does not depend on another Operation)

Throws:

CMException

getDependsOnId

public int getDependsOnId()

Get the id of the Operation this Operation depends on.

Returns:

depends on id; -1 if Operation doesn't depend on another Operation

getDependsOnIdAsInteger

public java.lang.Integer getDependsOnIdAsInteger()

Get the id of the Operation this Operation depends on.

Returns:

id

getDetailsJspFile

public java.lang.String getDetailsJspFile()

Gets the JSP used to display this SQLOperation's details

getDisplayColumns

public java.util.List getDisplayColumns()

Gets the display columns as Strings in a List

getDisplayColumnsAsString

public java.lang.String getDisplayColumnsAsString()

Gets the display columns, separated by commas in a String

getDisplayColumnsAsStringArray

public java.lang.String[] getDisplayColumnsAsStringArray()

Gets the display columns as Strings in an Array. If no columns are specified, null is returned

getDisplayLocation

public java.lang.String getDisplayLocation()

Gets this operation's display location, which section in the layout it should be listed.

getDisplayOrder

public int getDisplayOrder()

Gets this SQLOperation's display order. The display order determine how listings of SQLOperations are ordered

getDisplayRule

public int getDisplayRule()

Field for future expansion.

getExecutionRule

public int getExecutionRule()

Gets the execution rule, either PROMPT_THEN_EXECUTE or EXECUTE_THEN_PROMPT

getFieldDefaultValue

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

Description copied from class: Row

Get the field's default value as a String.

Overrides:

getFieldDefaultValue in class Row

Throws:

CMException

getId

public int getId()

Gets the id of this Operation

getIdAsInteger

public java.lang.Integer getIdAsInteger()

Gets the id of this operation.

Returns:

id

getInstructions

public java.lang.String getInstructions()

Gets this Operation's instructions

getJspFile

public java.lang.String getJspFile()

Gets this Operation's JSP file

getLabel

public java.lang.String getLabel()

Gets the label for this SQLOperation . The label is the text displayed on the link to the Operation

getLayoutProperties

public LayoutDisplayPropertyGroup getLayoutProperties()

Gets this Operation's layout properties.

getNavigationSuffix

public java.lang.String getNavigationSuffix()

Gets the navigation suffix to use for this operation. Normally WOW will pick an appropriate suffix for your operation, but you can use this method to override. It should never return null.

getNewContext

public final IOperationContext getNewContext()
                                      throws CMException

Gets a new IOperationContext for this operation.

Throws:

CMException

getNewContext

public final IOperationContext getNewContext(Field field,
                                             Row row,
                                             ExecutingContext ec)
                                      throws CMException

Gets a new IOperationContext for this operation.

Throws:

CMException

getNewContextInternal

protected final IOperationContext getNewContextInternal()
                                                 throws CMException

Deprecated.

Gets a new IOperationContext for this operation. Subclasses should return the proper context.

Throws:

CMException

getNewContextInternal

protected IOperationContext getNewContextInternal(Field field,
                                                  Row row,
                                                  ExecutingContext ec)
                                           throws CMException

Gets a new IOperationContext for this operation. Subclasses should return the proper context.

Throws:

CMException

getOperationClass

public static java.lang.Class getOperationClass(int operationType)

Gets the Operation java class which should be used to represent an operation of the specified type

getOutputAlias

public java.lang.String getOutputAlias()

Gets this SQLOperation's Output Alias

getOriginalInstructions

public java.lang.String getOriginalInstructions()

Gets this Operation's instructions, exactly as they were entered by the user before any parameter substitution

getOperationCode

public java.lang.String getOperationCode()

Gets this Operation's code

setOperationCode

public void setOperationCode(java.lang.String code)
                      throws CMException

Sets this Operation's code

Throws:

CMException

getOperationHandledActionNames

public java.util.List getOperationHandledActionNames(ExecutingContext ec)

Get a List of names of actions handled by this Operation. 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

getOperationSetName

public java.lang.String getOperationSetName()

Gets this SQLOperation's operation set name. The OperationSet determines how listings of SQLOperations are grouped.

getOwnerId

public int getOwnerId()

Gets the owner ID of this SQLOperation

getOwnerIdField

public Field getOwnerIdField()

Returns the Owner Id Field

See Also:

IOwner

getParametersJspFile

public java.lang.String getParametersJspFile()

Gets the JSP used to query the user for this Operation's parameters

getParent

public Operation getParent()
                    throws CMException

Gets the parent Operation of this Operation (may be null if Operation does not have a parent)

Returns:

parent Operation (null if no parent exists)

Throws:

CMException

getParentId

public int getParentId()

Get the parent id of this Operation.

Returns:

parent id; -1 if Operation does not have a parent Operation

getParentIdAsInteger

public java.lang.Integer getParentIdAsInteger()

Get the parent id of this operation.

Returns:

id

getPropertyFieldName

public java.lang.String getPropertyFieldName()

Get the name of the Field containing this Row's properties..

Specified by:

getPropertyFieldName in class PropertyRow

getRowClass

public java.lang.Class getRowClass()

Gets the Row class to use when this SQLOperation's query is run (may be null)

getRowClassName

public java.lang.String getRowClassName()

Gets the name of the Row class to use when this SQLOperation's query is run (may be null)

getRowCollectionClass

public java.lang.Class getRowCollectionClass()

Gets the RowCollection class to use when this SQLOperation's query is run (may be null)

getRowCollectionClassName

public java.lang.String getRowCollectionClassName()

Gets the name of the RowCollection class to use when this SQLOperation's query is run (may be null)

getRowCount

public int getRowCount()

Gets the row count to use when retrieving rows for this SQLOperation

getRowPropertyGroups

public PropertyGroupList getRowPropertyGroups()

Gets this SQLOperation's operation set name. The OperationSet determines how listings of SQLOperations are grouped.

Overrides:

getRowPropertyGroups in class PropertyRow

getSecurityId

public int getSecurityId()

Gets the security ID of this SQLOperation

getSecurityType

public int getSecurityType()

Check whether this Operation is protected (secured)

Specified by:

getSecurityType in interface IGuarded

Overrides:

getSecurityType in class Row

Returns:

boolean

getType

public int getType()

Gets the type of this Operation.

getUsageId

public int getUsageId()

Gets the usageId of the field. A FieldDescriptor can be assigned a usageId to identify a particular usage. This can be used by powerful method to dynamically copy data with the same usageId. UI code can be written to look for fields with a particular usageId such as an electronic store where JSPs might anticipate a RowCollection coming in with usage fields for ItemId, ItemImage, Item Price, etc. It is the ultimate decoupling of UI, business logic, and Data See the documentaiton since it's pretty complicated especially for you.

getUserMessageForOperation

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

Returns a message for the user based on the Mode of the Row

Overrides:

getUserMessageForOperation in class Row

Returns:

String message for the user

See Also:

(see Row constants to find the modes.

hasDependants

public boolean hasDependants()
                      throws CMException

Tests to see if this Operation has any dependant operations.

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.

Overrides:

initializeRow in class Row

Throws:

CMException

insert

public int insert(SQLContext context)
           throws CMException

Inserts this Row into its table.

Overrides:

insert in class PropertyRow

Returns:

The number of Rows that were inserted

Throws:

CMException

isAllowDeletes

public boolean isAllowDeletes()

Tests whether or not rows can be deleted from this results of this SQLOperation if this SQLOperation is a query

isAllowDetails

public boolean isAllowDetails()

Tests whether or not the details of a row in this ListView can be viewed

isAllowInserts

public boolean isAllowInserts()

Tests whether or not rows can be inserted into the results of this SQLOperation

isAllowUpdates

public boolean isAllowUpdates()

Tests whether or not the results of this SQLOperation can be updated, if this SQLOperation is a query

isAssociation

public boolean isAssociation()

Check if this Operation is an association.

isAuthentication

public boolean isAuthentication()

Test if this SQLOperation is a Authentication type.

isAuthorizedForExecution

public boolean isAuthorizedForExecution(ExecutingContext ec)
                                 throws CMException

Test for authority to execute this operation.

Throws:

CMException

isAutoPopulate

public boolean isAutoPopulate()

Test if this SQLOperation is an Auto Populate.

isAutoRunOperation

public boolean isAutoRunOperation()

Tests if this operation is an autorun operation. This method is necessary - sometimes autorun operations may be stored in a SQLOperation object.

isBlobDownload

public boolean isBlobDownload()

Test if this SQLOperation is a Blob Download.

isChild

public boolean isChild()

Test to see if this Operation has a parent Operation.

isContextCurrent

public boolean isContextCurrent(IOperationContext context)
                         throws CMException

Test if the context was created from this operation, and if the contents of the context are still valid. (Changing an operation should invalidate all of the contexts created from it)

Returns:

true if invoking getNewContext() on this object would return a context equal to the one passed in

Throws:

CMException

isDependant

public boolean isDependant()
                    throws CMException

Test to see if this Operation depends on another Operation.

Throws:

CMException

isDisplayable

public boolean isDisplayable(ExecutingContext pEc)

Test if this SQLOperation is displayable

isDisplayRule

public boolean isDisplayRule(int displayRuleId,
                             ExecutingContext ec)

Check to see if this operation is part of the given layout section.

isExecutionGroup

public boolean isExecutionGroup()

Check to see if this operation is an execution group.

isFileUpload

public boolean isFileUpload()

Test if this SQLOperation is a File Upload.

isHide

public boolean isHide()

Test if this operation should be hidden from the menus.

isHtml

public boolean isHtml()

Tests if this operation is an HTML operation

isHTMLAssociation

public boolean isHTMLAssociation()

Check if this Operation is an HTML assocation type.

isHtmlCode

public boolean isHtmlCode()

Check to see if this operation is HTML code.

isHtmlCodeAssocation

public boolean isHtmlCodeAssocation()

Check to see if this operation is an HTML code association.

isHtmlReference

public boolean isHtmlReference()

Check to see if this operation is a HTML reference.

isHtmlReferenceAssociation

public boolean isHtmlReferenceAssociation()

Check to see if this operation is an HTML reference association.

isJava

public boolean isJava()

Tests if this operation is an Java operation

isJavaAssociation

public boolean isJavaAssociation()

Check to see if this operation is a Associated Java Operation

isJSPReference

public boolean isJSPReference()

Check to see if this operation is a JSP reference.

isJSPReferenceAssociation

public boolean isJSPReferenceAssociation()

Check to see if this operation is a JSP reference.

isOneToManyAssociation

public boolean isOneToManyAssociation()

Test if this SQLOperation is a 1-Many association.

isOneToOneAssociation

public boolean isOneToOneAssociation()

Test if this SQLOperation is a 1-1 association.

isParent

public boolean isParent()
                 throws CMException

Test to see if this Operation has any children Operations.

Throws:

CMException

isPleaseWait

public boolean isPleaseWait(ExecutingContext ec)
                     throws CMException

Is this operation a please wait operation?

Throws:

CMException

isPossibleValues

public boolean isPossibleValues()

Test if this SQLOperation is a Possible Values type.

isPossibleValuesSearch

public boolean isPossibleValuesSearch()

Test if this SQLOperation is a Possible Values Search type.

isPossibleValuesSelector

public boolean isPossibleValuesSelector()

Test if this SQLOperation is a PossibleValuesSelector.

isSQL

public boolean isSQL()

Test if this SQLOperation is a SQL type.

isSQLAssociation

public boolean isSQLAssociation()

Test if this SQLOperation is a Association type.

isTabDataOperation

public boolean isTabDataOperation()

Tests if this is a tab data operation (i.e. it is fetching data to display in a tab)

isUserAuthenticationListOperation

public boolean isUserAuthenticationListOperation()

Test if this SQLOperation is a User Authentication List Operation type.

isUserAuthorizationListOperation

public boolean isUserAuthorizationListOperation()

Test if this SQLOperation is a User Authorization List Operation type.

isUserAuthorizationOperation

public boolean isUserAuthorizationOperation()

Test if this SQLOperation is a User Authorization Operation type.

isUserPromptingRequired

public boolean isUserPromptingRequired()
                                throws CMException

Does the user need to be prompted for input. Subclasses should override if they need it.

Throws:

CMException

openForExecution

public final void openForExecution(Row associatedRow,
                                   ExecutingContext ec)
                            throws CMException

Throws:

CMException

prepareForRun

public void prepareForRun(IOperationContext context,
                          ExecutingContext ec)
                   throws CMException

Invoked on an operation each time prior to its being run. Subclasses may override

Throws:

CMException

setApplicationId

public void setApplicationId(int id)
                      throws CMException

Sets the id of this operation's application.

Throws:

CMException

setConnectionAlias

public void setConnectionAlias(java.lang.String newConnectionAlias)
                        throws CMException

Sets the connection alias for this operation

Throws:

CMException

setCurrentTab

public void setCurrentTab(java.lang.String tab,
                          HttpServletRequest req)

Sets the name of this operation's current tab. (This is the name of the field whose associated operation is the tab's operation).

setDefaultOperationCode

public void setDefaultOperationCode()
                             throws CMException

Sets the default operation code for this operation instance. This method is called if the WOW user changes the operation type which causes a stateChange operation which in turn calls this operation. We then update the OP CODE field within a WOW operation to be something useful for the type of operation.

Throws:

CMException

setDisplayColumns

public void setDisplayColumns(java.lang.String[] cols)
                       throws CMException

Sets the display columns as Strings in an Array

Throws:

CMException

setDisplayColumns

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

Sets this display columns for this SQLOperation as a String, containing the column names separated by commas

Throws:

CMException

setDisplayColumns

public void setDisplayColumns(java.util.List cols)
                       throws CMException

Sets the display columns as Strings in a List

Throws:

CMException

setId

public void setId(int value)
           throws CMException

Sets the id of this Operation

Throws:

CMException

setId

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

Sets the id of this Operation

Throws:

CMException

setOwnerId

public void setOwnerId(int id)
                throws CMException

Sets the id of this operation's owner.

Throws:

CMException

setRowClass

public void setRowClass(java.lang.Class newRowClass)
                 throws CMException

Sets the Java class to use when retrieving this SQLOperation's rows

Throws:

CMException

setRowClassInternal

protected void setRowClassInternal(java.lang.Class newRowClass)
                            throws CMException

Sets the Java class to use when retrieving this SQLOperation's rows

Throws:

CMException

setRowClassName

public void setRowClassName(java.lang.String rowClass)
                     throws CMException

Sets the Java class to use when retrieving this SQLOperations's rows

Throws:

CMException

setRowClassNameInternal

protected void setRowClassNameInternal(java.lang.String rowClass)
                                throws CMException

Sets the Java class to use when retrieving this SQLOperation's rows

Throws:

CMException

setRowCollectionClass

public void setRowCollectionClass(java.lang.Class newRowCollectionClass)
                           throws CMException

Sets the Java class to use when retrieving this SQLOperation's row collection

Throws:

CMException

setRowCollectionClassInternal

protected void setRowCollectionClassInternal(java.lang.Class newRowCollectionClass)
                                      throws CMException

Sets the Java class to use when retrieving this SQLOperation's row collection

Throws:

CMException

setRowCollectionClassName

public void setRowCollectionClassName(java.lang.String rowCollectionClass)
                               throws CMException

Sets the Java class to use when retrieving this SQLOperation's row collection

Throws:

CMException

setRowCollectionClassNameInternal

protected void setRowCollectionClassNameInternal(java.lang.String rowCollectionClass)
                                          throws CMException

Sets the Java class to use when retrieving this listview's row collection

Throws:

CMException

setRowCount

public void setRowCount(int value)
                 throws CMException

Sets this SQLOperation's row count

Throws:

CMException

setUsageId

public void setUsageId(int usageid)
                throws CMException

Gets the usageId of the field. A FieldDescriptor can be assigned a usageId to identify a particular usage. This can be used by powerful method to dynamically copy data with the same usageId. UI code can be written to look for fields with a particular usageId such as an electronic store where JSPs might anticipate a RowCollection coming in with usage fields for ItemId, ItemImage, Item Price, etc. It is the ultimate decoupling of UI, business logic, and Data See the documentaiton since it's pretty complicated especially for you.

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.

Overrides:

statusChanged in class Row

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

toString

public java.lang.String toString()

Returns a String representation of this Row.

Returns:

String

update

public int update(java.sql.Connection conn,
                  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.

Overrides:

update in class PropertyRow

Parameters:

conn - The connection to use for the update

Returns:

The number of updated rows

Throws:

CMException

validate

public boolean validate(ExecutingContext ec)
                 throws CMException

Validate this Operation.

Overrides:

validate in class Row

Parameters:

ec - current context in which application is executing

Returns:

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

Throws:

CMException

validateOperationCode

protected boolean validateOperationCode(ExecutingContext ec)
                                 throws CMException

Validate the operations code.

Throws:

CMException

postDelete

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

Description copied from class: Row

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

Overrides:

postDelete in class Row

Parameters:

ec - current context in which code is running

Throws:

CMException

postInsert

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

Description copied from class: Row

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

Overrides:

postInsert in class Row

Throws:

CMException