planetj.dataengine.application
Class Application

java.lang.Object
  planetj.database.Row
      planetj.dataengine.PropertyRow
          planetj.dataengine.application.Application

All Implemented Interfaces:

java.lang.Cloneable, IActionObject, IApplication, IApplicationJSPs, IBatchProcessObject, IBusinessObject, ICSVRow, IFDFObject, IGuarded, INamedCollection, INavigationObject, IOwner, IRowCreator, ISecured, IXMLObject, java.io.Serializable

Direct Known Subclasses:

DynamicConnectionApplication

public class Application

extends PropertyRow

implements java.io.Serializable, IApplication, ISecured, IOwner, IApplicationJSPs

Contains information describing a DataEngine application Creation date: (3/21/2002 1:11:21 PM)

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Row

Row.SpacingRow

Field Summary

Fields inherited from class planetj.database.Row

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.application.IApplication

APPLICATION_CLASS, APPLICATION_HTTP_ID, APPLICATION_ID, APPLICATION_JSP_FILE, APPLICATION_METADATA_ALIAS, APPLICATION_NAME, APPLICATION_RESULTS_KEY, APPLICATION_TABLE_NAME, AUTO_RUN_STATUS, COMPANY_ID, COMPANY_NAME, CONNECTION_ALIAS, CURRENT_EXECUTING_APPLICATION, CURRENT_WOW_APPLICATION, DESCRIPTION, ERROR_JSP_FILE, INITIAL_VIEW, MANAGE, OPTIONAL_SIGNON, OWNER_ID, PASSWORD, PROPERTIES, SERVLET_URI, SIGN_ON_CLASS, SIGN_ON_OP_ID, SIGN_ON_URI, THEME_ID, USER_ID, VERIFY_CONNECTION

Fields inherited from interface planetj.dataengine.security.http.ISecured

SECURED_APPLICATION

Fields inherited from interface planetj.dataengine.application.IApplicationJSPs

APPLICATION_ADD_JSP, APPLICATION_DETAILS_JSP, APPLICATION_EDIT_JSP, APPLICATION_ERROR_JSP, APPLICATION_HEADER_JSP, APPLICATION_INVALID_LICENSE_JSP, APPLICATION_JSP, APPLICATION_MESSAGE_JSP, APPLICATION_OPERATIONS_TOC, APPLICATION_RESULTS_JSP, APPLICATION_SIGN_ON_JSP, APPLICATION_TEMPLATE_JSP, APPLICATION_TOC_JSP, APPLICATION_VIEW_JSP

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

Application()

