| com.ivata.groupware.container.persistence.AuthorTimestampNamedDO
 com.ivata.groupware.admin.setting.SettingDO
| SettingDO | | public class SettingDO extends AuthorTimestampNamedDO (Code) | | This class represents a single setting within the system. Each setting can
either be global, or overridden for a single user. You can have integer,
string or boolean settings. These are identified by the type constants
defined in
SettingConstants SettingConstants .
since:
2001-04-20
author:
Colin MacLeod
author:
colin.macleod@ivata.com
version:
$Revision: 1.2 $ |
| getName | | final public String getName()(Code) | | Get the name of this setting. This is a clear text identifier which
should be unique within the system. Use alphanumeric characters with no
spaces.
the name of the setting, a clear text identifier. |
| getType | | final public int getType()(Code) | | Get the type of the settting. This can be any of the 'TYPE_...'
constants defined in
SettingConstant SettingConstant .
the type of the settting, one of the 'TYPE_...' constants definedin SettingConstant SettingConstant. |
| getUser | | public UserDO getUser()(Code) | | Get the user this setting applies to, or null if it is
the default setting.
the user this setting applies to, or null if it isthe default setting. |
| getValue | | final public String getValue()(Code) | | Get the value of the setting. Whilst all settings are stored as
strings, the content should represent the type of the setting so that
integer types will only contain numeric strings, and boolean types will
only contain 'true' or 'false'.
the value of the setting. |
| isEnabled | | public boolean isEnabled()(Code) | | Get whether or not this setting is currently enabled.
true if the setting may be used currently, otherwisefalse. |
| setEnabled | | final public void setEnabled(boolean enabled)(Code) | | Set this setting to be currently enabled.
Parameters:
enable - true if the setting may be used currently,otherwise false. |
| setName | | final public void setName(String name)(Code) | | Set the name of this setting. This is a clear text identifier which
should be unique within the system. Use alphanumeric characters with no
spaces.
Parameters:
name - the name of the setting, a clear text identifier. |
| setType | | final public void setType(int type)(Code) | | Set the type of the setting. This can be any of the 'TYPE_...'
constants defined in
SettingConstant SettingConstant .
Parameters:
type - the type of the settting, one of the 'TYPE_...' constantsdefined in SettingConstant SettingConstant. |
| setUser | | final public void setUser(UserDO user)(Code) | | Set the user this setting applies to, or null if it is
the default setting.
Parameters:
user - the user this setting applies to, or null if itis the default setting. |
| setValue | | final public void setValue(String value)(Code) | | Set the value of the setting. Whilst all settings are stored as
strings, the content should represent the type of the setting so that
integer types will only contain numeric strings, and boolean types will
only contain 'true' or 'false'.
Parameters:
value - the value of the setting. |
|
|