Skip navigation links

ilog.rules.teamserver.model
Class IlrSettings

java.lang.Object
  ilog.rules.teamserver.model.IlrSettings

public class IlrSettings
extends Object

Provides a set of methods to save and retrieve Decision Center settings.

A setting is a (user,key,value) triplet that can be used to store data for a specific user. There are a set of predefined settings that can be set (see the constants of this class) but you can save your own custom setting.
You can also save and retrieve global settings, which are settings that apply to all the users.

NOTE: Settings can be set via API or through the setConfigParam ant tasks that comes with Decision Center.

Field Summary

static String	ACCESSIBILITY
static String	AUTOFOLLOW_ACTIVITIES_USER_PARTICIPATES_IN
static String	AUTOFOLLOW_ENABLED
static String	AUTOFOLLOW_NEW_BRANCHES_USER_CAN_SEE
static String	AUTOFOLLOW_NEW_PROJECTS_USER_CAN_SEE
static String	AUTOFOLLOW_NEW_RULES_USER_CAN_EDIT
static String	AUTOFOLLOW_RULES_USER_CREATES
static String	AUTOFOLLOW_RULES_USER_EDITS
static String	AUTOFOLLOW_THINGS_USER_APPROVES
static String	AUTOFOLLOW_THINGS_USER_CREATES
static String	AUTOFOLLOW_THINGS_USER_OWNS
static String	BUDDHIST_CALENDAR
static String	BUILD_ARCHIVE_STORAGE
static String	BUILD_ARCHIVE_STORAGE_FILE
static String	BUILD_ARCHIVE_STORAGE_MEMORY
static String	BUILD_ELEMENT_ON_COMMIT
static String	BUILD_PATH
static String	BUILD_SEVERITY_ERROR
static String	BUILD_SEVERITY_INFO
static String	BUILD_SEVERITY_LEVEL
static String	BUILD_SEVERITY_NEVER
static String	BUILD_SEVERITY_SEMANTIC
static String	BUILD_SEVERITY_WARNING
static String	CHECK_RULESET_ARCHIVE
static String	CONTROLLER_CLASS
static String	DC_GOVERNANCE_MODE
static String	DC_MODE
static String	DC_RULEPROJECT_MODE
static String	DC_USER_DEFAULT_GOVERNANCE_MODE
static String	DC_USER_MODE
static String	DCBC_VIEWBYNAME_ENABLED
static String	DIRECTORYEXTENSION_CLASS
static String	DISPLAYED_PROPERTIES
static String	ENABLE_OLDSTYLEBASELINE_PATCH
static String	GREGORIAN_CALENDAR
static String	GUIDED_EDITOR
static String	HEBREW_CALENDAR
static String	HISTORY_DELAY_DAYMODE
static String	HISTORY_TEST_DELAY_USAGE
static String	INPUT_ORIENTATION
static String	INPUT_ORIENTATION_CONTEXTUAL
static String	INPUT_ORIENTATION_LTR
static String	INPUT_ORIENTATION_RTL
static String	INPUT_ORIENTATION_UIBASED
static String	INTELLIRULE_EDITOR
static String	INTELLIRULE_EDITOR_EVENTS_COMPLETION_OPTIONS
static String	INTELLIRULE_EDITOR_QUERIES_COMPLETION_OPTIONS
static String	INTELLIRULE_EDITOR_RULES_COMPLETION_OPTIONS
static String	ISLAMIC_CALENDAR
static String	LAST_AUTOFOLLOW_CHECK
static String	LAST_BASELINE
static String	LAST_CHANGEACTIVITY
static String	LAST_DECISIONSERVICE
static String	LAST_PROJECT
static String	LAST_RELEASE
static String	LAST_WHATS_NEW_ACTIVITY_TIME
static String	LAST_WHATS_NEW_CREATE_RULE_TIME
static String	LAST_WHATS_NEW_TIME_FORMAT
static String	LAST_WHATS_NEW_UPDATE_RULE_TIME
static String	LAYOUT_ORIENTATION
static String	MANAGED_MODE
static String	PERFORM_DT_CHECKS
static String	PROJECT_EDITOR
static String	PROJECT_LEVEL_EDITOR
static String	PROJECT_LEVEL_QUERY_EDITOR
static String	PROJECT_QUERY_EDITOR
static String	PROPERTYEXTENSION_CLASS
static String	QUERY_BQL_EDITOR
static String	QUERY_FORM_EDITOR
static String	REFERENCE_LOCALE
static String	REFRESH_CHILDREN_ON_EXPAND_IN_RULE_EXPLORER
static String	ROWS_PER_PAGE
static String	RULE_ANALYSIS_CHECK_CODES
static String	RULE_ANALYSIS_CHECK_ENABLED
static String	RULE_ANALYSIS_COMPLETENESS_GAP_LIMIT
static String	RULE_ANALYSIS_INCLUDE_DECISION_TABLES_OR_TREES
static String	RULESETGENERATION_ABORT_LEVEL
static String	SERVER_CONTEXT_PATH
static String	SERVER_HOSTNAME
static String	SERVER_IS_SECURE
static String	SERVER_PORT
static String	SERVER_UUID
static String	SHOW_ARTIFACT_NUMBER_IN_RULE_EXPLORER
static String	SHOW_ARTIFACTS_IN_RULE_EXPLORER
static String	SHOW_EXCEPTION_STACK
static String	SHOW_WARNING_SMARTVIEWS
static String	TABLE_SIZE
static String	TRUNCATE_TEXT_LENGTH
static String	USE_COMPRESSION
static String	USER_CALENDAR
static String	USER_EDITOR
static String	USER_LOCALE
static String	USER_QUERY_EDITOR
static String	USER_SKIN
static String	VIEWS_ORDER

