Package com.orchestranetworks.addon.dqid
Class LinkedRecordDefinition
- java.lang.Object
-
- com.orchestranetworks.addon.dqid.LinkedRecordDefinition
-
public final class LinkedRecordDefinition extends java.lang.Object
Declares the rule that defines what kind of records affecting an indicator result.- Since:
- 1.4.0
-
-
Constructor Summary
Constructors Constructor Description LinkedRecordDefinition()
Creates a linked record definition that includes the activation option.LinkedRecordDefinition(com.onwbp.base.text.UserMessage activeDescription)
Creates a linked record definition that includes the activation option.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOption(ParameterDefinition options)
Adds an extra option to help users customize the rule.void
addReferencePath(java.lang.String optionValue, com.orchestranetworks.schema.Path path)
Adds an association between a linked record option's value and aFlat data
path orBig data
path.com.onwbp.base.text.UserMessage
getActivationMessage()
Returns the activation message.java.util.List<ParameterDefinition>
getOptions()
Returns the extra options.com.orchestranetworks.schema.Path
getReferencePath(java.lang.String optionValue)
Returns theFlat data
path or theBig data
path matching the linked record option's value.
-
-
-
Constructor Detail
-
LinkedRecordDefinition
public LinkedRecordDefinition()
Creates a linked record definition that includes the activation option.
-
LinkedRecordDefinition
public LinkedRecordDefinition(com.onwbp.base.text.UserMessage activeDescription)
Creates a linked record definition that includes the activation option.- Parameters:
activeDescription
- The extra information to help users know the business.
-
-
Method Detail
-
getActivationMessage
public com.onwbp.base.text.UserMessage getActivationMessage()
Returns the activation message.
-
addOption
public void addOption(ParameterDefinition options)
Adds an extra option to help users customize the rule.- See Also:
ParameterDefinition
-
getOptions
public java.util.List<ParameterDefinition> getOptions()
Returns the extra options.
-
addReferencePath
public void addReferencePath(java.lang.String optionValue, com.orchestranetworks.schema.Path path)
Adds an association between a linked record option's value and aFlat data
path orBig data
path.- Parameters:
optionValue
- The value of aPredefinedValue
which belongs to a linked record option.path
- Must be a path from theFlat data
table orBig data
table.- Since:
- 1.5.2
- See Also:
addOption(ParameterDefinition)
,PredefinedValue
-
getReferencePath
public com.orchestranetworks.schema.Path getReferencePath(java.lang.String optionValue)
Returns theFlat data
path or theBig data
path matching the linked record option's value.- Since:
- 1.5.2
- See Also:
addReferencePath(String, Path)
-
-