com.soasta.scripting.v1

Interface CustomProperties

public interface CustomProperties

A singleton object that provides access to all Custom Properties in the current Composition.

See the ScriptEnvironment interface for general background information about this API.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getPropertyValue(java.lang.String pathType, java.lang.String propertyPath) Returns the value of the specified Custom Property.
void	setPropertyValue(java.lang.String pathType, java.lang.String propertyPath, java.lang.Object newValue) Sets a new value into the specified Custom Property.

Method Detail

setPropertyValue

void setPropertyValue(java.lang.String pathType,
                    java.lang.String propertyPath,
                    java.lang.Object newValue)
                      throws ScriptEnvironmentException

Sets a new value into the specified Custom Property.

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.

Parameters:

pathType - Specifies the "starting point" of the path to the property, relative to the context in which the current Script is playing, as specified for property paths within "In Situ Substitution Specifications" (ISSEs). Refer to the separate documentation on ISSEs on CloudLink.

propertyPath - The path to the item and property that is to be set, as specified for property paths within "In Situ Substitution Specifications" (ISSEs). Refer to the separate documentation on ISSEs on CloudLink.

newValue - The new value for the Custom Property. May be null, or any of the following objects:

• String

• Long

• Double

• Boolean

• Date

• ArrayList<Object>, when the property is to contain an array. The Object values can be any of the objects listed here, including a nested array.

• LinkedHashMap<String, Object>, when the property is to contain a struct. The String key is the member name. The Object values can be any of the objects listed here, including a nested struct.

Integer objects are also accepted and will be converted to Long. Float objects are also accepted and will be converted to Double. Any other objects will be converted to String by calling the toString() method of the object.

Throws:

ScriptEnvironmentException

getPropertyValue

java.lang.Object getPropertyValue(java.lang.String pathType,
                                java.lang.String propertyPath)
                                  throws ScriptEnvironmentException

Returns the value of the specified Custom Property.

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.

Parameters:

pathType - Specifies the "starting point" of the path to the property, relative to the context in which the current Script is playing, as specified for property paths within "In Situ Substitution Specifications" (ISSEs). Refer to the separate documentation on ISSEs on CloudLink.

propertyPath - The path to the item and property that is to be accessed, as specified for property paths within "In Situ Substitution Specifications" (ISSEs). Refer to the separate documentation on ISSEs on CloudLink.

Returns:

The value of the Custom Property. May be null, or any of the following objects:

• String

• Long

• Double

• Boolean

• Date

• ArrayList<Object>, when the property contains an array. The Object values can be any of the objects listed here, including a nested array.

• LinkedHashMap<String, Object>, when the property contains a struct. The String key is the member name. The Object values can be any of the objects listed here, including a nested struct.

Throws:

ScriptEnvironmentException