Constructor Summary

IlrSettings()

Method Summary

static int	getBuildSeverityLevel(IlrSession session) One of <null>, info, warning, error, semantic, never.
static String	getGlobalSetting(IlrSession session, String key) Gets the value of a global setting.
static String	getSetting(IlrSession session, String userName, String key) Gets the value of a setting for the given user.
static boolean	removeGlobalSetting(IlrSession session, String key) Removes a global setting.
static boolean	removeSetting(IlrSession session, String userName, String key) Removes a setting for a given user.
static boolean	saveGlobalSetting(IlrSession session, String key, String value) Saves a global setting.
static boolean	saveSetting(IlrSession session, String userName, String key, String value) Saves a setting for the given user.
static List<IlrElementDetails>	searchSetting(IlrSession session, String key, String searchString)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RULESETGENERATION_ABORT_LEVEL

public static final String RULESETGENERATION_ABORT_LEVEL

See Also:

Constant Field Values

CHECK_RULESET_ARCHIVE

public static final String CHECK_RULESET_ARCHIVE

See Also:

Constant Field Values

BUILD_PATH

public static final String BUILD_PATH

See Also:

Constant Field Values

BUILD_ELEMENT_ON_COMMIT

public static final String BUILD_ELEMENT_ON_COMMIT

See Also:

Constant Field Values

RULE_ANALYSIS_CHECK_CODES

public static final String RULE_ANALYSIS_CHECK_CODES

See Also:

Constant Field Values

RULE_ANALYSIS_CHECK_ENABLED

public static final String RULE_ANALYSIS_CHECK_ENABLED

See Also:

Constant Field Values

RULE_ANALYSIS_INCLUDE_DECISION_TABLES_OR_TREES

public static final String RULE_ANALYSIS_INCLUDE_DECISION_TABLES_OR_TREES

See Also:

Constant Field Values

RULE_ANALYSIS_COMPLETENESS_GAP_LIMIT

public static final String RULE_ANALYSIS_COMPLETENESS_GAP_LIMIT

See Also:

Constant Field Values

REFERENCE_LOCALE

public static final String REFERENCE_LOCALE

See Also:

Constant Field Values

ENABLE_OLDSTYLEBASELINE_PATCH

public static final String ENABLE_OLDSTYLEBASELINE_PATCH

See Also:

Constant Field Values

CONTROLLER_CLASS

public static final String CONTROLLER_CLASS

See Also:

Constant Field Values

PROPERTYEXTENSION_CLASS

public static final String PROPERTYEXTENSION_CLASS

See Also:

Constant Field Values

DIRECTORYEXTENSION_CLASS

public static final String DIRECTORYEXTENSION_CLASS

See Also:

Constant Field Values

BUILD_SEVERITY_LEVEL

