Package wt.change2.flexible

Class FlexibleChangeItemReadinessDelegate.ReadinessInfo

java.lang.Object

wt.change2.flexible.FlexibleChangeItemReadinessDelegate.ReadinessInfo

Enclosing class:

FlexibleChangeItemReadinessDelegate

public static class FlexibleChangeItemReadinessDelegate.ReadinessInfo
extends Object

Class for encapsulating the readiness info of a change item.

Supported API: true

Extendable: false

Constructor Summary

Constructors

Constructor	Description
ReadinessInfo(boolean isReady, FlexibleChangeItem changeItem, WTMessage reasonMsg)	Constructor for creating a new ReadinessInfo object with the given parameters.
ReadinessInfo(boolean isReady, ObjectReference changeItemRef, WTMessage reasonMsg)	Constructor for creating a new ReadinessInfo object with the given parameters.

Method Summary

Modifier and Type	Method	Description
ObjectReference	getFlexChangeItemRef()
WTMessage	getReason()
boolean	isReady()
void	setShouldContinueProcessing(boolean shouldContinue)	Set whether or not the change item associated with this readiness should continue to be processed by readiness delegates.
boolean	shouldContinueProcessing()	Whether or not the change item associated with this readiness should continue to be processed by readiness delegates.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadinessInfo

public ReadinessInfo(boolean isReady,
 FlexibleChangeItem changeItem,
 WTMessage reasonMsg)
              throws WTException

Constructor for creating a new ReadinessInfo object with the given parameters. If the isReady flag is false, a non-null reasonMsg must be provided or a WTException will be thrown. Additionally, the changeItem parameter cannot be null.

Parameters:

isReady - - whether or not the change item is ready for conversion.

changeItem - - the change item this readiness info is for.

reasonMsg - - used when the change item is not ready to indicate the reason, must be non-null.

Supported API: true

Throws:

WTException

ReadinessInfo

public ReadinessInfo(boolean isReady,
 ObjectReference changeItemRef,
 WTMessage reasonMsg)
              throws WTException

Constructor for creating a new ReadinessInfo object with the given parameters. A non-null reasonMsg must be provided or a WTException will be thrown. Additionally, the changeItemRef parameter cannot be null and must reference a FlexibleChangeItem object.

Parameters:

isReady - - whether or not the change item is ready for conversion.

changeItemRef - - a reference to the change item this readiness info is for.

reasonMsg - - used when the change item is not ready to indicate the reason, must be non-null.

Supported API: true

Throws:

WTException

Method Details

isReady

public boolean isReady()

Returns:

whether or not the change item associated with this readiness info has been marked as ready for conversion.

Supported API: true

getFlexChangeItemRef

public ObjectReference getFlexChangeItemRef()

Returns:

a reference to the change item associated with this readiness info.

Supported API: true

getReason

public WTMessage getReason()

Returns:

a localized wtMessage that indicates the reason for why this change item has been marked as not ready for conversion. Guaranteed non-null.

Supported API: true

setShouldContinueProcessing

public void setShouldContinueProcessing(boolean shouldContinue)

Set whether or not the change item associated with this readiness should continue to be processed by readiness delegates. Only relevant if isReady returns false.

Parameters:

shouldContinue - - whether or not to continue processing.

Supported API: true

shouldContinueProcessing

public boolean shouldContinueProcessing()

Whether or not the change item associated with this readiness should continue to be processed by readiness delegates. Defaults to true if has not been set. Only relevant if isReady returns false.

Supported API: true

Returns:

whether or not to continue processing.