Interface ISystemPropertyHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

SystemPropertyHandler

public interface ISystemPropertyHandler
extends IGenericHandler

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
boolean	getBooleanValue(UserContext uc, String key, boolean defaultValue)	Returns the boolean value of the system property with the given key if it exists.
SystemProperty	getByKey(UserContext uc, String key)	Retrieves a Property by a given key.
List<SystemProperty>	getByKeyPrefix(UserContext uc, String keyPrefix)	Retrives a List of SystemPropertys by a given key prefix.
List<SystemProperty>	getByKeys(UserContext uc, List<String> keys)	Retrives a List of SystemPropertys by a given List of keys.
IMfaSettings	getMfaSettings(UserContext uc)	Gets the Multi-Factor Authentication (MFA) settings for the system.
String	getStringValue(UserContext uc, String key, String defaultValue)	Returns the String value of the system property with the given key if it exists.

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Details

getBooleanValue

boolean getBooleanValue(UserContext uc,
 String key,
 boolean defaultValue)

Returns the boolean value of the system property with the given key if it exists. If the system property does not exists the provided default value will be returned.

Parameters:

uc - user context for database transactions.

key - of the system property.

defaultValue - to return if no system property was found for the given key.

Returns:

the boolean value of the system property with the given key if it exists and the provided default value otherwise.

getByKey

SystemProperty getByKey(UserContext uc,
 String key)

Retrieves a Property by a given key.

Parameters:

uc - the UserContext to use

key - the system property key

Returns:

a SystemProperty

getByKeyPrefix

List<SystemProperty> getByKeyPrefix(UserContext uc,
 String keyPrefix)

Retrives a List of SystemPropertys by a given key prefix.

Parameters:

uc - the UserContext to use

keyPrefix - a prefix for all keys to search for

Returns:

a List of SystemPropertys

getByKeys

List<SystemProperty> getByKeys(UserContext uc,
 List<String> keys)

Retrives a List of SystemPropertys by a given List of keys.

Parameters:

uc - the UserContext to use

keys - a List of keys

Returns:

a List of SystemPropertys

getMfaSettings

IMfaSettings getMfaSettings(UserContext uc)

Gets the Multi-Factor Authentication (MFA) settings for the system.

Parameters:

uc - the UserContext to use

Returns:

The MFA settings for the system.

Since:

8.4.0

getStringValue

String getStringValue(UserContext uc,
 String key,
 String defaultValue)

Returns the String value of the system property with the given key if it exists. If the system property does not exists the provided default value will be returned.

Parameters:

uc - user context for database transactions.

key - of the system property.

defaultValue - to return if no system property was found for the given key.

Returns:

the String value of the system property with the given key if it exists and the provided default value otherwise.