Method Summary

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.
SQLOperation	createSQLOperation(java.util.Map pValues) Creates a SQLOperation using the given values and adds it to this Application.
java.lang.Class	getApplicationClass() Gets the Java class for this Application.
java.lang.String	getApplicationClassName() Gets the Java class for this Application.
static Operation	getApplicationOperationByUsageId(int usageId, ExecutingContext ec) Gets this Operation with the given usage id from the Application in the current executing context.
SQLOperation	getAuthenticationOperation() Gets this Application's Operation with a type of Authorization.
int	getAutoRunStatus() Gets a constant representing the auto-run status.
java.lang.String	getCompanyName() Gets the company name associated with this secured object
java.lang.String	getConnectionAlias() Gets the connection alias for this application
ConnectionRow	getConnectionRow() Gets the ConnectionRow assoicated with this Application
java.lang.String	getDeleteConfirmationMessage() Get the message used when deleting an application.
java.lang.String	getDescription() Gets the description for this application
java.lang.String	getErrorJsp() Gets the name of the JSP used for displaying errors.
java.lang.String	getHeaderText(ExecutingContext ec) Returns information for the user that will be displayed in the header of the Row
int	getId() Gets the ID of this application
java.lang.Integer	getIdAsInteger() Gets the ID of this application
Operation	getInitialOperation() Gets this application's initial operation (may be null)
java.lang.String	getJspFile() Gets this application's JSP file
LayoutDisplayPropertyGroup	getLayoutProperties() Gets this application's layout properties
java.lang.String	getName() Gets the name of this application
Operation	getOperationById(int opId) Gets this application's operations for the given usage id.
Operation	getOperationByUsageId(int usageId, ExecutingContext executingContext) Gets this application's operations for the given usage id.
RowCollection	getOperations() Returns all the SQL Opps for this App.
RowCollection	getOperations(ExecutingContext executingContext) Gets this application's operations.
RowCollection	getOperations(java.lang.String opSetName, ExecutingContext executingContext) Gets this application's operations belonging to the given operation set name.
RowCollection	getOperationsByUsageId(int usageId, ExecutingContext executingContext) Gets this application's operations for the given usage id.
int	getOwnerId() Gets the ID of this application's owner
java.lang.Integer	getOwnerIdAsInteger() Gets the ID of this application's owner
Field	getOwnerIdField() Returns the Owner Id Field
java.lang.String	getPassword() Gets the password for this application
java.lang.String	getProperties() Gets the property string associated with this SQLOperation
java.lang.String	getPropertyFieldName() Get the name of the Field containing this Row's properties..
RefererAuthorizationOperation	getRefererAuthorizationOperation() Gets this Application's Operation with a type ofn Referer Authorization
java.util.Map	getReplacementLibraries() Gets this application's replacement libraries from its config properties
java.lang.Class	getSignOnClass() Gets the sign on class for this Application.
java.lang.String	getSignOnClassName() Gets the sign on class for this Application.
Operation	getSignOnOperation() Gets the sign on operation for this Application.
int	getSignOnOperationId() Gets the sign on operation for this Application.
java.lang.String	getSignOnURI() Gets the uri for signing onto this application
RowCollection	getSQLOperations() Deprecated. replaced with getOperations()
RowCollection	getSQLOperations(ExecutingContext executingContext) Deprecated. replaced with getOperations(ExecutingContext)
Theme	getTheme() Gets the Theme associated with this application.
int	getThemeId() Gets the ID of this application's theme.
java.lang.Integer	getThemeIdAsInteger() Gets the ID of this application's theme.
java.lang.String	getTranslatedName(UserProperties up) Gets the translated name of this application
UserAuthenticationListOperation	getUserAuthenticationListOperation() Gets this Application's Operation with a type of User Authorization List.
java.lang.String	getUserId() Gets the userid for this application
java.lang.String	getUserMessageForOperation(int changeCount, int mode) Returns a message for the user based on the Mode of the Row
boolean	handleError(short wowErrorCode, java.lang.Exception e, ExecutingContext ec) This method is called when a navigation error occurs.
boolean	hasDisplayableOperation(ExecutingContext executingContext) Test if this Application contains a SQLOperation that is displayable
protected void	initializeApplication() Subclasses may put application initialization in this method.
protected void	initializeRow(java.util.List fieldNames, ExecutingContext pExecutingContext) 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 the specified database.
boolean	isContainDisplayableOperations(ExecutingContext ec) Check to see if this application contains displayable operations for the given location
boolean	isContainDisplayableOperations(java.lang.String displayLocation, ExecutingContext ec) Check to see if this application contains displayable operations for the given location
boolean	isContainSQLOperation() Deprecated.
boolean	isEnabled(AutoRunOperation op) Tests if the auto-run operation's type is enabled for this application
boolean	isOperationPleaseWait(Operation op, ExecutingContext ec) Tests if the operation should display a please wait page
boolean	isSignOnOptional() Tests if the sign-on for this application is optional
void	setApplicationClass(java.lang.Class newAppClass) Sets the Java class for this Application.
protected void	setApplicationClassInternal(java.lang.Class newAppClass) Sets the Java class for this Application.
void	setApplicationClassName(java.lang.String applicationClass) Sets the Java class for this Application.
protected void	setApplicationClassNameInternal(java.lang.String applicationClass) Sets the Java class for this Application.
void	setCompanyName(java.lang.String name) Sets the name of this application
void	setConnectionAlias(java.lang.String newConnectionAlias) Sets the connection alias for this application
void	setDescription(java.lang.String value) Sets the description for this application
void	setErrorJspFile(java.lang.String newJspFile) Sets this application's error JSP file
void	setId(int value) Sets the ID of this application
void	setId(java.lang.Integer value) Sets the ID of this application
void	setInitialOperation(Operation operation) Sets this Application's initial Operation
void	setInitialView(View pInitialView) Deprecated. - use setInitialOperation instead
void	setJspFile(java.lang.String newJspFile) Sets this application's JSP file
void	setName(java.lang.String name) Sets the name of this application
void	setOwnerId(int value) Sets the ID of this application's owner
void	setOwnerId(java.lang.Integer value) Sets the ID of this application's owner
void	setPassword(java.lang.String value) Sets the password for this application
void	setSignOnClass(java.lang.Class newSignOnClass) Sets the sign on class for this Application.
void	setSignOnClassName(java.lang.String name) Sets the sign on class for this Application.
protected void	setSignOnClassNameInternal(java.lang.String signOnClass) Sets the sign on class for this Application.
void	setSignOnOperationId(int id) Sets the sign on operation for this Application.
void	setSignOnURI(java.lang.String value) Sets the URI for signing onto this application
void	setThemeId(int value) Sets the ID of this application's theme.
void	setThemeId(java.lang.Integer value) Sets the ID of this application's theme.
void	setUserId(java.lang.String value) Sets the userid for this application
void	signOnAttempted(java.lang.String userID, boolean success) Invoked by the security manager after a signon attempt.
void	startConnections() Ensures that all of the connection that this application may use have been started
java.lang.String	toString() Returns a String representation of this Application.
int	update(java.sql.Connection conn, ExecutingContext ec) Updates the database with the values in this Row.
boolean	validate(ExecutingContext pContext) Validate this Row based on its configuration and field values.

