|
|
Package com.dassault_systemes.catjsystem |
Class CATSetting
|
Class Hierarchy |
java.lang.Object | +-com.dassault_systemes.catjsystem.CATSetting
Class Location |
Class Description |
public class CATSetting
An object that enables the storage of settings for the application in the database persistency.
A CATSetting
instance can be used to several attribute
values and store them into a repository identified by a name.
Field Summary |
Constructor Summary |
CATSetting(CATEnvironment iEnv, boolean iAdministrator) |
Method Summary |
String | getString(String iRepo, String iName, String iDefault) |
int | getInt(String iRepo, String iName, int iDefault) |
boolean | getBoolean(String iRepo, String iName, boolean iDefault) |
double | getDouble(String iRepo, String iName, double iDefault) |
long | getLong(String iRepo, String iName, long iDefault) |
void | setString(String iRepo, String iName, String iValue) |
void | setLong(String iRepo, String iName, long iValue) |
void | setDouble(String iRepo, String iName, double iValue) |
void | setBoolean(String iRepo, String iName, boolean iValue) |
void | setInt(String iRepo, String iName, int iValue) |
void | saveRepo(String iRepo) |
boolean | delete(String iRepo, String iName) |
Field Detail |
Constructor Detail |
CATSetting(CATEnvironment iEnv, boolean iAdministrator)Initializes a new instance with a given environment.
The environment required can be retrieved through a
CATSession
instance using the following method:
CATSession.getEnv().
A CATSetting instance can be used to manipulate the setting content.
iEnv
iAdministrator
Method Detail |
String getString(String iRepo, String iName, String iDefault)Returns the attribute value of type String given a repository and a parameter name.
iRepo
iName
iDefault
int getInt(String iRepo, String iName, int iDefault)Returns the attribute value of type int given a repository and a parameter name.
iRepo
iName
iDefault
boolean getBoolean(String iRepo, String iName, boolean iDefault)Returns the attribute value of type boolean given a repository and a parameter name.
iRepo
iName
iDefault
double getDouble(String iRepo, String iName, double iDefault)Returns the attribute value of type double given a repository and a parameter name.
iRepo
iName
iDefault
long getLong(String iRepo, String iName, long iDefault)Returns the attribute value of type long given a repository and a parameter name.
iRepo
iName
iDefault
void setString(String iRepo, String iName, String iValue)Sets an attribute value of type String given a repository and a parameter name.
iRepo
iName
iValue
void setLong(String iRepo, String iName, long iValue)Sets an attribute value of type long given a repository and a parameter name.
iRepo
iName
iValue
void setDouble(String iRepo, String iName, double iValue)Sets an attribute value of type double given a repository and a parameter name.
iRepo
iName
iValue
void setBoolean(String iRepo, String iName, boolean iValue)Sets an attribute value of type boolean given a repository and a parameter name.
iRepo
iName
iValue
void setInt(String iRepo, String iName, int iValue)Sets an attribute value of type int given a repository and a parameter name.
iRepo
iName
iValue
void saveRepo(String iRepo)Validates attributes modifications and stores them in the database persistency.
iRepo
boolean delete(String iRepo, String iName)Removes an attribute from the repository given the attribute name.
iRepo
iName