|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.workplace.wcm.api.custom.WCM_RescheduleDirectiveParams
public class WCM_RescheduleDirectiveParams
The RescheduleDirectiveParams
object is used to specify arguments or options to a 'Reschedule' Directive.
To create a new RescheduleDirectiveParams
object call Directives.RESCHEDULE.createDirectiveParams()
and cast the returned object to RescheduleDirectiveParams
To use a RescheduleDirectiveParams
object call the CustomWorkflowActionService.createResult(Directive, String, DirectiveParams)
method instead of CustomWorkflowActionService.createResult(Directive, String)
to construct the workflow action result.
Constructor Summary | |
---|---|
WCM_RescheduleDirectiveParams()
Constructor |
Method Summary | |
---|---|
java.util.Date |
getRescheduleDate()
Returns the specified 'Reschedule Date' |
boolean |
isRescheduleOnly()
Indicates whether the current action has just rescheduled itself (true) OR additionally modified the document (false) |
void |
setRescheduleDate(java.util.Date rescheduleDate)
Specifies the date that the Reschedule Directive should reschedule the current workflow action |
void |
setRescheduleOnly(boolean rescheduleOnly)
Specifies whether the current action has just rescheduled itself (true) OR additionally modified the document (false) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WCM_RescheduleDirectiveParams()
Method Detail |
---|
public void setRescheduleDate(java.util.Date rescheduleDate)
setRescheduleDate
in interface RescheduleDirectiveParams
rescheduleDate
- the date that the Reschedule Directive should reschedule the current workflow actionpublic java.util.Date getRescheduleDate()
getRescheduleDate
in interface RescheduleDirectiveParams
Null
if no reschedule date has been specifiedpublic void setRescheduleOnly(boolean rescheduleOnly)
Used to optimize document save and avoid unnecessary versions, jms-messages and syndication
Note: When true, only the workflow action state is persisted which ignores any changes made to the document from this action. If your reschedule logic is based on a field on the document (and/or modification date) then you should not set this to true
setRescheduleOnly
in interface RescheduleDirectiveParams
rescheduleOnly
- true if the action didn't also modify the document, false otherwisepublic boolean isRescheduleOnly()
Defaults to 'false'
isRescheduleOnly
in interface RescheduleDirectiveParams
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |