Class FcTimePointProps
- java.lang.Object
-
- de.xima.fc.workflow.taglib.model.BaseTriggerProps
-
- de.xima.fc.workflow.model.triggers.FcTimePointProps
-
- All Implemented Interfaces:
IDescriptionProviding
,INameProviding
,Serializable
@NotNullIf(field="timePointFixed.fireDateTime",dependants="timePointType",target=FcTimePointProps.class,test="testIsTimePointFixed") @NotNullIf(field="timePointExpressionWithFormat.durationUnit",dependants="timePointType",target=FcTimePointProps.class,test="testIsTimePointExpressionWithFormat") @NotNullIf(field="timePointExpressionWithFormat.operation",dependants="timePointType",target=FcTimePointProps.class,test="testIsTimePointExpressionWithFormat") @NotEmptyIf(field="timePointExpressionWithFormat.dateTimeTemplate", dependants="timePointType", target=FcTimePointProps.class, test="testIsTimePointExpressionWithFormat") @DateTimeFormatterPatternIf(field="timePointExpressionWithFormat.dateTimeFormat", dependants="timePointType", target=FcTimePointProps.class, test="testIsTimePointExpressionWithFormat") public final class FcTimePointProps extends BaseTriggerProps
The properties model for workflow triggers of typeEWorkflowTriggerType.FC_TIME_POINT
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FcTimePointProps.TimePointExpressionWithFormat
The settings for the time point whengetTimePointType()
is set toETimePointType.EXPRESSION_WITH_FORMAT
.static class
FcTimePointProps.TimePointFixed
The settings for the time point whengetTimePointType()
is set toETimePointType.FIXED
.
-
Field Summary
Fields Modifier and Type Field Description static String
ISO_DATE_TIME_FORMAT
ISO date time format that is compatible with JavaScriptDate.prototype.toString
.static String
ISO_INSTANT_FORMAT
static String
ISO_OFFSET_DATE_TIME_FORMAT
static String
SEARCH_TERM_STATE_UUID
Key for storing the selected state UUIDs asWorkflowTriggerSearchTerm
s-
Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding
ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION
-
Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
ATTR_NAME, COL_NAME
-
-
Constructor Summary
Constructors Constructor Description FcTimePointProps()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<UuidEntityRef>
getAllowedStates()
FcTimePointProps.TimePointExpressionWithFormat
getTimePointExpressionWithFormat()
FcTimePointProps.TimePointFixed
getTimePointFixed()
ETimePointType
getTimePointType()
boolean
isFireWhenInPast()
void
setAllowedStates(List<UuidEntityRef> allowedStates)
void
setFireWhenInPast(boolean fireWhenInPast)
void
setTimePointExpressionWithFormat(FcTimePointProps.TimePointExpressionWithFormat timePointExpressionWithFormat)
void
setTimePointFixed(FcTimePointProps.TimePointFixed timePointFixed)
void
setTimePointType(ETimePointType timePointType)
-
Methods inherited from class de.xima.fc.workflow.taglib.model.BaseTriggerProps
getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName
-
-
-
-
Field Detail
-
ISO_DATE_TIME_FORMAT
public static final String ISO_DATE_TIME_FORMAT
ISO date time format that is compatible with JavaScriptDate.prototype.toString
.- See Also:
- Constant Field Values
-
ISO_INSTANT_FORMAT
public static final String ISO_INSTANT_FORMAT
- See Also:
- Constant Field Values
-
ISO_OFFSET_DATE_TIME_FORMAT
public static final String ISO_OFFSET_DATE_TIME_FORMAT
- See Also:
- Constant Field Values
-
SEARCH_TERM_STATE_UUID
public static final String SEARCH_TERM_STATE_UUID
Key for storing the selected state UUIDs asWorkflowTriggerSearchTerm
s
-
-
Method Detail
-
getAllowedStates
public List<UuidEntityRef> getAllowedStates()
- Returns:
- A list of all states allowed for this trigger. This trigger fires only when the form record is in one of these states . When this is an empty list, no restriction is applied.
-
getTimePointExpressionWithFormat
public FcTimePointProps.TimePointExpressionWithFormat getTimePointExpressionWithFormat()
- Returns:
- The settings for the time point when
getTimePointType()
is set toETimePointType.EXPRESSION_WITH_FORMAT
.
-
getTimePointFixed
public FcTimePointProps.TimePointFixed getTimePointFixed()
- Returns:
- The settings for the time point when
getTimePointType()
is set toETimePointType.FIXED
.
-
getTimePointType
public ETimePointType getTimePointType()
- Returns:
- How the user wishes to specify the point in time when the trigger should fire.
-
isFireWhenInPast
public boolean isFireWhenInPast()
- Returns:
- When
true
and the evaluated point in time lies in the past, the trigger is fired immediately. Whenfalse
, the trigger is not fired.
-
setAllowedStates
public void setAllowedStates(List<UuidEntityRef> allowedStates)
- Parameters:
allowedStates
- A list of all states allowed for this trigger. This trigger fires only when the form record is in one of these states . When this is an empty list, no restriction is applied.
-
setFireWhenInPast
public void setFireWhenInPast(boolean fireWhenInPast)
- Parameters:
fireWhenInPast
- Whentrue
and the evaluated point in time lies in the past, the trigger is fired immediately. Whenfalse
, the trigger is not fired.
-
setTimePointExpressionWithFormat
public void setTimePointExpressionWithFormat(FcTimePointProps.TimePointExpressionWithFormat timePointExpressionWithFormat)
- Parameters:
timePointExpressionWithFormat
- The settings for the time point whengetTimePointType()
is set toETimePointType.EXPRESSION_WITH_FORMAT
.
-
setTimePointFixed
public void setTimePointFixed(FcTimePointProps.TimePointFixed timePointFixed)
- Parameters:
timePointFixed
- The settings for the time point whengetTimePointType()
is set toETimePointType.FIXED
.
-
setTimePointType
public void setTimePointType(ETimePointType timePointType)
- Parameters:
timePointType
- How the user wishes to specify the point in time when the trigger should fire.
-
-