| 
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
  |
  +--planetj.database.Row
        |
        +--planetj.dataengine.PropertyRow
              |
              +--planetj.dataengine.application.Application
Contains information describing a DataEngine application Creation date: (3/21/2002 1:11:21 PM)
| Nested Class Summary | 
| Nested classes inherited from class planetj.database.Row | 
Row.SpacingRow | 
| Field Summary | 
| Fields inherited from class planetj.dataengine.PropertyRow | 
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.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.  | 
 SQLOperation | 
createSQLOperation(Map pValues)
Creates a SQLOperation using the given values and adds it to this Application.  | 
 Class | 
getApplicationClass()
Gets the Java class for this Application.  | 
 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.  | 
 String | 
getCompanyName()
Gets the company name associated with this secured object  | 
 String | 
getConnectionAlias()
Gets the connection alias for this application  | 
 ConnectionRow | 
getConnectionRow()
Gets the ConnectionRow assoicated with this Application  | 
 String | 
getDeleteConfirmationMessage()
Get the message used when deleting an application.  | 
 String | 
getDescription()
Gets the description for this application  | 
 String | 
getErrorJsp()
Gets the name of the JSP used for displaying errors.  | 
 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  | 
 Integer | 
getIdAsInteger()
Gets the ID of this application  | 
 Operation | 
getInitialOperation()
Gets this application's initial operation (may be null)  | 
 String | 
getJspFile()
Gets this application's JSP file  | 
 LayoutDisplayPropertyGroup | 
getLayoutProperties()
Gets this application's layout properties  | 
 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 | 
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  | 
 Integer | 
getOwnerIdAsInteger()
Gets the ID of this application's owner  | 
 Field | 
getOwnerIdField()
Returns the Owner Id Field  | 
 String | 
getPassword()
Gets the password for this application  | 
 String | 
getProperties()
Gets the property string associated with this SQLOperation  | 
 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  | 
 Class | 
getSignOnClass()
Gets the sign on class for this Application.  | 
 String | 
getSignOnClassName()
Gets the sign on class for this Application.  | 
 int | 
getSignOnOperationId()
Gets the sign on operation for this Application.  | 
 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.  | 
 Integer | 
getThemeIdAsInteger()
Gets the ID of this application's theme.  | 
 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.  | 
 String | 
getUserId()
Gets the userid for this application  | 
 String | 
getUserMessageForOperation(int pMode)
Returns a message for the user based on the Mode of the Row  | 
 boolean | 
hasDisplayableOperation(ExecutingContext executingContext)
Test if this Application contains a SQLOperation that is displayable  | 
 int | 
insert(SQLContext context)
Inserts this Row into the specified database.  | 
 boolean | 
isContainSQLOperation()
Deprecated.  | 
 boolean | 
isEnabled(AutoRunOperation op)
Tests if the auto-run operation's type is enabled for this application  | 
 boolean | 
isSignOnOptional()
Tests if the sign-on for this application is optional  | 
 void | 
setApplicationClass(Class newAppClass)
Sets the Java class for this Application.  | 
 void | 
setApplicationClassName(String applicationClass)
Sets the Java class for this Application.  | 
 void | 
setCompanyName(String name)
Sets the name of this application  | 
 void | 
setConnectionAlias(String newConnectionAlias)
Sets the connection alias for this application  | 
 void | 
setDescription(String value)
Sets the description for this application  | 
 void | 
setErrorJspFile(String newJspFile)
Sets this application's error JSP file  | 
 void | 
setId(int value)
Sets the ID of this application  | 
 void | 
setId(Integer value)
Sets the ID of this application  | 
 void | 
setInitialOperation(Operation operation)
Sets this Application's initial Operation  | 
 void | 
setInitialView(View pInitialView)
Sets this application's initial view  | 
 void | 
setJspFile(String newJspFile)
Sets this application's JSP file  | 
 void | 
setName(String name)
Sets the name of this application  | 
 void | 
setOwnerId(int value)
Sets the ID of this application's owner  | 
 void | 
setOwnerId(Integer value)
Sets the ID of this application's owner  | 
 void | 
setPassword(String value)
Sets the password for this application  | 
 void | 
setSignOnClass(Class newSignOnClass)
Sets the sign on class for this Application.  | 
 void | 
setSignOnClassName(String name)
Sets the sign on class for this Application.  | 
 void | 
setSignOnOperationId(int id)
Sets the sign on operation for this Application.  | 
 void | 
setSignOnURI(String value)
Sets the URI for signing onto this application  | 
 void | 
setThemeId(int value)
Sets the ID of this application's theme.  | 
 void | 
setThemeId(Integer value)
Sets the ID of this application's theme.  | 
 void | 
setUserId(String value)
Sets the userid for this application  | 
 void | 
startConnections()
Ensures that all of the connection that this application may use have been started  | 
 String | 
toString()
Returns a String representation of this Application.  | 
 int | 
