planetj.dataengine.sqloperation
Class SQLOperation

java.lang.Object
  |
  +--planetj.database.Row
        |
        +--planetj.dataengine.PropertyRow
              |
              +--planetj.dataengine.operation.Operation
                    |
                    +--planetj.dataengine.sqloperation.SQLOperation

All Implemented Interfaces:

Cloneable, IBatchProcessObject, IBusinessObject, ICSVRow, IDistributedExecutableObject, IFDFObject, IGuarded, INamedCollection, INavigationObject, IOperation, IOwner, IRowCreator, ISQLOperation, IXMLObject, Serializable

Direct Known Subclasses:

AuthenticationOperation, AutoRunOperation, MyTestOp, PossibleValuesSearchOperation, UserAuthorizationOperation

public class SQLOperation

extends Operation

implements Serializable, ISQLOperation, IOwner

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

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Row

Row.SpacingRow

Field Summary

Fields inherited from class planetj.dataengine.operation.Operation

className

Fields inherited from class planetj.database.Row

COPY, DELETE, INSERT, MODE_COPY, MODE_DELETE, MODE_INSERT, MODE_READ, MODE_SEARCH, MODE_UNKNOWN, MODE_UPDATE, READ, UPDATE

Fields inherited from interface planetj.dataengine.sqloperation.ISQLOperation

CACHING_LEVEL_CACHE_FOR_1_DAY, CACHING_LEVEL_CACHE_FOR_1_HOUR, CACHING_LEVEL_CACHE_FOR_1_WEEK, CACHING_LEVEL_CACHE_FOR_15_MINUTES, CACHING_LEVEL_CACHE_FOR_30_MINUTES, CACHING_LEVEL_CHECK_AND_STORE_IN_CACHE, CACHING_LEVEL_NO_CACHE, CACHING_LEVEL_ONLY_CHECK_CACHE, CACHING_LEVEL_ONLY_STORE_IN_CACHE, CURRENT_SQL_OPERATION, INSIDE_APPLICATION, SQL_OPERATION, SQL_OPERATION_HTTP_ID, SQL_OPERATION_ID, SQL_OPERATION_MODE, SQL_OPERATION_ONLY

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, 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_ORDER, ENCRYPTION_ID, EXECUTION_MODE, EXECUTION_MODE_NO, EXECUTION_MODE_YES, INSTRUCTIONS, JSP_FILE, LABEL, OPERATION_CLASS, OPERATION_CODE, OPERATION_DISPLAY_MODE, OPERATION_DISPLAY_MODE_FULL, OPERATION_DISPLAY_MODE_SKINNY, 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_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_REFERENCE, TYPE_HTML_REFERENCE_ASSOCIATION, TYPE_JAVA_OPERATION, TYPE_JSP_REFERENCE, TYPE_POSSIBLE_VALUES, TYPE_POSSIBLE_VALUES_SEARCH, TYPE_POSSIBLE_VALUES_SELECTOR, TYPE_REFERER_AUTHORIZATION_OPERATION, TYPE_SQL, 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

SQLOperation()

Method Summary

Row	createRow(Row row) Initializes this SQLOperation as it is retrieved from the DB
int	delete(Connection pConn, ExecutingContext ec) Delete this operation and reset any FieldDescriptors or other operations that reference this operation.
Object	execute(ExecutingContext pEc, Row pRow) Returns a result set that results from the SQL query Creation date: (4/23/2003 7:40:14 AM)
Object	execute(ExecutingContext ec, Row pRow, boolean checkConnectionPool) Returns a result set that results from the SQL query Creation date: (4/23/2003 7:40:14 AM)
int	getCachingLevel() Gets the caching level to use when retrieving a row collection for this SQLOperation
long	getCachingTimeMillis() Gets the amount of time this operation should be cached for.
String	getConnectionAlias() Get the alias of the system where this SQLOperation's data is located.
ConnectionRow	getConnectionRow() Gets the ConnectionRow assoicated with this Application
String	getDefaultOperationCode() Return a default string to use on the operation field.
String	getDescription() Gets the description for this SQLOperation
int	getEncryptionId() Gets the encryption ID of this SQLOperation
String	getHeaderText(ExecutingContext ec) Returns instruction header text
ApplicationSQLContext	getNewSQLOperationContext() Creates and returns a new SQLContext to perform this SQLOperation's query.
String	getOperationSQL() Gets this SQLOperation's SQL
String	getParametersJspFile() Gets the JSP used to query the user for this SQLOperation's parameters
int	getPerformanceStatisticsId() Gets the perfomrance statistics ID of this SQLOperation
ReportBreakCollection	getReportBreakCollection() Gets the ReportBreakCollection associated with this SQLOperation (may be null)
int	getSecuredTypeId() Gets the id of the secured type.
String	getSecuredTypeName() Gets the secured type name of the secured object.
String	getSetName() Gets the name of the set to which this SQLOperation belongs
int	getThemeId() Gets the theme ID of this SQLOperation
String	getTitle() Gets the title for this SQLOperation.
String	getTranslatedLabel(UserProperties up) Gets the label for this SQLOperation after translation
String	getTranslatedTitle(UserProperties up) Gets the title for this SQLOperation after translation.
boolean	isDeleteStatement() Tests if this operation is a delete statement.
boolean	isFieldApplicable(Field fld, ExecutingContext ec) Tests if a field is applicable in the current scenario
boolean	isInsertStatement() Tests whether or not rows can be inserted into the results of this SQLOperation
boolean	isSelectStatement() Tests whether or not rows can be inserted into the results of this SQLOperation
boolean	isSQLParameterized() Tests if this SQLOperation's SQL is parameterized and thus requires user input before it can be run
boolean	isUpdateStatement() Tests if this operation is an update statement.
boolean	isUserPromptingRequired() Does the user need to be prompted for input.
void	setAllowDeletes(boolean value) Sets if rows in the results of this SQLOperation can be deleted (if this SQLOperation is a query)
void	setAllowDetails(boolean value) Sets whether or not the details of the results of this SQLOperation can be viewed (if this SQLOperation is a query)
void	setAllowInserts(boolean value) Sets if rows can be inserted into the results of this SQLOperation if this SQLOperation represents a query
void	setAllowUpdates(boolean value) Sets if the results of this SQLOperation can be updated (if this SQLOperation is a query)
void	setApplicationId(int id) Set the ID of this SQLOperation's Application
void	setAutoRunId(int value) Sets this SQLOperation's auto run id
void	setCacheLevel(int value) Sets the caching level to use when retrieving this SQLOperation's row collection
void	setConnectionAlias(String connAlias) Sets the alias of the system where this SQLOperation's data is located.
void	setDescription(String value) Sets this SQLOperation's description
void	setDisplayOrder(int value) Sets this SQLOperation's display order.
void	setEncryptionId(int value) Sets this SQLOperation's encryption id
void	setInstructions(String value) Gets this SQLOperation's instructions
void	setIsSQLParameterized(boolean pUserPromptNeeded) Sets if this SQLOperation's SQL is parameterized and thus requires user input before it can be run
void	setJspFile(String newJspFile) Sets this SQLOperation's JSP file
void	setLabel(String value) Sets this SQLOperation's label.
void	setOperationSetName(String name) Sets this SQLOperation's operation set name.
void	setOperationSQL(String value) Sets this SQLOperation's SQL
void	setOwnerId(int value) Sets this SQLOperation's owner id
void	setParametersJspFile(String newJspFile) Sets the JSP used to query the user for this SQLOperation's parameters
void	setPerformanceStatisticsId(int value) Sets this SQLOperation's performance statistics id
void	setSecurityId(int value) Sets this SQLOperation's security id
void	setSetName(String value) Sets the name of the set to which this SQLOperation belongs
void	setThemeId(int value) Sets this SQLOperation's auto theme id
void	setTitle(String value) Sets this SQLOperation's title.
void	setType(int value) Sets this SQLOperation's type
boolean	validate(ExecutingContext ec) Validate this Row based on it's configuration and field values.
boolean	validate(int operation, Principal user) Validate this Row based on its configuration and field values.

