| java.lang.Object
 com.ivata.groupware.business.BusinessLogic
com.ivata.groupware.admin.setting.SettingsImpl
| Constructor Summary | |
| public | SettingsImpl(QueryPersistenceManager persistenceManagerParam)
Construct a new settings object. |
| Method Summary | |
| public void | amendSetting(SecuritySession securitySession, String name, Object value, UserDO user)
Change the value of an existing setting. | | final public Boolean | getBooleanSetting(SecuritySession securitySession, String name, UserDO user)
Get a setting of class Boolean.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - the name of the setting to return the value for
Parameters:
user - The user to search for. | | final public Integer | getIntegerSetting(SecuritySession securitySession, String name, UserDO user)
Get a setting of class Integer.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - the name of the setting to return the value for.
Parameters:
user - The user to search for. | | final public Object | getSetting(SecuritySession securitySession, String name, UserDO userDO)
Get a setting for a given user. | | final public int | getSettingType(SecuritySession securitySession, String name)
Get the type of a setting. | | final public String | getStringSetting(SecuritySession securitySession, String name, UserDO user)
Get a setting of class String.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - The name of the setting to return the value for
Parameters:
user - The user to search for. | | public boolean | isSettingEnabled(SecuritySession securitySession, String name)
Find out whether or not a setting is enabled.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - Name of the setting to check. | | public void | revertSetting(SecuritySession securitySession, String name, UserDO user)
Revert a user setting back to the general value. | | public ValidationErrors | validate(SecuritySession securitySession, Map settings, Locale locale, int settingType)
|
| SettingsImpl | | public SettingsImpl(QueryPersistenceManager persistenceManagerParam)(Code) | | Construct a new settings object.
Parameters:
persistenceManagerParam - used to store objects in db. |
| amendSetting | | public void amendSetting(SecuritySession securitySession, String name, Object value, UserDO user) throws SystemException(Code) | |
Change the value of an existing setting.
Parameters:
name - The name of the setting to set.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
value - The new value to be set.
Parameters:
user - if not null, then the setting for this useris set, otherwise the general setting is changed.
throws:
SystemException - If there is a technical problem retrieving thesetting. |
| getBooleanSetting | | final public Boolean getBooleanSetting(SecuritySession securitySession, String name, UserDO user) throws SystemException(Code) | | Get a setting of class Boolean.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - the name of the setting to return the value for
Parameters:
user - The user to search for. If null is specified, thedefault setting is searched for and returned if found. A setting of class Boolean for the settingname provided.
See Also: SettingsImpl.getSetting
See Also: SettingsImpl.getIntegerSetting
See Also: SettingsImpl.getStringSetting
throws:
SystemException - If this setting does not exist or there is atechnical problem. Throws SettingsDataTypeExceptionif the setting has any class other than Boolean. |
| getIntegerSetting | | final public Integer getIntegerSetting(SecuritySession securitySession, String name, UserDO user) throws SystemException(Code) | | Get a setting of class Integer.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - the name of the setting to return the value for.
Parameters:
user - The user to search for. If null is specified, thedefault setting is searched for and returned if found. A setting of class Integer for the settingname provided.
See Also: SettingsImpl.getSetting
See Also: SettingsImpl.getStringSetting
See Also: SettingsImpl.getBooleanSetting
throws:
SystemException - If this setting does not exist or there is atechnical problem. Throws SettingsDataTypeExceptionif the setting has any class other than Integer. |
| getSetting | | final public Object getSetting(SecuritySession securitySession, String name, UserDO userDO) throws SystemException(Code) | | Get a setting for a given user. The class of the returned object will
depend on the type field of the EJB with this name and can
be one of:
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - The name of the setting to return the value for
Parameters:
userDO - The user to search for. If null is specified, thedefault setting is searched for and returned if found. A setting with the setting name provided. The type of thereturned object depends on the type field of thesetting.
See Also: SettingsImpl.getIntegerSetting
See Also: SettingsImpl.getStringSetting
See Also: SettingsImpl.getBooleanSetting
throws:
SystemException - If this setting does not exist, or there is atechnical problem retrieving it. |
| getSettingType | | final public int getSettingType(SecuritySession securitySession, String name) throws SystemException(Code) | |
Get the type of a setting.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - the name of the setting one of the static fields of SettingConstants
throws:
SystemException - if this setting does not exist. |
| getStringSetting | | final public String getStringSetting(SecuritySession securitySession, String name, UserDO user) throws SystemException(Code) | | Get a setting of class String.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - The name of the setting to return the value for
Parameters:
user - The user to search for. If null is specified, thedefault setting is searched for and returned if found. A setting of class String for the settingname provided.
See Also: SettingsImpl.getSetting
See Also: SettingsImpl.getIntegerSetting
See Also: SettingsImpl.getBooleanSetting
throws:
SystemException - If this setting does not exist or there is atechnical problem. Throws SettingsDataTypeExceptionif the setting has any class other than String. |
| isSettingEnabled | | public boolean isSettingEnabled(SecuritySession securitySession, String name) throws SystemException(Code) | |
Find out whether or not a setting is enabled.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - Name of the setting to check. true if the setting exists and is enabled.
throws:
SystemException - If there is a technical problem checking thesetting. |
| revertSetting | | public void revertSetting(SecuritySession securitySession, String name, UserDO user) throws SystemException(Code) | |
Revert a user setting back to the general value.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
name - The name of the setting to revert.
Parameters:
user - The name of the user to revert the setting for.
throws:
SystemException - If there is a technical problem reverting thesetting. |
| validate | | public ValidationErrors validate(SecuritySession securitySession, Map settings, Locale locale, int settingType) throws SystemException(Code) | | Confirm all of the settings passed are correct.
Parameters:
securitySession - Used to authenticate the user.
Parameters:
settings - A Map with setting names as keys and settingvalues as values
Parameters:
locale - The Locale to get localised error messages
Parameters:
settingType - One of the constants in SettingConstants:SETTING_USER or SETTING_SYSTEM A collection of validation errors if any of the settingscontains invalid value.
throws:
SystemException - If there is a technical problem. |
|
|