Methods inherited from class planetj.dataengine.PropertyRow

getRowPropertyGroup, getRowPropertyGroups, 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, createAction, createNamedActionRequest, dataTransferred, defaultMerge, delete, delete, delete, delete, deleteObject, divide, duplicateKey, duplicateKey, enforceExclusiveOr, equals, equals, equalsInstance, fieldHasPossibleValuesSQLOperation, firePropertyChange, fireRowEvent, getActionDefaultLocation, getActionDescriptor, getActionRequest, getActionRequest, getActions, getActionsForFields, getActionsForOperation, getAssociation, getAssociation, getAssociationByOperationUsageId, getAssociationOperation, getAttribute, getAutoIncrementDatabaseDrivenField, getBackgroundColor, getChangedFields, getChildren, 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, getFieldDefaultValue, 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, 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, getSecurityType, 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, postDelete, postExtract, postInsert, 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, statusChanged, 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.security.http.ISecured

getSystemAlias

Constructor Detail

Application

public Application()

Method Detail

getHeaderText

public java.lang.String getHeaderText(ExecutingContext ec)

Description copied from class: Row

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

Overrides:

getHeaderText in class Row

Returns:

String

getDeleteConfirmationMessage

public java.lang.String getDeleteConfirmationMessage()

Get the message used when deleting an application.

Overrides:

getDeleteConfirmationMessage in class Row

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

Overrides:

createRow in class PropertyRow

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

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

createSQLOperation

public SQLOperation createSQLOperation(java.util.Map pValues)
                                throws CMException

Creates a SQLOperation using the given values and adds it to this Application. Note: This does not save a SQLOperation to the database.

Parameters:

pValues - Map of values for the newly created SQLOperation

Throws:

CMException

getApplicationClass

public java.lang.Class getApplicationClass()

Gets the Java class for this Application.

getApplicationClassName

