com.day.cq.wcm.msm.api

Interface LiveAction

All Superinterfaces:

JSONItem

All Known Implementing Classes:

BaseAction, FilteredAction

public interface LiveAction
extends JSONItem

Represent an Action to be performed upon a Roll-out from a Source to a Target. Actions are created by a LiveActionFactory that provide instances of LiveActions set-up with given configuration.
LiveActions are called during the process of roll-out which on acts on Resources A LiveAction must therefore act within the boundary of the given Resource

See Also:

LiveActionFactory, RolloutManager

Method Summary

Modifier and Type	Method and Description
void	execute(ResourceResolver resolver, LiveRelationship relation, ActionConfig config, boolean autoSave) Deprecated. since 5.5 use execute(org.apache.sling.api.resource.Resource, org.apache.sling.api.resource.Resource, LiveRelationship, boolean, boolean) instead.
void	execute(ResourceResolver resolver, LiveRelationship relation, ActionConfig config, boolean autoSave, boolean isResetRollout) Deprecated. since 5.5 use execute(org.apache.sling.api.resource.Resource, org.apache.sling.api.resource.Resource, LiveRelationship, boolean, boolean) instead.
void	execute(Resource source, Resource target, LiveRelationship relation, boolean autoSave, boolean isResetRollout) Executes action.
java.lang.String	getName() Returns name of current action.
java.lang.String	getParameterName() Deprecated. since 5.5
java.lang.String[]	getPropertiesNames() Deprecated. since 5.5
int	getRank() Deprecated. since 5.5 the Rank is defined by the order in the RolloutConfig
java.lang.String	getTitle() Deprecated. since 5.5
void	write(JSONWriter out) Deprecated. since 5.5

Method Detail

getName

java.lang.String getName()

Returns name of current action. Name is used to persist action in the repository.

Returns:

action name

execute

void execute(Resource source,
             Resource target,
             LiveRelationship relation,
             boolean autoSave,
             boolean isResetRollout)
      throws WCMException

Executes action. Is called by the RolloutManager.
Callers should assert that the method is not called on LiveRelationships that are inactive.

Parameters:

source - The Resource to roll-out. This may bee null

target - The Resource to receive modification. This may bee null

relation - LiveRelationship between the two given Resources

autoSave - Save modifications

isResetRollout - True if rollout is run in reset mode

Throws:

WCMException - if an error occurs

See Also:

RolloutManager.rollout(com.day.cq.wcm.msm.api.RolloutManager.RolloutParams)

execute

@Deprecated
void execute(ResourceResolver resolver,
                         LiveRelationship relation,
                         ActionConfig config,
                         boolean autoSave)
                  throws WCMException

Deprecated. since 5.5 use execute(org.apache.sling.api.resource.Resource, org.apache.sling.api.resource.Resource, LiveRelationship, boolean, boolean) instead.

Executes action. Is called by the Rollout Manager.

Parameters:

resolver - resource resolver

relation - live relationship concerned by action.

config - action config

autoSave - Save modifications

Throws:

WCMException - if an error occurs

See Also:

ActionManager.executeAction(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean)

execute

@Deprecated
void execute(ResourceResolver resolver,
                         LiveRelationship relation,
                         ActionConfig config,
                         boolean autoSave,
                         boolean isResetRollout)
                  throws WCMException

Deprecated. since 5.5 use execute(org.apache.sling.api.resource.Resource, org.apache.sling.api.resource.Resource, LiveRelationship, boolean, boolean) instead.

Executes action. Is called by the Rollout Manager.

Parameters:

resolver - resource resolver

relation - live relationship concerned by action.

config - action config

autoSave - Save modifications

isResetRollout - True if rollout is run in reset mode

Throws:

WCMException - if an error occurs

See Also:

ActionManager.executeAction(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean, boolean)

getTitle

@Deprecated
java.lang.String getTitle()

Deprecated. since 5.5

Returns the title of current action. Title is used to be displayed to end-user.

Returns:

action name

getRank

@Deprecated
int getRank()

Deprecated. since 5.5 the Rank is defined by the order in the RolloutConfig

Returns execution rank of the action: actions are executed by ascending ranks

Returns:

action rank

getPropertiesNames

@Deprecated
java.lang.String[] getPropertiesNames()

Deprecated. since 5.5

Returns names of the properties defined for this action.

Returns:

array of parameters names

getParameterName

@Deprecated
java.lang.String getParameterName()

Deprecated. since 5.5

Returns the global parameter name of current action. Parameter name is used in requests.

Returns:

action parameter name

write

@Deprecated
void write(JSONWriter out)
                throws JSONException

Deprecated. since 5.5

Description copied from interface: JSONItem

Serializes this descriptor to json

Specified by:

write in interface JSONItem

Parameters:

out - json writer

Throws:

JSONException - if a JSON error occurs