com.dotmarketing.portlets.workflows.actionlet
Class WorkFlowActionlet

java.lang.Object
  com.dotmarketing.portlets.workflows.actionlet.WorkFlowActionlet

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ArchiveContentActionlet, CheckinContentActionlet, CheckoutContentActionlet, CheckURLAccessibilityActionlet, CommentOnWorkflowActionlet, DeleteContentActionlet, MultipleApproverActionlet, NotifyAssigneeActionlet, NotifyUsersActionlet, PublishContentActionlet, PushPublishActionlet, ResetTaskActionlet, TwitterActionlet, UnarchiveContentActionlet, UnpublishContentActionlet

public abstract class WorkFlowActionlet
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

WorkFlowActionlet()

Method Summary

boolean	equals(java.lang.Object obj)
abstract void	executeAction(WorkflowProcessor processor, java.util.Map<java.lang.String,WorkflowActionClassParameter> params) This method fires after a piece of content is checked in
void	executePreAction(WorkflowProcessor processor, java.util.Map<java.lang.String,WorkflowActionClassParameter> params) This method fires before a piece of content is checked in.
abstract java.lang.String	getHowTo() Returns the human readable instructions for this Actionlet
java.lang.String	getLocalizedHowto() This method looks for the how to instructions in the language.properties file using property "com.my.classname.howTo" If that is not there it will return the value set in the getHowTo() method.
java.lang.String	getLocalizedName() This method looks for the name in the language.properties file using property "com.my.classname.name" If that is not there it will return the value set in the getName() method.
abstract java.lang.String	getName() Returns the human readable name for this Actionlet
abstract java.util.List<WorkflowActionletParameter>	getParameters() returns the list of parameters that are accepted by the implementing actionlet
boolean	stopProcessing() if this is set, the all subsequent actionlets will not be fired.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkFlowActionlet

public WorkFlowActionlet()

Method Detail

getParameters

public abstract java.util.List<WorkflowActionletParameter> getParameters()

returns the list of parameters that are accepted by the implementing actionlet

Returns:

getLocalizedName

public java.lang.String getLocalizedName()

This method looks for the name in the language.properties file using property "com.my.classname.name" If that is not there it will return the value set in the getName() method.

Returns:

getLocalizedHowto

public java.lang.String getLocalizedHowto()

This method looks for the how to instructions in the language.properties file using property "com.my.classname.howTo" If that is not there it will return the value set in the getHowTo() method.

Returns:

stopProcessing

public boolean stopProcessing()

if this is set, the all subsequent actionlets will not be fired. This is true when executing both the preactions and the postactions

Returns:

getName

public abstract java.lang.String getName()

Returns the human readable name for this Actionlet

Returns:

getHowTo

public abstract java.lang.String getHowTo()

Returns the human readable instructions for this Actionlet

Returns:

executePreAction

public void executePreAction(WorkflowProcessor processor,
                             java.util.Map<java.lang.String,WorkflowActionClassParameter> params)
                      throws WorkflowActionFailureException,
                             DotContentletValidationException

This method fires before a piece of content is checked in.

Parameters:

processor -

params -

Throws:

WorkflowActionFailureException

DotContentletValidationException

executeAction

public abstract void executeAction(WorkflowProcessor processor,
                                   java.util.Map<java.lang.String,WorkflowActionClassParameter> params)
                            throws WorkflowActionFailureException

This method fires after a piece of content is checked in

Parameters:

processor -

params -

Throws:

WorkflowActionFailureException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object