A single matched group produced by a RecordMatcher, eg one bundle instance or one role-split instance. The actual source/destination SalesDataRecords involved are linked via RecordMatchLink rows.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| active | boolean | Whether this match still stands. Derived from the status, not a stored column. Only active matches count against a record's remaining capacity. |
| createdDate | Date | When this match was produced. Match finders order and window on this date. |
| errorMsg | String | Message describing a problem encountered while producing this match, up to 2000 characters. Null when the match was produced cleanly. |
| id | long | The database identifier of this match. |
| invalidated | boolean | Whether this match has been cancelled. Derived from the status, not a stored column. Invalidation is terminal, so an invalidated match never becomes active again. |
| invalidatedDate | Date | When the match was invalidated. Null while the match is still active. |
| invalidationReason | String | Why the match was invalidated, kept for audit. Up to 2000 characters, and null while the match is still active. |
| matcher | RecordMatcher | The matcher rule that produced this match. Never null for a persisted match, and loaded lazily. |
| matchType | String | Identifier of the RecordMatcherType which produced this match, copied from the matcher when the match was created so it survives a later change to the matcher's configuration. |
| status | String | Lifecycle state of this match, either ACTIVE or INVALIDATED. It is set once when the match is created and only ever moves to INVALIDATED, never back. |
Methods
getId() · getMatcher() · setMatcher(RecordMatcher matcher) · getMatchType() · setMatchType(String matchType) · getCreatedDate() · setCreatedDate(Date createdDate) · getErrorMsg() · setErrorMsg(String errorMsg) · getStatus() · setStatus(String status) · isActive() · isInvalidated() · getInvalidatedDate() · setInvalidatedDate(Date invalidatedDate) · getInvalidationReason() · setInvalidationReason(String invalidationReason)
getId()
Returns: long
The database identifier of this match.
getMatcher()
Returns: RecordMatcher
The matcher rule that produced this match. Never null for a persisted match, and loaded lazily.
setMatcher(RecordMatcher matcher)
Returns: void
Sets the matcher rule that produced this match.
| Parameter | Description |
|---|---|
matcher | the matcher which produced this match |
getMatchType()
Returns: String
Identifier of the RecordMatcherType which produced this match, copied from the matcher when the match was created so it survives a later change to the matcher's configuration.
setMatchType(String matchType)
Returns: void
Sets the identifier of the matcher type which produced this match.
| Parameter | Description |
|---|---|
matchType | the matcher type identifier |
getCreatedDate()
Returns: Date
When this match was produced. Match finders order and window on this date.
setCreatedDate(Date createdDate)
Returns: void
Sets the date this match was produced.
| Parameter | Description |
|---|---|
createdDate | the date the match was created |
getErrorMsg()
Returns: String
Message describing a problem encountered while producing this match, up to 2000 characters. Null when the match was produced cleanly.
setErrorMsg(String errorMsg)
Returns: void
Sets the message describing a problem encountered while producing this match.
| Parameter | Description |
|---|---|
errorMsg | the error message, up to 2000 characters |
getStatus()
Returns: String
Lifecycle state of this match, either ACTIVE or INVALIDATED. It is set once when the match is created and only ever moves to INVALIDATED, never back.
setStatus(String status)
Returns: void
Sets the lifecycle state of this match. Prefer invalidate, which also stamps the date and reason.
| Parameter | Description |
|---|---|
status | the status code, either ACTIVE or INVALIDATED |
isActive()
Returns: boolean
Whether this match still stands. Derived from the status, not a stored column. Only active matches count against a record's remaining capacity.
isInvalidated()
Returns: boolean
Whether this match has been cancelled. Derived from the status, not a stored column. Invalidation is terminal, so an invalidated match never becomes active again.
getInvalidatedDate()
Returns: Date
When the match was invalidated. Null while the match is still active.
setInvalidatedDate(Date invalidatedDate)
Returns: void
Sets the date the match was invalidated.
| Parameter | Description |
|---|---|
invalidatedDate | the invalidation date |
getInvalidationReason()
Returns: String
Why the match was invalidated, kept for audit. Up to 2000 characters, and null while the match is still active.
setInvalidationReason(String invalidationReason)
Returns: void
Sets the reason the match was invalidated.
| Parameter | Description |
|---|---|
invalidationReason | the invalidation reason, up to 2000 characters |