com.liferay.change.tracking.settings

Interface CTSettingsManager

@ProviderType
public interface CTSettingsManager

Provides an API to handle global and user level change tracking settings in a general way

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGlobalCTSetting(long companyId, java.lang.String key) Retrieves a global change tracking setting's value for a given company and a key or null if it can not be determined.
java.lang.String	getGlobalCTSetting(long companyId, java.lang.String key, java.lang.String defaultValue) Retrieves a global change tracking setting's value for a given company and a key or defaultValue if it can not be determined.
java.lang.String	getUserCTSetting(long userId, java.lang.String key) Retrieves a user change tracking setting's value for a given user and a key.
java.lang.String	getUserCTSetting(long userId, java.lang.String key, java.lang.String defaultValue) Retrieves a user change tracking setting's value for a given user and a key.
void	setGlobalCTSetting(long companyId, java.lang.String key, java.lang.String value) Sets a global change tracking setting's value for a given company and a key.
void	setUserCTSetting(long userId, java.lang.String key, java.lang.String value) Sets a user change tracking setting's value for a given user and a key.

Method Detail

getGlobalCTSetting

java.lang.String getGlobalCTSetting(long companyId,
                                    java.lang.String key)

Retrieves a global change tracking setting's value for a given company and a key or null if it can not be determined.

Parameters:

companyId - the primary key of the company

key - the key of the setting's value

Returns:

the global change tracking setting's value for the given company and key or null if it can not be determined

getGlobalCTSetting

java.lang.String getGlobalCTSetting(long companyId,
                                    java.lang.String key,
                                    java.lang.String defaultValue)

Retrieves a global change tracking setting's value for a given company and a key or defaultValue if it can not be determined.

Parameters:

companyId - the primary key of the company

key - the key of the setting's value

defaultValue - the default value to return if the actual value can not be determined

Returns:

the global change tracking setting's value for the given company and key or defaultValue if it can not be determined

getUserCTSetting

java.lang.String getUserCTSetting(long userId,
                                  java.lang.String key)

Retrieves a user change tracking setting's value for a given user and a key. If it can not be determined, it looks for the same key as a global setting. If it still can not be found it returns null.

Parameters:

userId - the primary key of the user

key - the key of the setting's value

Returns:

the user change tracking setting's value for the given user and key or the global change tracking setting's value for the given user and key or null if it can not be determined

getUserCTSetting

java.lang.String getUserCTSetting(long userId,
                                  java.lang.String key,
                                  java.lang.String defaultValue)

Retrieves a user change tracking setting's value for a given user and a key. If it can not be determined, it looks for the same key as a global setting. If it still can not be found it returns defaultValue.

Parameters:

userId - the primary key of the user

key - the key of the setting's value

defaultValue - the default value to return if the actual value can not be determined

Returns:

the user change tracking setting's value for the given user and key or the global change tracking setting's value for the given user and key or defaultValue if it can not be determined

setGlobalCTSetting

void setGlobalCTSetting(long companyId,
                        java.lang.String key,
                        java.lang.String value)

Sets a global change tracking setting's value for a given company and a key.

Parameters:

companyId - the primary key of the company

key - the key of the setting's value

value - the setting's value

setUserCTSetting

void setUserCTSetting(long userId,
                      java.lang.String key,
                      java.lang.String value)

Sets a user change tracking setting's value for a given user and a key.

Parameters:

userId - the primary key of the user

key - the key of the setting's value

value - the setting's value