Methods inherited from class planetj.dataengine.operation.Operation

createMagicRequest, createMagicRequest, createMagicRequest, createMagicRequest, execute, execute, getApplication, getApplicationId, getApplicationIdAsInteger, getAutoRunId, getAutoRunOperation, getAutoRunStatus, getChildren, getDeleteConfirmationMessage, getDependants, getDependsOn, getDependsOnId, getDependsOnIdAsInteger, getDetailsJspFile, getDisplayColumns, getDisplayColumnsAsString, getDisplayColumnsAsStringArray, getDisplayOrder, getId, getIdAsInteger, getInstructions, getJspFile, getLabel, getLayoutProperties, getNewContext, getOperationClass, getOperationCode, getOperationSetName, getOutputAlias, getOwnerId, getOwnerIdField, getParent, getParentId, getParentIdAsInteger, getPropertyFieldName, getRowClass, getRowClassName, getRowCollectionClass, getRowCollectionClassName, getRowCount, getRowPropertyGroups, getSecurityId, getSecurityType, getType, getUsageId, getUserMessageForOperation, hasDependants, insert, isAllowDeletes, isAllowDetails, isAllowInserts, isAllowUpdates, isAssociation, isAuthentication, isAuthorizedForExecution, isAutoPopulate, isAutoRunOperation, isBlobDownload, isChild, isContextCurrent, isDependant, isDisplayable, isExecutionGroup, isFileUpload, isHtml, isHTMLAssociation, isHtmlCode, isHtmlReference, isHtmlReferenceAssociation, isJava, isJavaAssociation, isJSPReference, isOneToManyAssociation, isOneToOneAssociation, isParent, isPossibleValues, isPossibleValuesSearch, isPossibleValuesSelector, isSQL, isSQLAssociation, isUserAuthenticationListOperation, isUserAuthorizationListOperation, isUserAuthorizationOperation, setDefaultOperationCode, setDisplayColumns, setDisplayColumns, setDisplayColumns, setId, setId, setRowClass, setRowClassName, setRowCollectionClass, setRowCollectionClassName, setRowCount, setUsageId, statusChanged, toString, update

Methods inherited from class planetj.dataengine.PropertyRow

getProperties, getRowPropertyGroup, getRowPropertyGroups, setProperties, transferDataTo

Methods inherited from class planetj.database.Row