public java.lang.String getApplicationClassName()

Gets the Java class for this Application.

getApplicationOperationByUsageId

public static Operation getApplicationOperationByUsageId(int usageId,
                                                         ExecutingContext ec)
                                                  throws CMException

Gets this Operation with the given usage id from the Application in the current executing context.

Parameters:

usageId - usage id of the Operation to get

ec - ExecutingContext in which to retrieve the desired Operation return Operation for the given usage id; Note: if no application is set on the ExecutingContext, then no Operation can be retrieved.

Throws:

CMException

getAuthenticationOperation

public SQLOperation getAuthenticationOperation()

Gets this Application's Operation with a type of Authorization.

getAutoRunStatus

public int getAutoRunStatus()

Gets a constant representing the auto-run status. If no value is set, the application's auto run status is disabled

getCompanyName

public java.lang.String getCompanyName()

Description copied from interface: ISecured

Gets the company name associated with this secured object

Specified by:

getCompanyName in interface ISecured

getConnectionAlias

public java.lang.String getConnectionAlias()

Gets the connection alias for this application

getConnectionRow

public ConnectionRow getConnectionRow()
                               throws CMException

Gets the ConnectionRow assoicated with this Application

Throws:

CMException

getDescription

public java.lang.String getDescription()

Gets the description for this application

getErrorJsp

public java.lang.String getErrorJsp()

Gets the name of the JSP used for displaying errors. If no such value is stored in the database, a default value will be returned.

getId

public int getId()

Gets the ID of this application

Specified by:

getId in interface ISecured

getIdAsInteger

public java.lang.Integer getIdAsInteger()

Gets the ID of this application

getInitialOperation

public Operation getInitialOperation()
                              throws CMException

Gets this application's initial operation (may be null)

Throws:

CMException

getJspFile

public java.lang.String getJspFile()

Gets this application's JSP file

getLayoutProperties

public LayoutDisplayPropertyGroup getLayoutProperties()

Gets this application's layout properties

Specified by:

getLayoutProperties in interface ISecured

getName

public java.lang.String getName()

Gets the name of this application

Specified by:

getName in interface ISecured

getOperationById

public Operation getOperationById(int opId)
                           throws CMException

Gets this application's operations for the given usage id.

Throws:

CMException

getOperationByUsageId

public Operation getOperationByUsageId(int usageId,
                                       ExecutingContext executingContext)
                                throws CMException

Gets this application's operations for the given usage id.

Throws:

CMException

getOperations

public RowCollection getOperations()
                            throws CMException

Returns all the SQL Opps for this App. Creation date: (7/18/2002 5:19:23 PM)

Throws:

CMException

getOperations

public RowCollection getOperations(java.lang.String opSetName,
                                   ExecutingContext executingContext)
                            throws CMException

Gets this application's operations belonging to the given operation set name.

Throws:

CMException

getOperations

public RowCollection getOperations(ExecutingContext executingContext)
                            throws CMException

Gets this application's operations.

Throws:

CMException

getOperationsByUsageId

public RowCollection getOperationsByUsageId(int usageId,
                                            ExecutingContext executingContext)
                                     throws CMException

Gets this application's operations for the given usage id.

Throws:

CMException

getOwnerId

public int getOwnerId()

Gets the ID of this application's owner

Specified by:

getOwnerId in interface ISecured

getOwnerIdAsInteger

public java.lang.Integer getOwnerIdAsInteger()

Gets the ID of this application's owner

getOwnerIdField

public Field getOwnerIdField()

Returns the Owner Id Field

Specified by:

getOwnerIdField in interface IOwner

Returns:

planetj.database.Field

See Also:

IOwner

getPassword

public java.lang.String getPassword()

Gets the password for this application

getProperties

public java.lang.String getProperties()

Gets the property string associated with this SQLOperation

Overrides:

getProperties in class PropertyRow

getPropertyFieldName

public java.lang.String getPropertyFieldName()

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