update(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, transferDataTo | 
| Methods inherited from class java.lang.Object | 
getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Methods inherited from interface planetj.dataengine.security.http.ISecured | 
getSystemAlias | 
| Constructor Detail | 
public Application()
| Method Detail | 
public String getHeaderText(ExecutingContext ec)
Row
getHeaderText in class Rowpublic String getDeleteConfirmationMessage()
getDeleteConfirmationMessage in class Row
public Row createRow(Row pDefaultRow)
              throws CMException
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.
createRow in interface IRowCreatorcreateRow in class PropertyRowpDefaultRow - A Row containing data read from the database (it will always be equal to this)
CMException
public SQLOperation createSQLOperation(Map pValues)
                                throws CMException
pValues - Map of values for the newly created SQLOperation
CMExceptionpublic Class getApplicationClass()
public String getApplicationClassName()
public static Operation getApplicationOperationByUsageId(int usageId,
                                                         ExecutingContext ec)
                                                  throws CMException
usageId - usage id of the Operation to getec - 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.
CMExceptionpublic SQLOperation getAuthenticationOperation()
public int getAutoRunStatus()
public String getCompanyName()
ISecured
getCompanyName in interface ISecuredpublic String getConnectionAlias()
public ConnectionRow getConnectionRow()
                               throws CMException
CMExceptionpublic String getDescription()
public String getErrorJsp()
public int getId()
getId in interface ISecuredpublic Integer getIdAsInteger()
public Operation getInitialOperation()
                              throws CMException
CMExceptionpublic String getJspFile()
public LayoutDisplayPropertyGroup getLayoutProperties()
getLayoutProperties in interface ISecuredpublic String getName()
getName in interface ISecured
public Operation getOperationById(int opId)
                           throws CMException
CMException
public Operation getOperationByUsageId(int usageId,
                                       ExecutingContext executingContext)
                                throws CMException
CMException
public RowCollection getOperations()
                            throws CMException
CMException
public RowCollection getOperations(ExecutingContext executingContext)
                            throws CMException
CMException
public RowCollection getOperationsByUsageId(int usageId,
                                            ExecutingContext executingContext)
                                     throws CMException
CMExceptionpublic int getOwnerId()
getOwnerId in interface ISecuredpublic Integer getOwnerIdAsInteger()
public Field getOwnerIdField()
getOwnerIdField in interface IOwnerIOwnerpublic String getPassword()
public String getProperties()
getProperties in class PropertyRowpublic String getPropertyFieldName()
getPropertyFieldName in class PropertyRowpublic RefererAuthorizationOperation getRefererAuthorizationOperation()
public Class getSignOnClass()
getSignOnClass in interface ISecuredpublic String getSignOnClassName()
public int getSignOnOperationId()
public String getSignOnURI()
getSignOnURI in interface ISecured
public RowCollection getSQLOperations()
                               throws CMException
CMException
public RowCollection getSQLOperations(ExecutingContext executingContext)
                               throws CMException
CMException
public Theme getTheme()
               throws CMException
CMExceptionpublic int getThemeId()
public Integer getThemeIdAsInteger()
public String getTranslatedName(UserProperties up)
public UserAuthenticationListOperation getUserAuthenticationListOperation()
public String getUserId()
public String getUserMessageForOperation(int pMode)
getUserMessageForOperation in class Row(see Row constants to find the modes.
public boolean hasDisplayableOperation(ExecutingContext executingContext)
                                throws CMException
CMException
public int insert(SQLContext context)
           throws CMException
insert in class PropertyRowCMException
public boolean isContainSQLOperation()
                              throws CMException
CMExceptionpublic boolean isEnabled(AutoRunOperation op)
public boolean isSignOnOptional()
public void setApplicationClass(Class newAppClass)
                         throws CMException
CMException
public void setApplicationClassName(String applicationClass)
                             throws CMException
CMException
public void setCompanyName(String name)
                    throws CMException
CMException
public void setConnectionAlias(String newConnectionAlias)
                        throws CMException
CMException
public void setDescription(String value)
                    throws CMException
CMException
public void setErrorJspFile(String newJspFile)
                     throws CMException
CMException
public void setId(int value)
           throws CMException
CMException
public void setId(Integer value)
           throws CMException
CMException
public void setInitialOperation(Operation operation)
                         throws CMException
CMException
public void setInitialView(View pInitialView)
                    throws CMException
CMException
public void setJspFile(String newJspFile)
                throws CMException
CMException
public void setName(String name)
             throws CMException
CMException
public void setOwnerId(int value)
                throws CMException
CMException
public void setOwnerId(Integer value)
                throws CMException
CMException
public void setPassword(String value)
                 throws CMException
CMException
public void setSignOnClass(Class newSignOnClass)
                    throws CMException
CMException
public void setSignOnClassName(String name)
                        throws CMException
CMException
public void setSignOnOperationId(int id)
                          throws CMException
CMException
public void setSignOnURI(String value)
                  throws CMException
CMException
public void setThemeId(int value)
                throws CMException
CMException
public void setThemeId(Integer value)
                throws CMException
CMException
public void setUserId(String value)
               throws CMException
CMException
public void startConnections()
                      throws CMException
CMExceptionpublic String toString()
toString in class Object
public int update(Connection conn,
                  ExecutingContext ec)
           throws CMException
update in class PropertyRowconn - The connection to use for the update
CMException
public boolean validate(ExecutingContext pContext)
                 throws CMException
validate in class RowCMException
  | 
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||