oracle.rules.sdk2.dictionary

Class VerbalProperty

java.lang.Object

oracle.rules.sdk2.dictionary.DictionaryProperty<T>

oracle.rules.sdk2.dictionary.SettableProperty<VerbalChoice>

oracle.rules.sdk2.dictionary.VerbalProperty

All Implemented Interfaces:

java.io.Serializable

public class VerbalProperty
extends SettableProperty<VerbalChoice>

This class represents the Value property of a VerbalRuleComponent The entire set of choices can be obtained through the getPermutedChoices(String pattern) method It also provides paged access to the list of valid choices through the getPermutedChoicesPaged(String pattern, int maxPageSize) method

Since:

12.1.2

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.rules.sdk2.dictionary.SettableProperty

SettableProperty.Diff<T>

Nested classes/interfaces inherited from class oracle.rules.sdk2.dictionary.DictionaryProperty

DictionaryProperty.DiffType

Method Summary

Modifier and Type	Method and Description
java.util.List<VerbalChoice>	getChoices(java.lang.String pattern) Returns an immutable list of the most relevant valid choices for the VerbalProperty.
java.util.List<VerbalChoice>	getChoices(VerbalChoice pc)
java.util.List<VerbalChoice>	getPagedChoices(java.lang.String pattern) Returns an immutable list of the most relevant valid choices for the VerbalProperty.
VerbalChoice	getValue() Get property value.
boolean	hasDiff() Does this property have diffs?
boolean	hasMoreChoices(java.lang.String pattern)
void	setValue(VerbalChoice value) Set the value of the property

Methods inherited from class oracle.rules.sdk2.dictionary.SettableProperty

getDiffValue, getDiffValue

Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryProperty

getContainedDiffs, getDiff, getDiffs, getName, getName, getTranslatedName, removeDiff

Methods inherited from class java.lang.Object

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

Method Detail

getChoices

public java.util.List<VerbalChoice> getChoices(java.lang.String pattern)

Returns an immutable list of the most relevant valid choices for the VerbalProperty. This API returns the choices that are algorithmically evaluated to be most relevant in the current context. This method would return the list of all possible Choices for the given pattern, the size of which would depend on the size of the Dictionary datamodel. Use getPagedChoices to obtain choices in a paged manner.

Parameters:

pattern - the pattern to look for in the choices

Returns:

a list of matching choices

getPagedChoices

public java.util.List<VerbalChoice> getPagedChoices(java.lang.String pattern)

Returns an immutable list of the most relevant valid choices for the VerbalProperty. This API can be called repeatedly to obtain choices which are valid but were algorithmically deemed less relevant. Subsequent calls to this API will also include choices that were returned earlier by this API. After a few calls, the API will return all valid choices.

Parameters:

pattern - the pattern to look for in the choices

Returns:

a list of matching choices

getChoices

public java.util.List<VerbalChoice> getChoices(VerbalChoice pc)

getValue

public VerbalChoice getValue()

Description copied from class: DictionaryProperty

Get property value.

Overrides:

getValue in class DictionaryProperty<VerbalChoice>

Returns:

T value

setValue

public void setValue(VerbalChoice value)

Description copied from class: SettableProperty

Set the value of the property

Overrides:

setValue in class SettableProperty<VerbalChoice>

hasMoreChoices

public boolean hasMoreChoices(java.lang.String pattern)

Returns:

true if a call to getPagedChocies(pattern) will return fresh, non-generic choices, false otherwise.

hasDiff

public boolean hasDiff()

Description copied from class: DictionaryProperty

Does this property have diffs?

Overrides:

hasDiff in class DictionaryProperty<VerbalChoice>

Returns:

boolean