Specified by:

getPropertyFieldName in class PropertyRow

getRefererAuthorizationOperation

public RefererAuthorizationOperation getRefererAuthorizationOperation()

Gets this Application's Operation with a type ofn Referer Authorization

getReplacementLibraries

public java.util.Map getReplacementLibraries()

Gets this application's replacement libraries from its config properties

getSignOnClass

public java.lang.Class getSignOnClass()

Gets the sign on class for this Application. If this is null anyone will be able to use the Application.

Specified by:

getSignOnClass in interface ISecured

getSignOnClassName

public java.lang.String getSignOnClassName()

Gets the sign on class for this Application. If this is null anyone will be able to use the Application.

getSignOnOperation

public Operation getSignOnOperation()
                             throws CMException

Gets the sign on operation for this Application.

Throws:

CMException

getSignOnOperationId

public int getSignOnOperationId()

Gets the sign on operation for this Application.

getSignOnURI

public java.lang.String getSignOnURI()

Gets the uri for signing onto this application

Specified by:

getSignOnURI in interface ISecured

getSQLOperations

public RowCollection getSQLOperations()
                               throws CMException

Deprecated. replaced with getOperations()

Returns all the SQL Opps for this App. Creation date: (7/18/2002 5:19:23 PM)

Throws:

CMException

getSQLOperations

public RowCollection getSQLOperations(ExecutingContext executingContext)
                               throws CMException

Deprecated. replaced with getOperations(ExecutingContext)

Gets this application's operations.

Throws:

CMException

getTheme

public Theme getTheme()
               throws CMException

Gets the Theme associated with this application.

Throws:

CMException

getThemeId

public int getThemeId()

Gets the ID of this application's theme.

getThemeIdAsInteger

public java.lang.Integer getThemeIdAsInteger()

Gets the ID of this application's theme.

getTranslatedName

public java.lang.String getTranslatedName(UserProperties up)

Gets the translated name of this application

getUserAuthenticationListOperation

public UserAuthenticationListOperation getUserAuthenticationListOperation()

Gets this Application's Operation with a type of User Authorization List.

getUserId

public java.lang.String getUserId()

Gets the userid for this application

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.

hasDisplayableOperation

public boolean hasDisplayableOperation(ExecutingContext executingContext)
                                throws CMException

Test if this Application contains a SQLOperation that is displayable

Throws:

CMException

handleError

public boolean handleError(short wowErrorCode,
                           java.lang.Exception e,
                           ExecutingContext ec)

This method is called when a navigation error occurs. It allows an application to control the logic and flow.

Returns:

true if application handled error; false otherwise

initializeApplication

protected void initializeApplication()
                              throws CMException

Subclasses may put application initialization in this method. This method is invoked after this application object has been read from the DB and put into the cache. Due to cache refreshing and query differences this method may be invoked multiple times per WOW application, however it will only be invoked once per Application object.

Throws:

CMException

initializeRow

protected void initializeRow(java.util.List fieldNames,
                             ExecutingContext pExecutingContext)
                      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 the specified database.

Overrides:

insert in class PropertyRow

Returns:

The number of Rows that were inserted

Throws:

CMException

isContainDisplayableOperations

public boolean isContainDisplayableOperations(ExecutingContext ec)

Check to see if this application contains displayable operations for the given location

isContainDisplayableOperations

public boolean isContainDisplayableOperations(java.lang.String displayLocation,
                                              ExecutingContext ec)

Check to see if this application contains displayable operations for the given location

isContainSQLOperation

public boolean isContainSQLOperation()
                              throws CMException

Deprecated.

Test if this Application contains a SQLOperation that is of a SQL type.

Throws:

CMException

isEnabled

public boolean isEnabled(AutoRunOperation op)

Tests if the auto-run operation's type is enabled for this application

isOperationPleaseWait

public boolean isOperationPleaseWait(Operation op,
                                     ExecutingContext ec)
                              throws CMException

