Package lumis.portal.serviceinterface.style.impl.common

Interface IEnvironment

All Known Implementing Classes:

EnvironmentAdapter

@StableMinor(version="17.1",
             sinceVersion="17.1")
public interface IEnvironment

LumisXP environment-related interface to be exposed in style files.

Since:

17.1.0

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getProperties()	Returns a read-only map with the environment properties.
default java.lang.String	getPropertyValue(java.lang.String propertyName)	Returns the property's first value if the property is found or null if either the property was not found or the property does not contain values.
default java.lang.String	getPropertyValue(java.lang.String propertyName, java.lang.String defaultValue)	Returns the property's first value if the property is found and it is not null or the defaultValue if the property was not found, it was found but it contains no values or the first value is null.

Method Detail

getProperties

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getProperties()
                                                                              throws PortalException

Returns a read-only map with the environment properties.

Returns:

a read-only map with the environment properties

Throws:

PortalException

Since:

17.1.0

getPropertyValue

default java.lang.String getPropertyValue(java.lang.String propertyName)
                                   throws PortalException

Returns the property's first value if the property is found or null if either the property was not found or the property does not contain values.

Parameters:

propertyName - the property name

Returns:

the property's first value

Throws:

PortalException

Since:

17.1.0

getPropertyValue

default java.lang.String getPropertyValue(java.lang.String propertyName,
                                          java.lang.String defaultValue)
                                   throws PortalException

Returns the property's first value if the property is found and it is not null or the defaultValue if the property was not found, it was found but it contains no values or the first value is null.

Parameters:

propertyName - the property name

defaultValue - the default value

Returns:

the property's first value (if any) or the default value

Throws:

PortalException

Since:

17.1.0