add, add, addObject, addPropertyChangeListener, addPropertyChangeListener, addRowEventListener, addRowEventListeners, addTable, 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, defaultMerge, delete, delete, delete, deleteObject, divide, duplicateKey, equals, equals, equalsInstance, executeDistributedAction, fieldHasPossibleValuesSQLOperation, getAssociation, getAssociation, getAssociationByOperationUsageId, getAssociationOperation, getAttribute, getColumnSpan, getCompleteRow, getCompleteRow, getConfigProperty, getCopiedFieldValues, getCSVRow, getCSVRow, getDatabaseRow, getDatabaseRow, getDeleteConfirmation, getDisplayValue, getDistributedRequestorURL, getExternalName, getExternalNames, getFDFData, getFDTable, getField, getField, getField, getFieldDefaultValue, getFieldDescriptor, getFieldDescriptor, getFieldDescriptor, getFieldDescriptorsWithUsage, getFieldDescriptorsWithUsageId, getFieldDescriptorWithUsageId, getFieldDisplayValue, getFieldNames, getFields, getFields, getFieldSets, getFieldSQLObject, getFieldsToDisplay, getFieldsToDisplayStrict, getFieldsToDisplayStrict, getFieldStyleClass, getFieldValue, getFieldWithUsageId, getLibraryName, getMaxFieldLengths, getMaxFieldLengths, getMaxInsertRetries, getMetaDataSystemAlias, getNamed, getNamesOfUpdatedFields, getNavigationKey, getNavigationListKey, getPercentage, getPhysicalFieldNames, getPropertyGroup, getPropertyGroups, getPropertyGroups, getRowCollection, getRowDisplayAttributes, getRowDisplayAttributes, getRowKey, getSQL, getSQLContext, getStaticAttribute, getSum, getSystemAlias, getTable, getTable, getTableName, getTables, getTimestamp, getUpdatedFields, getUseWOWLibrary, getValidationExceptions, getValueAsBoolean, getValueAsByte, getValueAsDate, getValueAsDate, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsNumber, getValueAsShort, getValueAsString, getValueAsString, getValueByUsageId, getValues, getXMLData, getXMLData, getXMLHeaderData, handleDistributed, hasChildRows, hasMultipleStyleClasses, hasPropertyChangeListeners, insert, insert, insert, is, isARow, isARowCollection, isChanged, isChangedRealTime, isChangedSinceLastCheck, isCloneNeeded, isContainsAllFields, isCopyable, isDeletable, isDistinctRow, isDistributed, isEditable, isEmpty, isFieldAuthorizedForEdit, isFieldAuthorizedForRead, isFieldDisplayable, isFieldReadOnly, isFieldRequired, isFieldRequiredOnSearch, isFieldsChanged, isFieldValueNotBlank, isFieldValuesDatabaseDefaults, isGenerateChildRows, isGroupByRow, isGuarded, isHasColumnNames, isInARowCollection, isIncrementorResetAfterMaxInsertRetries, isInitializeDerivedFieldsEnabled, isJoinedRow, isKeyFieldsPresent, isLogicalRow, isMultipleDeleteEnabled, isPhysicalRow, isPropertyChangeEventsEnabled, isReturningFromPossibleValuesSearch, isRowKeyed, isSelectable, isUnionRow, isValidateRequired, isValidationRequiredForAutoPopulate, isViewable, iterator, merge, newField, newField, newField, newField, populate, postCreate, prepareForDetails, prepareFromFieldNames, removeNavigationKey, removePropertyChangeListener, removePropertyChangeListener, removeRowEventListener, removeRowEventListeners, replaceField, replaceFieldValues, rollbackChanges, setAttribute, setDistributed, setDistributedRequestorURL, setDistributedTargetURL, setFieldInitialValue, setFieldValue, setFieldValue, setFieldValue, setFieldValueAsString, setFieldValueAsString, setFieldValuesAsDate, setFieldValuesToDefault, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonUsageIds, setFieldValueToDefault, setMultipleDeleteEnabled, setNavigationKey, setPropertyChangeEventsEnabled, setPropertyGroups, setReturningFromPossibleValuesSearch, setSavepoint, setSavepoint, setSavepoint, setStaticAttribute, setTables, setTables, setUseWOWLibrary, setValidateRequired, setValues, size, splitAndSetFieldValues, toCSV, toDOC, toDOC, toFDF, toPDF, toPDF, toString, toUpperCase, toXML, transferDataTo, update, update, update, updateObject, validate, validateRowOperation

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.dataengine.application.IOwner

getOwnerIdField

Constructor Detail

SQLOperation

public SQLOperation()

Method Detail

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 Operation

Parameters:

row - 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

CMException

delete

public int delete(Connection pConn,
                  ExecutingContext ec)
           throws CMException

Delete this operation and reset any FieldDescriptors or other operations that reference this operation. Author: Paul Holm Date: (04/11/2003 6:05:56 PM)

Overrides:

delete in class Row

Parameters:

pConn - The connection to use for the deletion.

Returns:

The number of row that were deleted.

CMException

execute

public Object execute(ExecutingContext pEc,
                      Row pRow)
               throws CMException

Returns a result set that results from the SQL query Creation date: (4/23/2003 7:40:14 AM)

Overrides:

execute in class Operation

Parameters:

pRow - planetj.database.Row - needed to extract values for current row parameters: ??, ???

CMException

execute

public Object execute(ExecutingContext ec,
                      Row pRow,
                      boolean checkConnectionPool)
               throws CMException