public static final String BUILD_SEVERITY_LEVEL

See Also:

Constant Field Values

BUILD_SEVERITY_INFO

public static final String BUILD_SEVERITY_INFO

See Also:

Constant Field Values

BUILD_SEVERITY_WARNING

public static final String BUILD_SEVERITY_WARNING

See Also:

Constant Field Values

BUILD_SEVERITY_ERROR

public static final String BUILD_SEVERITY_ERROR

See Also:

Constant Field Values

BUILD_SEVERITY_SEMANTIC

public static final String BUILD_SEVERITY_SEMANTIC

See Also:

Constant Field Values

BUILD_SEVERITY_NEVER

public static final String BUILD_SEVERITY_NEVER

See Also:

Constant Field Values

BUILD_ARCHIVE_STORAGE

public static final String BUILD_ARCHIVE_STORAGE

See Also:

Constant Field Values

BUILD_ARCHIVE_STORAGE_FILE

public static final String BUILD_ARCHIVE_STORAGE_FILE

See Also:

Constant Field Values

BUILD_ARCHIVE_STORAGE_MEMORY

public static final String BUILD_ARCHIVE_STORAGE_MEMORY

See Also:

Constant Field Values

SHOW_EXCEPTION_STACK

public static final String SHOW_EXCEPTION_STACK

See Also:

Constant Field Values

TABLE_SIZE

public static String TABLE_SIZE

DISPLAYED_PROPERTIES

public static String DISPLAYED_PROPERTIES

LAST_PROJECT

public static String LAST_PROJECT

LAST_BASELINE

public static String LAST_BASELINE

LAST_DECISIONSERVICE

public static String LAST_DECISIONSERVICE

LAST_RELEASE

public static String LAST_RELEASE

LAST_CHANGEACTIVITY

public static String LAST_CHANGEACTIVITY

MANAGED_MODE

public static String MANAGED_MODE

VIEWS_ORDER

public static String VIEWS_ORDER

USER_LOCALE

public static final String USER_LOCALE

See Also:

Constant Field Values

USER_CALENDAR

public static final String USER_CALENDAR

See Also:

Constant Field Values

USER_SKIN

public static final String USER_SKIN

See Also:

Constant Field Values

TRUNCATE_TEXT_LENGTH

public static final String TRUNCATE_TEXT_LENGTH

See Also:

Constant Field Values

ROWS_PER_PAGE

public static final String ROWS_PER_PAGE

See Also:

Constant Field Values

SHOW_ARTIFACT_NUMBER_IN_RULE_EXPLORER

public static final String SHOW_ARTIFACT_NUMBER_IN_RULE_EXPLORER

See Also:

Constant Field Values

SHOW_ARTIFACTS_IN_RULE_EXPLORER

public static final String SHOW_ARTIFACTS_IN_RULE_EXPLORER

See Also:

Constant Field Values

REFRESH_CHILDREN_ON_EXPAND_IN_RULE_EXPLORER

public static final String REFRESH_CHILDREN_ON_EXPAND_IN_RULE_EXPLORER

See Also:

Constant Field Values

GREGORIAN_CALENDAR

public static final String GREGORIAN_CALENDAR

See Also:

Constant Field Values

HEBREW_CALENDAR

public static final String HEBREW_CALENDAR

See Also:

Constant Field Values

ISLAMIC_CALENDAR

public static final String ISLAMIC_CALENDAR

See Also:

Constant Field Values

BUDDHIST_CALENDAR

public static final String BUDDHIST_CALENDAR

See Also:

Constant Field Values

USER_EDITOR

public static final String USER_EDITOR

See Also:

Constant Field Values

PROJECT_EDITOR

public static final String PROJECT_EDITOR

See Also:

Constant Field Values

PROJECT_LEVEL_EDITOR

public static final String PROJECT_LEVEL_EDITOR

See Also:

Constant Field Values

GUIDED_EDITOR

public static final String GUIDED_EDITOR

See Also:

Constant Field Values

INTELLIRULE_EDITOR

public static final String INTELLIRULE_EDITOR

See Also:

Constant Field Values

INTELLIRULE_EDITOR_RULES_COMPLETION_OPTIONS

public static final String INTELLIRULE_EDITOR_RULES_COMPLETION_OPTIONS

See Also:

Constant Field Values

INTELLIRULE_EDITOR_EVENTS_COMPLETION_OPTIONS

public static final String INTELLIRULE_EDITOR_EVENTS_COMPLETION_OPTIONS

See Also:

Constant Field Values

INTELLIRULE_EDITOR_QUERIES_COMPLETION_OPTIONS

public static final String INTELLIRULE_EDITOR_QUERIES_COMPLETION_OPTIONS

See Also:

Constant Field Values

USER_QUERY_EDITOR

public static final String USER_QUERY_EDITOR

See Also:

Constant Field Values

PROJECT_QUERY_EDITOR

public static final String PROJECT_QUERY_EDITOR

See Also:

Constant Field Values

PROJECT_LEVEL_QUERY_EDITOR

public static final String PROJECT_LEVEL_QUERY_EDITOR

See Also:

Constant Field Values

QUERY_FORM_EDITOR

public static final String QUERY_FORM_EDITOR

See Also:

Constant Field Values

QUERY_BQL_EDITOR

public static final String QUERY_BQL_EDITOR

See Also:

Constant Field Values

AUTOFOLLOW_ENABLED

public static final String AUTOFOLLOW_ENABLED

See Also:

Constant Field Values

AUTOFOLLOW_RULES_USER_CREATES

public static final String AUTOFOLLOW_RULES_USER_CREATES

See Also:

Constant Field Values

AUTOFOLLOW_RULES_USER_EDITS

public static final String AUTOFOLLOW_RULES_USER_EDITS

See Also:

Constant Field Values

AUTOFOLLOW_NEW_RULES_USER_CAN_EDIT

public static final String AUTOFOLLOW_NEW_RULES_USER_CAN_EDIT

See Also:

Constant Field Values

AUTOFOLLOW_NEW_PROJECTS_USER_CAN_SEE

public static final String AUTOFOLLOW_NEW_PROJECTS_USER_CAN_SEE

See Also:

Constant Field Values

AUTOFOLLOW_NEW_BRANCHES_USER_CAN_SEE

public static final String AUTOFOLLOW_NEW_BRANCHES_USER_CAN_SEE

See Also:

Constant Field Values

LAST_AUTOFOLLOW_CHECK

public static final String LAST_AUTOFOLLOW_CHECK

See Also:

Constant Field Values

AUTOFOLLOW_THINGS_USER_CREATES

public static final String AUTOFOLLOW_THINGS_USER_CREATES

See Also:

Constant Field Values

AUTOFOLLOW_THINGS_USER_APPROVES

public static final String AUTOFOLLOW_THINGS_USER_APPROVES

See Also:

Constant Field Values

AUTOFOLLOW_THINGS_USER_OWNS

public static final String AUTOFOLLOW_THINGS_USER_OWNS

See Also:

Constant Field Values

AUTOFOLLOW_ACTIVITIES_USER_PARTICIPATES_IN

public static final String AUTOFOLLOW_ACTIVITIES_USER_PARTICIPATES_IN

See Also:

Constant Field Values

SERVER_CONTEXT_PATH

public static final String SERVER_CONTEXT_PATH

See Also:

Constant Field Values

SERVER_HOSTNAME

public static final String SERVER_HOSTNAME

See Also:

Constant Field Values

SERVER_PORT

public static final String SERVER_PORT

See Also:

Constant Field Values

SERVER_IS_SECURE

public static final String SERVER_IS_SECURE

See Also:

Constant Field Values

SERVER_UUID

public static final String SERVER_UUID

See Also:

Constant Field Values

DCBC_VIEWBYNAME_ENABLED

public static final String DCBC_VIEWBYNAME_ENABLED

See Also:

Constant Field Values

DC_MODE

public static final String DC_MODE

See Also:

Constant Field Values

DC_USER_DEFAULT_GOVERNANCE_MODE

public static final String DC_USER_DEFAULT_GOVERNANCE_MODE

See Also:

Constant Field Values

DC_USER_MODE

public static final String DC_USER_MODE

See Also:

Constant Field Values

DC_GOVERNANCE_MODE

public static final String DC_GOVERNANCE_MODE

See Also:

Constant Field Values

DC_RULEPROJECT_MODE

public static final String DC_RULEPROJECT_MODE

See Also:

Constant Field Values

