{ } }
Tree 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES   SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.workplace.wcm.api.custom
Class WCM_RollbackDirectiveParams

java.lang.Object
  extended by com.ibm.workplace.wcm.api.custom.WCM_RollbackDirectiveParams
All Implemented Interfaces:
DirectiveParams, RollbackDirectiveParams, java.io.Serializable
public class WCM_RollbackDirectiveParams
extends java.lang.Object
implements RollbackDirectiveParams

The RollbackDirectiveParams object is used to specify arguments or options to a 'Rollback' Directive.

To create a new RollbackDirectiveParams object call Directives.ROLLBACK_DOCUMENT.createDirectiveParams() and cast the returned object to RollbackDirectiveParams

To use a RollbackDirectiveParams object call the CustomWorkflowActionService.createResult(Directive, String, DirectiveParams) method instead of CustomWorkflowActionService.createResult(Directive, String) to construct the workflow action result.

Since:
6.1
See Also:
Serialized Form

Constructor Summary
WCM_RollbackDirectiveParams()
          Constructor
 
Method Summary
 java.lang.String getCustomErrorMsg()
          Returns the specified custom error message
 void setCustomErrorMsg(java.lang.String customErrorMsg)
          Specifies the custom error message that the Rollback Directive should display within the WCM Authoring UI
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WCM_RollbackDirectiveParams

public WCM_RollbackDirectiveParams()
Constructor

Method Detail

setCustomErrorMsg

public void setCustomErrorMsg(java.lang.String customErrorMsg)
Specifies the custom error message that the Rollback Directive should display within the WCM Authoring UI

Specified by:
setCustomErrorMsg in interface RollbackDirectiveParams
Parameters:
customErrorMsg - the custom error message that the Rollback Directive should display within the WCM Authoring UI

getCustomErrorMsg

public java.lang.String getCustomErrorMsg()
Returns the specified custom error message

Specified by:
getCustomErrorMsg in interface RollbackDirectiveParams
Returns:
the specified custom error message. Can be Null if no custom error message has been specified
Tree 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES   SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD