org.docgene.model

Interface TodoElement

All Superinterfaces:

ReviewElement

All Known Implementing Classes:

XMLMessageBox, XMLTodo

public interface TodoElement
extends ReviewElement

A TODO element.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getReason() Return the reason of the TODO.
default java.lang.String	getTODOText() Return the text of the TODO.
short	getType() Return the type of the TODO.
boolean	hasReason() Return true if the TODO has a reason.
default boolean	hasTODOText() Return true if the TODO has a text.

Methods inherited from interface org.docgene.model.ReviewElement

getIndex, getRef

Method Detail

hasReason

boolean hasReason()

Return true if the TODO has a reason.

Returns:

true if the TODO has a reason

getReason

java.lang.String getReason()

Return the reason of the TODO.

Returns:

the reason of the TODO

getTODOText

default java.lang.String getTODOText()

Return the text of the TODO. Defer to getReason().

Specified by:

getTODOText in interface ReviewElement

Returns:

the text of the TODO

hasTODOText

default boolean hasTODOText()

Return true if the TODO has a text. Defer by default to hasReason().

Returns:

true if the TODO has a text

getType

short getType()

Return the type of the TODO.

Returns:

the type