HISTORY_TEST_DELAY_USAGE

public static final String HISTORY_TEST_DELAY_USAGE

See Also:

Constant Field Values

HISTORY_DELAY_DAYMODE

public static final String HISTORY_DELAY_DAYMODE

See Also:

Constant Field Values

SHOW_WARNING_SMARTVIEWS

public static final String SHOW_WARNING_SMARTVIEWS

See Also:

Constant Field Values

LAYOUT_ORIENTATION

public static final String LAYOUT_ORIENTATION

See Also:

Constant Field Values

ACCESSIBILITY

public static final String ACCESSIBILITY

See Also:

Constant Field Values

USE_COMPRESSION

public static final String USE_COMPRESSION

See Also:

Constant Field Values

PERFORM_DT_CHECKS

public static final String PERFORM_DT_CHECKS

See Also:

Constant Field Values

INPUT_ORIENTATION

public static final String INPUT_ORIENTATION

See Also:

Constant Field Values

INPUT_ORIENTATION_RTL

public static final String INPUT_ORIENTATION_RTL

See Also:

Constant Field Values

INPUT_ORIENTATION_LTR

public static final String INPUT_ORIENTATION_LTR

See Also:

Constant Field Values

INPUT_ORIENTATION_CONTEXTUAL

public static final String INPUT_ORIENTATION_CONTEXTUAL

See Also:

Constant Field Values

INPUT_ORIENTATION_UIBASED

public static final String INPUT_ORIENTATION_UIBASED

See Also:

Constant Field Values

LAST_WHATS_NEW_CREATE_RULE_TIME

public static final String LAST_WHATS_NEW_CREATE_RULE_TIME

See Also:

Constant Field Values

LAST_WHATS_NEW_UPDATE_RULE_TIME

public static final String LAST_WHATS_NEW_UPDATE_RULE_TIME

See Also:

Constant Field Values

LAST_WHATS_NEW_ACTIVITY_TIME

public static final String LAST_WHATS_NEW_ACTIVITY_TIME

See Also:

Constant Field Values

LAST_WHATS_NEW_TIME_FORMAT

public static final String LAST_WHATS_NEW_TIME_FORMAT

See Also:

Constant Field Values

Constructor Detail

IlrSettings

public IlrSettings()

Method Detail

saveGlobalSetting

public static boolean saveGlobalSetting(IlrSession session,
                                        String key,
                                        String value)

Saves a global setting.

Parameters:

session - The session to use to perform the operation.

key - A key.

value - A value.

Returns:

true if the setting was saved with no error. false otherwise.

saveSetting

public static boolean saveSetting(IlrSession session,
                                  String userName,
                                  String key,
                                  String value)

Saves a setting for the given user.

Parameters:

session - The session to use to perform the operation.

userName - Name of the user.

key - A key.

value - A value.

Returns:

true if the setting was saved with no error. false otherwise.

removeGlobalSetting

public static boolean removeGlobalSetting(IlrSession session,
                                          String key)

Removes a global setting.

Parameters:

session - The session to use to perform the operation.

key - A key.

Returns:

true if the setting was removed with no error. false otherwise.

removeSetting

public static boolean removeSetting(IlrSession session,
                                    String userName,
                                    String key)

Removes a setting for a given user.

Parameters:

session - The session to use to perform the operation.

key - A key.

userName - Name of the user.

Returns:

true if the setting was removed with no error. false otherwise.

getSetting

public static String getSetting(IlrSession session,
                                String userName,
                                String key)

Gets the value of a setting for the given user.

Parameters:

session - The session to use to perform the operation.

key - A key.

userName - Name of the user.

Returns:

The value of the setting. Null if the setting is not defined.

getGlobalSetting

public static String getGlobalSetting(IlrSession session,
                                      String key)

Gets the value of a global setting.

Parameters:

session - The session to use to perform the operation.

key - A key.

Returns:

The value of the setting. Null if the setting is not defined.

getBuildSeverityLevel

public static int getBuildSeverityLevel(IlrSession session)

One of <null>, info, warning, error, semantic, never.

Parameters:

session - The session

Returns:

One of <null>, info, warning, error, semantic, never.

searchSetting

public static List<IlrElementDetails> searchSetting(IlrSession session,
                                                    String key,
                                                    String searchString)