|
|
|||||
| 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)
Initializes a new instance with a given environment. |
| Method Summary |
| public boolean | delete(String iRepo, String iName)
Removes an attribute from the repository given the attribute name. |
| public boolean | getBoolean(String iRepo, String iName, boolean iDefault)
Returns the attribute value of type boolean given a repository and a parameter name. |
| public double | getDouble(String iRepo, String iName, double iDefault)
Returns the attribute value of type double given a repository and a parameter name. |
| public int | getInt(String iRepo, String iName, int iDefault)
Returns the attribute value of type int given a repository and a parameter name. |
| public long | getLong(String iRepo, String iName, long iDefault)
Returns the attribute value of type long given a repository and a parameter name. |
| public String | getString(String iRepo, String iName, String iDefault)
Returns the attribute value of type String given a repository and a parameter name. |
| public void | saveRepo(String iRepo)
Validates attributes modifications and stores them in the database persistency. |
| public void | setBoolean(String iRepo, String iName, boolean iValue)
Sets an attribute value of type boolean given a repository and a parameter name. |
| public void | setDouble(String iRepo, String iName, double iValue)
Sets an attribute value of type double given a repository and a parameter name. |
| public void | setInt(String iRepo, String iName, int iValue)
Sets an attribute value of type int given a repository and a parameter name. |
| public void | setLong(String iRepo, String iName, long iValue)
Sets an attribute value of type long given a repository and a parameter name. |
| public void | setString(String iRepo, String iName, String iValue)
Sets an attribute value of type String given a repository and a parameter name. |
| 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.
iEnviAdministrator| Method Detail |
public boolean delete(String iRepo, String iName)
Removes an attribute from the repository given the attribute name.
iRepoiName
public boolean getBoolean(String iRepo, String iName, boolean iDefault)
Returns the attribute value of type boolean given a repository and a
parameter name.
iRepoiNameiDefault
public double getDouble(String iRepo, String iName, double iDefault)
Returns the attribute value of type double given a repository and a
parameter name.
iRepoiNameiDefault
public int getInt(String iRepo, String iName, int iDefault)
Returns the attribute value of type int given a repository and a
parameter name.
iRepoiNameiDefault
public long getLong(String iRepo, String iName, long iDefault)
Returns the attribute value of type long given a repository and a
parameter name.
iRepoiNameiDefault
public String getString(String iRepo, String iName, String iDefault)
Returns the attribute value of type String given a repository and a
parameter name.
iRepoiNameiDefault
public void saveRepo(String iRepo)
Validates attributes modifications and stores them in the database
persistency.
iRepo
public void setBoolean(String iRepo, String iName, boolean iValue)
Sets an attribute value of type boolean given a repository and a
parameter name.
iRepoiNameiValue
public void setDouble(String iRepo, String iName, double iValue)
Sets an attribute value of type double given a repository and a
parameter name.
iRepoiNameiValue
public void setInt(String iRepo, String iName, int iValue)
Sets an attribute value of type int given a repository and a
parameter name.
iRepoiNameiValue
public void setLong(String iRepo, String iName, long iValue)
Sets an attribute value of type long given a repository and a
parameter name.
iRepoiNameiValue
public void setString(String iRepo, String iName, String iValue)
Sets an attribute value of type String given a repository and a
parameter name.
iRepoiNameiValue