Package com.day.cq.wcm.msm.api
Interface RolloutConfig
-
- All Superinterfaces:
JSONItem
,LabeledResource
public interface RolloutConfig extends LabeledResource, JSONItem
ARolloutConfig
is a config used by theRolloutManager
to perform a roll-out. It defines the set ofLiveActions
to be performed upon a given event calledtrigger
.
Roll-out configuration
can be accessed via RolloutConfigManager or theLiveRelationship
they are effective on.
RolloutConfig is identified by itsPath
- Since:
- 5.4
- See Also:
LiveRelationship
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.util.List<LiveAction>
getActions()
The LiveActions to be executed upon a Roll-out.java.util.Set<ActionConfig>
getActionsConfig()
Deprecated.since 5.5 usegetActions()
insteadRolloutManager.Trigger
getTrigger()
Returns theRolloutManager.Trigger
linked to the currentRolloutConfing
.-
Methods inherited from interface com.day.cq.commons.LabeledResource
getDescription, getName, getPath, getTitle
-
-
-
-
Method Detail
-
getTrigger
RolloutManager.Trigger getTrigger()
Returns theRolloutManager.Trigger
linked to the currentRolloutConfing
.- 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 usegetActions()
insteadReturns a set of theActionConfig
linked to the currentRolloutConfing
.- Returns:
- the actions or an empty set
-
-