Package org.openhab.core.automation.module.script.profile

Class ScriptProfile

java.lang.Object

org.openhab.core.automation.module.script.profile.ScriptProfile

All Implemented Interfaces:

Profile, StateProfile, TimeSeriesProfile

@NonNullByDefault
public class ScriptProfile
extends Object
implements TimeSeriesProfile

The ScriptProfile is generic profile for managing values with scripts

Author:

Jan N. Klug - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_COMMAND_FROM_ITEM_SCRIPT
static final String	CONFIG_STATE_FROM_ITEM_SCRIPT
static final String	CONFIG_TO_HANDLER_SCRIPT
static final String	CONFIG_TO_ITEM_SCRIPT

Constructor Summary

Constructors

Constructor	Description
ScriptProfile(ProfileTypeUID profileTypeUID, ProfileCallback callback, ProfileContext profileContext, TransformationService transformationService)

Method Summary

Modifier and Type	Method	Description
ProfileTypeUID	getProfileTypeUID()	Get the ProfileTypeUID of this profile.
void	onCommandFromHandler(Command command)	If a binding issued a command to a channel, this method will be called for each linked item.
void	onCommandFromItem(Command command)	Will be called if a command should be forwarded to the binding.
void	onStateUpdateFromHandler(State state)	If the binding indicated a state update on a channel, then this method will be called for each linked item.
void	onStateUpdateFromItem(State state)	Will be called if an item has changed its state and this information should be forwarded to the binding.
void	onTimeSeriesFromHandler(TimeSeries timeSeries)	If a binding sends a time-series to a channel, this method will be called for each linked item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONFIG_TO_ITEM_SCRIPT

public static final String CONFIG_TO_ITEM_SCRIPT

See Also:

• Constant Field Values

CONFIG_TO_HANDLER_SCRIPT

public static final String CONFIG_TO_HANDLER_SCRIPT

See Also:

• Constant Field Values

CONFIG_COMMAND_FROM_ITEM_SCRIPT

public static final String CONFIG_COMMAND_FROM_ITEM_SCRIPT

See Also:

• Constant Field Values

CONFIG_STATE_FROM_ITEM_SCRIPT

public static final String CONFIG_STATE_FROM_ITEM_SCRIPT

See Also:

• Constant Field Values

Constructor Details

ScriptProfile

public ScriptProfile(ProfileTypeUID profileTypeUID,
 ProfileCallback callback,
 ProfileContext profileContext,
 TransformationService transformationService)

Method Details

getProfileTypeUID

public ProfileTypeUID getProfileTypeUID()

Description copied from interface: Profile

Get the ProfileTypeUID of this profile.

Specified by:

getProfileTypeUID in interface Profile

Returns:

the UID of the profile type

onStateUpdateFromItem

public void onStateUpdateFromItem(State state)

Description copied from interface: Profile

Will be called if an item has changed its state and this information should be forwarded to the binding.

Specified by:

onStateUpdateFromItem in interface Profile

Parameters:

state - the new state

onCommandFromItem

public void onCommandFromItem(Command command)

Description copied from interface: StateProfile

Will be called if a command should be forwarded to the binding.

Specified by:

onCommandFromItem in interface StateProfile

Parameters:

command -

onCommandFromHandler

public void onCommandFromHandler(Command command)

Description copied from interface: StateProfile

If a binding issued a command to a channel, this method will be called for each linked item.

Specified by:

onCommandFromHandler in interface StateProfile

Parameters:

command -

onStateUpdateFromHandler

public void onStateUpdateFromHandler(State state)

Description copied from interface: StateProfile

If the binding indicated a state update on a channel, then this method will be called for each linked item.

Specified by:

onStateUpdateFromHandler in interface StateProfile

Parameters:

state -

onTimeSeriesFromHandler

public void onTimeSeriesFromHandler(TimeSeries timeSeries)

Description copied from interface: TimeSeriesProfile

If a binding sends a time-series to a channel, this method will be called for each linked item.

Specified by:

onTimeSeriesFromHandler in interface TimeSeriesProfile

Parameters:

timeSeries - the time-series