Tests if the operation should display a please wait page

Throws:

CMException

isSignOnOptional

public boolean isSignOnOptional()

Tests if the sign-on for this application is optional

setApplicationClass

public void setApplicationClass(java.lang.Class newAppClass)
                         throws CMException

Sets the Java class for this Application.

Throws:

CMException

setApplicationClassInternal

protected void setApplicationClassInternal(java.lang.Class newAppClass)
                                    throws CMException

Sets the Java class for this Application.

Throws:

CMException

setApplicationClassName

public void setApplicationClassName(java.lang.String applicationClass)
                             throws CMException

Sets the Java class for this Application.

Throws:

CMException

setApplicationClassNameInternal

protected void setApplicationClassNameInternal(java.lang.String applicationClass)
                                        throws CMException

Sets the Java class for this Application.

Throws:

CMException

setCompanyName

public void setCompanyName(java.lang.String name)
                    throws CMException

Sets the name of this application

Throws:

CMException

setConnectionAlias

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

Sets the connection alias for this application

Throws:

CMException

setDescription

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

Sets the description for this application

Throws:

CMException

setErrorJspFile

public void setErrorJspFile(java.lang.String newJspFile)
                     throws CMException

Sets this application's error JSP file

Throws:

CMException

setId

public void setId(int value)
           throws CMException

Sets the ID of this application

Throws:

CMException

setId

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

Sets the ID of this application

Throws:

CMException

setInitialOperation

public void setInitialOperation(Operation operation)
                         throws CMException

Sets this Application's initial Operation

Throws:

CMException

setInitialView

public void setInitialView(View pInitialView)
                    throws CMException

Deprecated. - use setInitialOperation instead

Sets this application's initial view

Throws:

CMException

setJspFile

public void setJspFile(java.lang.String newJspFile)
                throws CMException

Sets this application's JSP file

Throws:

CMException

setName

public void setName(java.lang.String name)
             throws CMException

Sets the name of this application

Throws:

CMException

setOwnerId

public void setOwnerId(int value)
                throws CMException

Sets the ID of this application's owner

Throws:

CMException

setOwnerId

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

Sets the ID of this application's owner

Throws:

CMException

setPassword

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

Sets the password for this application

Throws:

CMException

setSignOnClass

public void setSignOnClass(java.lang.Class newSignOnClass)
                    throws CMException

Sets the sign on class for this Application. If this is null anyone will be able to use the Application.

Throws:

CMException

setSignOnClassName

public void setSignOnClassName(java.lang.String name)
                        throws CMException

Sets the sign on class for this Application. If this is null anyone will be able to use the Application.

Throws:

CMException

setSignOnClassNameInternal

protected void setSignOnClassNameInternal(java.lang.String signOnClass)
                                   throws CMException

Sets the sign on class for this Application. If this is null anyone will be able to use the Application.

Throws:

CMException

setSignOnOperationId

public void setSignOnOperationId(int id)
                          throws CMException

Sets the sign on operation for this Application.

Throws:

CMException

setSignOnURI

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

Sets the URI for signing onto this application

Throws:

CMException

setThemeId

public void setThemeId(int value)
                throws CMException

Sets the ID of this application's theme.

Throws:

CMException

setThemeId

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

Sets the ID of this application's theme.

Throws:

CMException

setUserId

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

Sets the userid for this application

Throws:

CMException

signOnAttempted

public void signOnAttempted(java.lang.String userID,
                            boolean success)
                     throws CMException

Invoked by the security manager after a signon attempt. Subclasses may override

Specified by:

signOnAttempted in interface ISecured

Throws:

CMException

startConnections

public void startConnections()
                      throws CMException

Ensures that all of the connection that this application may use have been started

Throws:

CMException

toString

public java.lang.String toString()

Returns a String representation of this Application.

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 pContext)
                 throws CMException

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:

pContext - current context in which application is executing

Returns:

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

Throws:

CMException