| com.jcorporate.expresso.core.dbobj.SecuredDBObject
 com.jcorporate.expresso.services.dbobj.Setup
| Setup | | public class Setup extends SecuredDBObject (Code) | | Copyright 1999, 2000, 2001 Jcorporate Ltd.
Setup is a generic configuration/setup value table. Each schema can
define a number of default setup values that are created when the
schema is initialized. The user can then customize these values.
author:
Michael Nash |
| CACHE_NAME | | final public static String CACHE_NAME(Code) | | Name of the setup cache file.
|
| Setup | | public Setup(int uid) throws DBException(Code) | | Initializes Setup with proper user context
Parameters:
uid - the Owning user's uid
throws:
DBException - upon error |
| Setup | | public Setup(ControllerRequest request) throws DBException(Code) | | For using DBObjects within Controllers. Initializes based upon the
current user and the requested db. [Of course this can be modified later]
Parameters:
request - - The controller request handed to you by the framework.
throws:
DBException - upon error |
| getValue | | public static String getValue(String dbName, String setupCode) throws DBException(Code) | | Get a config value for the default schema
Config values are like INI file variables or registry entries - except
stored in a database. There is one database connection held open for
accessing these values from the connection pool. This function simply
references the Expresso Schema's setup values. For your own application
you will want to call the getValue that names your Schema
Parameters:
dbName - The data context to get the value for
Parameters:
setupCode - The code string of the setup code required String value stored in the given config value
throws:
DBException - If the value cannot be retrieved |
| getValue | | public static String getValue(String dbName, String schemaName, String setupCode) throws DBException(Code) | | Get a config value for the default schema
Config values are like INI file variables or registry entries - except
stored in a database. There is one database connection held open for
accessing these values from the connection pool
Parameters:
dbName - The data context name
Parameters:
schemaName - The name of the schema
Parameters:
setupCode - The code string of the setup code required String value stored in the given config value
throws:
DBException - If the value cannot be retrieved |
| getValueRequired | | public static String getValueRequired(String dbName, String setupCode) throws DBException(Code) | | Get a value from the configuration values. The value must be
valid (not null) or the method throws an exception
Parameters:
dbName - The datacontext name
Parameters:
setupCode - Code of the required setup value java.lang.String
throws:
DBException - if the value does not exist or is null |
| getValueRequired | | public static String getValueRequired(String dbName, String schema, String setupCode) throws DBException(Code) | | Get a value from the configuration values. The value must be
valid or the method throws an exception
Parameters:
dbName - The data context for the value
Parameters:
schema - The schema class for this setup code
Parameters:
setupCode - Code of the required setup value String
throws:
DBException - if the value does not exist or is null |
| getValueUnrequired | | public static String getValueUnrequired(String dbName, String setupCode)(Code) | | Get a value from the configuration values. Return null (no exception) if value doesn't exist
Parameters:
dbName - The datacontext name
Parameters:
setupCode - Code of the required setup value java.lang.String of value, or null if not found |
| getValueUnrequired | | public static String getValueUnrequired(String dbName, String schema, String setupCode)(Code) | | Get a value from the configuration values. Return null (no exception) if value doesn't exist
Parameters:
dbName - The datacontext name
Parameters:
setupCode - Code of the required setup value
Parameters:
schema - name of schema java.lang.String of value, or null if not found |
| readSetups | | public static synchronized void readSetups(boolean forceRead) throws DBException(Code) | |
Parameters:
forceRead - - Tries to reread the setup values even if the db tablesdon't exist yet.
throws:
DBException - if there's an error reading the setups |
| readSetups | | public static synchronized void readSetups() throws DBException(Code) | | Read the setup/config values into a hashtable for cached access
throws:
DBException - upon error |
| retrieve | | public synchronized void retrieve() throws DBException(Code) | | Extend retrieve to supply a defeult for the schemaclass field
throws:
DBException - If the retrieve fails |
| setCode | | public void setCode(String code) throws DBException(Code) | | convenience setter for code
Parameters:
code - new code to set |
| setDescrip | | public void setDescrip(String descrip) throws DBException(Code) | | convenience setter for description of Setup item
Parameters:
descrip - new description to set |
| setSchemaClass | | public void setSchemaClass(String schemaclassname) throws DBException(Code) | | convenience setter for schema class; schema is optional; if not provided, find() will default to Expresso
Parameters:
schemaclassname - new name to set |
| setTableExists | | public static synchronized void setTableExists(String dbName)(Code) | | DB Tool calls this when the Expresso Setup Values are finally able to be
read
Parameters:
dbName - the data context that setup tables now exist for |
| setValue | | public void setValue(String value) throws DBException(Code) | | convenience setter for value
Parameters:
value - new value to set |
| update | | public synchronized void update() throws DBException(Code) | | Extend update to validate some setup values
throws:
DBException - upon error |
| Methods inherited from com.jcorporate.expresso.core.dbobj.SecuredDBObject | public void add() throws DBException(Code)(Java Doc)
public boolean canRequesterAdd() throws DBException(Code)(Java Doc)
public boolean canRequesterDelete() throws DBException(Code)(Java Doc)
public boolean canRequesterRead() throws DBException(Code)(Java Doc)
public boolean canRequesterUpdate() throws DBException(Code)(Java Doc)
public boolean checkAllowed(String requestedFunction) throws DBException(Code)(Java Doc)
public void copyAttributes(DBObject returnObj) throws DBException(Code)(Java Doc)
public synchronized int count() throws com.jcorporate.expresso.core.db.DBException(Code)(Java Doc)
protected synchronized void createSecurityCache() throws CacheException(Code)(Java Doc)
public void delete() throws DBException(Code)(Java Doc)
public synchronized void deleteAll() throws com.jcorporate.expresso.core.db.DBException(Code)(Java Doc)
public boolean find() throws DBException(Code)(Java Doc)
public int getRequestingUid()(Code)(Java Doc)
protected String getString(String stringCode, Object[] args) throws DBException(Code)(Java Doc)
protected String getString(String stringCode) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1, String arg2) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1, String arg2, String arg3) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1, String arg2, String arg3, String arg4) throws DBException(Code)(Java Doc)
public int getSystemUid()(Code)(Java Doc)
public static SecuredDBObject instantiate(String className) throws DBException(Code)(Java Doc)
public void isAllowed(String requestedFunction) throws SecurityException, DBException(Code)(Java Doc)
public void retrieve() throws DBException(Code)(Java Doc)
public synchronized void search() throws DBException(Code)(Java Doc)
public synchronized ArrayList searchAndRetrieveList() throws DBException(Code)(Java Doc)
public synchronized ArrayList searchAndRetrieveList(String sortKeys) throws DBException(Code)(Java Doc)
public void setRequestingUid(int newUid)(Code)(Java Doc)
public void update() throws DBException(Code)(Java Doc)
|
|
|