Fluent builder for creating and persisting a new record matcher on a sales data series. Obtained via RecordMatchingManager.newRecordMatcherBuilder(), configured through its chained setter methods, then finished with build().
Group: Builders
Methods
name(String s)
Returns: RecordMatcherBuilder
Sets the new record matcher's name, the portable machine-meaningful identifier used as its lookup key (as opposed to its display title).
| Parameter | Description |
|---|---|
s | the record matcher's name |
title(String s)
Returns: RecordMatcherBuilder
Sets the new record matcher's display title, shown to admins in the UI.
| Parameter | Description |
|---|---|
s | the record matcher's title |
notes(String s)
Returns: RecordMatcherBuilder
Sets free-text notes on the new record matcher, for admin reference only.
| Parameter | Description |
|---|---|
s | the notes text |
destinationSeries(SalesDataSeries s)
Returns: RecordMatcherBuilder
Sets the series that matched/generated destination records are created in. Leave unset to write them into the same series being scanned.
| Parameter | Description |
|---|---|
s | the destination sales data series, or null to use the series being scanned |
recordMatcherTypeId(String s)
Returns: RecordMatcherBuilder
Sets the id of the record matcher type (see RecordMatcherType) that this matcher runs.
| Parameter | Description |
|---|---|
s | the record matcher type id |
matcherConfig(String s)
Returns: RecordMatcherBuilder
Sets the type-specific configuration for this matcher, encoded as a parameter string (parsed with WebUtils.parseParamStringToMap()).
| Parameter | Description |
|---|---|
s | the encoded matcher configuration |
dateRangeMonths(Integer i)
Returns: RecordMatcherBuilder
Sets how many months back from today candidate records are scanned. Leave unset to use the record matcher type's default.
| Parameter | Description |
|---|---|
i | the date range in months, or null to use the default |
build()
Returns: RecordMatcher
Creates and persists the configured record matcher.