public interface GlobalProperties
See the
ScriptEnvironment
interface for general background information about this API.
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getPropertyValue(java.lang.String path,
boolean suppressIncrement)
Returns the value of the specified Global Property from the Repository.
|
void |
setPropertyValue(java.lang.String path,
java.lang.Object newValue)
Sets the value of the specified Global Property in the Repository.
|
void setPropertyValue(java.lang.String path, java.lang.Object newValue) throws ScriptEnvironmentException
Setting and getting of property values is not thread-safe when two or more threads might be accessing the same property value and at least one of the threads is setting the value.
path
- Specifies which property is to be accessed. See the
getPropertyValue
method for a description.newValue
- The new value for the property. Can be null.
The given input will be converted to a string.
For Global Properties of type "counter", the string
must represent a valid integer number.ScriptEnvironmentException
java.lang.Object getPropertyValue(java.lang.String path, boolean suppressIncrement) throws ScriptEnvironmentException
Setting and getting of property values is not thread-safe when two or more threads might be accessing the same property value and at least one of the threads is setting the value.
path
- Specifies which property is to be accessed.
The value can be as simple as only a property name, in which case the property will be taken from the default Global Property List (named "Default"), or it can be a "path" that specifies a Global Property List and a property.
A "path" to a property is given by using the name of the Global Property List, a slash, and then the name of the Global Property in that list. For example, the following path:
My list/Some property
Refers to the property named "Some property" in the Global Property List named "My list".
The following paths are equivalent:
Default/Property 6
Property 6
Both of the above paths refer to the property named "Property 6" in the default Global Property List.
suppressIncrement
- If the property is a counter, it may be
incremented before the value is returned,
unless this parameter is true.ScriptEnvironmentException