Returns a result set that results from the SQL query Creation date: (4/23/2003 7:40:14 AM)

Parameters:

ec - planetj.dataengine.ExecutingContext - will be used in the future.

pRow - planetj.database.Row - needed to extract values for current row parameters: ??, ???

checkConnectionPool - boolean - true if connection pool should be started.

CMException

getCachingLevel

public final int getCachingLevel()

Gets the caching level to use when retrieving a row collection for this SQLOperation

getCachingTimeMillis

public final long getCachingTimeMillis()

Gets the amount of time this operation should be cached for.

Returns:

time operation should be cached for;

getConnectionAlias

public String getConnectionAlias()

Get the alias of the system where this SQLOperation's data is located. This may be different than the alias of the system where the SQLOperation 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 SQLOperation has an application) is returned.

Overrides:

getConnectionAlias in class Operation

Returns:

alias for system where this SQLOperation's data resides.

getConnectionRow

public ConnectionRow getConnectionRow()
                               throws CMException

Gets the ConnectionRow assoicated with this Application

CMException

getDefaultOperationCode

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

Overrides:

getDefaultOperationCode in class Operation

getDescription

public String getDescription()

Gets the description for this SQLOperation

getEncryptionId

public int getEncryptionId()

Gets the encryption ID of this SQLOperation

getHeaderText

public String getHeaderText(ExecutingContext ec)

Returns instruction header text

Overrides:

getHeaderText in class Row

Returns:

String header text

getNewSQLOperationContext

public ApplicationSQLContext getNewSQLOperationContext()
                                                throws CMException

Creates and returns a new SQLContext to perform this SQLOperation's query. Note that this is different than the {Row#getSQLContext() getSQLContext()} method which returns the SQLContext that was used to retrieve this SQLOperation

CMException

getOperationSQL

public String getOperationSQL()

Gets this SQLOperation's SQL

getParametersJspFile

public String getParametersJspFile()

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

getPerformanceStatisticsId

public int getPerformanceStatisticsId()

Gets the perfomrance statistics ID of this SQLOperation

getReportBreakCollection

public ReportBreakCollection getReportBreakCollection()
                                               throws DataEngineException

Gets the ReportBreakCollection associated with this SQLOperation (may be null)

DataEngineException

getSecuredTypeId

public int getSecuredTypeId()

Gets the id of the secured type.

Specified by:

getSecuredTypeId in interface IGuarded

Overrides:

getSecuredTypeId in class Row

getSecuredTypeName

public String getSecuredTypeName()

Gets the secured type name of the secured object.

Specified by:

getSecuredTypeName in interface IGuarded

Overrides:

getSecuredTypeName in class Row

getSetName

public String getSetName()

Gets the name of the set to which this SQLOperation belongs

getThemeId

public int getThemeId()

Gets the theme ID of this SQLOperation

getTitle

public String getTitle()

Gets the title for this SQLOperation. If there is no title, the label is used as the title.

getTranslatedLabel

public String getTranslatedLabel(UserProperties up)

Gets the label for this SQLOperation after translation

getTranslatedTitle

public String getTranslatedTitle(UserProperties up)

Gets the title for this SQLOperation after translation. If there is no title, the translated label is returned.

isDeleteStatement

public boolean isDeleteStatement()
                          throws CMException

Tests if this operation is a delete statement.

CMException

isFieldApplicable

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

Tests if a field is applicable in the current scenario

Overrides:

isFieldApplicable in class Row

Parameters:

fld - The field which may or may not be applicable

CMException

isInsertStatement

public boolean isInsertStatement()
                          throws CMException

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

CMException

isSelectStatement

public boolean isSelectStatement()
                          throws CMException

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

CMException

isSQLParameterized

public boolean isSQLParameterized()

Tests if this SQLOperation's SQL is parameterized and thus requires user input before it can be run

isUpdateStatement

public boolean isUpdateStatement()
                          throws CMException

Tests if this operation is an update statement.

CMException

isUserPromptingRequired

public boolean isUserPromptingRequired()
                                throws CMException

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

