Interface ISystemPropertyHandler
-
- All Superinterfaces:
IAPIHandler
,IGenericHandler
,Serializable
- All Known Implementing Classes:
SystemPropertyHandler
public interface ISystemPropertyHandler extends IGenericHandler
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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 aProperty
by a given key.List<SystemProperty>
getByKeyPrefix(UserContext uc, String keyPrefix)
Retrives aList
ofSystemProperty
s by a given key prefix.List<SystemProperty>
getByKeys(UserContext uc, List<String> keys)
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 de.xima.fc.com.interfaces.IAPIHandler
getName
-
Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler
create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update
-
-
-
-
Method Detail
-
getByKey
SystemProperty getByKey(UserContext uc, String key)
Retrieves aProperty
by a given key.- Parameters:
uc
- theUserContext
to usekey
- the system property key- Returns:
- a
SystemProperty
-
getByKeys
List<SystemProperty> getByKeys(UserContext uc, List<String> keys)
- Parameters:
uc
- theUserContext
to usekeys
- aList
of keys- Returns:
- a
List
ofSystemProperty
s
-
getByKeyPrefix
List<SystemProperty> getByKeyPrefix(UserContext uc, String keyPrefix)
Retrives aList
ofSystemProperty
s by a given key prefix.- Parameters:
uc
- theUserContext
to usekeyPrefix
- a prefix for all keys to search for- Returns:
- a
List
ofSystemProperty
s
-
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.
-
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.
-
-