com.day.cq.wcm.msm.api

Interface RolloutConfig

All Superinterfaces:

JSONItem, LabeledResource

public interface RolloutConfig
extends LabeledResource, JSONItem

A RolloutConfig is a config used by the RolloutManager to perform a roll-out. It defines the set of LiveActions to be performed upon a given event called trigger.
Roll-out configuration can be accessed via RolloutConfigManager or the LiveRelationship they are effective on.
RolloutConfig is identified by its Path

Since:

5.4

See Also:

LiveRelationship

Method Summary

Modifier and Type	Method and Description
java.util.List<LiveAction>	getActions() The LiveActions to be executed upon a Roll-out.
java.util.Set<ActionConfig>	getActionsConfig() Deprecated. since 5.5 use getActions() instead
RolloutManager.Trigger	getTrigger() Returns the RolloutManager.Trigger linked to the current RolloutConfing.

Methods inherited from interface com.day.cq.commons.LabeledResource

getDescription, getName, getPath, getTitle

Methods inherited from interface com.day.cq.commons.JSONItem

write

Method Detail

getTrigger

RolloutManager.Trigger getTrigger()

Returns the RolloutManager.Trigger linked to the current RolloutConfing.

Returns:

the trigger

getActions

java.util.List<LiveAction> getActions()

The LiveActions to be executed upon a Roll-out. The List is in the order the LiveActions are executed

Returns:

configured actions

Since:

5.5

getActionsConfig

@Deprecated
java.util.Set<ActionConfig> getActionsConfig()

Deprecated. since 5.5 use getActions() instead

Returns a set of the ActionConfig linked to the current RolloutConfing.

Returns:

the actions or an empty set