Package net.pricefx.formulaengine.scripting.inputbuilder

Class DateRangeInputBuilder

Object

AbstractInputBuilder<DateRangeInputBuilder,String[]>

DateRangeInputBuilder

public class DateRangeInputBuilder
extends AbstractInputBuilder<DateRangeInputBuilder,String[]>

Builder class for input type DateRangeUserEntry InputType.DATERANGEUSERENTRY.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DateRangeInputBuilder.Period

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields inherited from class AbstractInputBuilder

builderContext, cp

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DateRangeInputBuilder(InputBuilderContext builderContext, String paramName)

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
DateRangeInputBuilder	setFrom(String from)	Sets the from value of the date range input field.
DateRangeInputBuilder	setPickerFormat(DateRangeInputBuilder.Period period)	Sets the date picker format with predefined value NOTE: - DateRangeInputBuilder.Period import is needed to properly recognise the enum value as the method's argument - if null is passed, the period is not configured and will not work. Example:
DateRangeInputBuilder	setTo(String to)	Set to value of the date range input field.

Methods inherited from class AbstractInputBuilder

addOrUpdateInput, addToConfiguratorEntry, addToConfiguratorEntry, buildContextParameter, buildMap, getInput, self, setAccessCode, setAlign, setAllValueTypesTracking, setAlwaysEditable, setAppearance, setAutoComplete, setAutoFocus, setCaption, setConfigValues, setCustomAttributeName, setCustomAttributeValue, setDefaultValueTracking, setDefaultWidth, setDisabled, setDisplayMode, setErrorMessage, setExportable, setFirstRunTracking, setFlex, setHelpLink, setHelpText, setIcon, setIconPosition, setImportable, setLabel, setLabelPlacement, setLabelStyle, setLabelTranslations, setLayoutGridName, setNoRefresh, setParameterGroup, setPlaceholderText, setPreviousValueTracking, setReadOnly, setRequired, setShowInline, setSize, setSuccessMessage, setTheme, setTitle, setTrackedValue, setUserGroupEdit, setUserGroupEdit, setUserGroupView, setValue, setValueChangeTracking, setValueHint, setWarningMessage, setWidth

Methods inherited from class Object

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

Constructor Details

DateRangeInputBuilder

protected DateRangeInputBuilder(InputBuilderContext builderContext,
 String paramName)

Method Details

setFrom

public DateRangeInputBuilder setFrom(String from)

Sets the from value of the date range input field.

Minimum date to be selected from the DateRangeUserEntry dropdown

Accepts only Strings in format 'YYYY-MM-DD', if other provided InputBuilderExceptions.InvalidDateException is thrown.

If date from value is after to the InputBuilderExceptions.InvalidDateException is thrown

Example:

 api.inputBuilderFactory()
      .createDateRangeUserEntry('dateRange')
      .setFrom('2019-10-01')  // date before 2019-10-01 will not be available to select
      .setTo('2019-11-01')    // date after 2019-11-01 will not be available to select
      .buildContextParameter()
 

Parameters:

from - Date from / minimum, as a String

Returns:

DateRangeInputBuilder with the updated PriceFxInterface.FIELD_CONTEXTPARAM_CONFIG_FROM

See Also:

• setTo(String)

setTo

public DateRangeInputBuilder setTo(String to)

Set to value of the date range input field.

Maximum date to be selected from the DateRangeUserEntry dropdown.

Accepts only Strings in format 'YYYY-MM-DD', if other provided InputBuilderExceptions.InvalidDateException is thrown.

If date to value is before from the InputBuilderExceptions.InvalidDateException is thrown

Example:

 api.inputBuilderFactory()
      .createDateRangeUserEntry('dateRange')
      .setFrom('2019-10-01')  // date before 2019-10-01 will not be available to select
      .setTo('2019-11-01')    // date after 2019-11-01 will not be available to select
      .buildContextParameter()
 

Parameters:

to - Date to / maximum, as a String

Returns:

DateRangeInputBuilder with the updated PriceFxInterface.FIELD_CONTEXTPARAM_CONFIG_TO

See Also:

• setFrom(String)

setPickerFormat

public DateRangeInputBuilder setPickerFormat(DateRangeInputBuilder.Period period)

Sets the date picker format with predefined value
NOTE:
- DateRangeInputBuilder.Period import is needed to properly recognise the enum value as the method's argument
- if null is passed, the period is not configured and will not work.

Example:

 import net.pricefx.formulaengine.scripting.inputbuilder.DateRangeInputBuilder.Period

 if (api.isInputGenerationExecution()) {
  return api.inputBuilderFactory()
      .createDateRangeUserEntry('dateRangePicker')
      .setPickerFormat(Period.MONTH)
      .getInput()
 }

 return input.dateRangePicker

 

Parameters:

period - DateRangeInputBuilder.Period to be used in the picker, available values are:

• DateRangeInputBuilder.Period.DAY
• DateRangeInputBuilder.Period.MONTH
• DateRangeInputBuilder.Period.QUARTER
• DateRangeInputBuilder.Period.YEAR

Returns:

DateRangeInputBuilder with the updated PriceFxInterface.FIELD_CONTEXTPARAM_PICKER_PERIOD

Since:

14.0 - Caribou Lou

See Also:

• setTo(String)
• setFrom(String)

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<DateRangeInputBuilder,String[]>