Overrides:

isUserPromptingRequired in class Operation

CMException

setAllowDeletes

public void setAllowDeletes(boolean value)
                     throws CMException

Sets if rows in the results of this SQLOperation can be deleted (if this SQLOperation is a query)

CMException

setAllowDetails

public void setAllowDetails(boolean value)
                     throws CMException

Sets whether or not the details of the results of this SQLOperation can be viewed (if this SQLOperation is a query)

CMException

setAllowInserts

public void setAllowInserts(boolean value)
                     throws CMException

Sets if rows can be inserted into the results of this SQLOperation if this SQLOperation represents a query

CMException

setAllowUpdates

public void setAllowUpdates(boolean value)
                     throws CMException

Sets if the results of this SQLOperation can be updated (if this SQLOperation is a query)

CMException

setApplicationId

public void setApplicationId(int id)
                      throws CMException

Set the ID of this SQLOperation's Application

CMException

setAutoRunId

public void setAutoRunId(int value)
                  throws CMException

Sets this SQLOperation's auto run id

CMException

setCacheLevel

public void setCacheLevel(int value)
                   throws CMException

Sets the caching level to use when retrieving this SQLOperation's row collection

CMException

setConnectionAlias

public void setConnectionAlias(String connAlias)
                        throws CMException

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

CMException

setDescription

public void setDescription(String value)
                    throws CMException

Sets this SQLOperation's description

CMException

setDisplayOrder

public void setDisplayOrder(int value)
                     throws CMException

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

CMException

setEncryptionId

public void setEncryptionId(int value)
                     throws CMException

Sets this SQLOperation's encryption id

CMException

setInstructions

public void setInstructions(String value)
                     throws CMException

Gets this SQLOperation's instructions

CMException

setIsSQLParameterized

public void setIsSQLParameterized(boolean pUserPromptNeeded)

Sets if this SQLOperation's SQL is parameterized and thus requires user input before it can be run

setJspFile

public void setJspFile(String newJspFile)
                throws CMException

Sets this SQLOperation's JSP file

CMException

setLabel

public void setLabel(String value)
              throws CMException

Sets this SQLOperation's label. The label is the text displayed on the link to the SQLOperation

CMException

setOperationSetName

public void setOperationSetName(String name)
                         throws CMException

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

CMException

setOperationSQL

public void setOperationSQL(String value)
                     throws CMException

Sets this SQLOperation's SQL

CMException

setOwnerId

public void setOwnerId(int value)
                throws CMException

Sets this SQLOperation's owner id

CMException

setParametersJspFile

public void setParametersJspFile(String newJspFile)
                          throws CMException

Sets the JSP used to query the user for this SQLOperation's parameters

CMException

setPerformanceStatisticsId

public void setPerformanceStatisticsId(int value)
                                throws CMException

Sets this SQLOperation's performance statistics id

CMException

setSecurityId

public void setSecurityId(int value)
                   throws CMException

Sets this SQLOperation's security id

CMException

setSetName

public void setSetName(String value)
                throws CMException

Sets the name of the set to which this SQLOperation belongs

CMException

setThemeId

public void setThemeId(int value)
                throws CMException

Sets this SQLOperation's auto theme id

CMException

setTitle

public void setTitle(String value)
              throws CMException

Sets this SQLOperation's title. If there is no title, the label is used as the title.

CMException

setType

public void setType(int value)
             throws CMException

Sets this SQLOperation's type

CMException

validate

public boolean validate(int operation,
                        Principal user)
                 throws CMException

Deprecated. on 4/15/2004. method no longer supported. use validate(ExecutingContext)

Description copied from class: Row

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.

Overrides:

validate in class Row

Parameters:

operation - i.e. Row.INSERT, Row.UPDATE, etc...

Returns:

boolean true if valid else and exception will be thrown

CMException

validate

public boolean validate(ExecutingContext ec)
                 throws CMException

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

Overrides:

validate in class Operation

Parameters:

ec - current context in which application is executing

Returns:

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

CMException