IStateValue (Java API Reference for Oracle Fusion Configurator)

All Superinterfaces:

IConfigurableNode

All Known Subinterfaces:

IBom, IBomModelInstance, IBomOptionClass, IBomStdItem, IBooleanFeature, IItemClassConnectorInstance, IOption, IOptionFeature, IQuantityOption, IQuantityOptionFeature, IState, IStateValueExpression
```
public interface IStateValue
extends IConfigurableNode
```
A value interface that provides state information.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`IStateValue.DetailedSelectionState`	The detailed selection states.
`static class`	`IStateValue.SelectionState`	The simpler form of selection state.
`static class`	`IStateValue.State`	The logic state without any availability computation.

Nested classes/interfaces inherited from interface oracle.apps.scm.configurator.runtime.core.IConfigurableNode
IConfigurableNode.ConfigurableType

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AVAILABLE`	The state indicating that this object is available for selection.
`static int`	`EXCLUDED`	The state indicating that this object is excluded.
`static int`	`LFALSE`	The state indicating that the system has excluded this node from the configuration as the result of propagation prior to the execution of the defaults or search.
`static int`	`LTRUE`	The state indicating that the system has selected this node in the configuration as the result of propagation prior to the execution of the defaults or search.
`static int`	`PFALSE`	The state indicating that the system has excluded this node in the configuration as the result of the execution of the defaults or search.
`static int`	`PROPOSED_EXCLUDED`	The state indicating that this object has been excluded in the configuration by the system as the result of the search.
`static int`	`PROPOSED_SELECTED`	The state indicating that this object has been selected in the configuration by the system as the result of the search.
`static int`	`PTRUE`	The state indicating that the system has selected this node in the configuration as the result of the execution of the defaults or search.
`static int`	`SELECTABLE`	The state indicating that this node is available for selection.
`static int`	`SELECTED`	The state indicating that this object is selected.
`static int`	`SYSTEM_EXCLUDED`	The state indicating that this node has been excluded from the configuration by the system and is not available for selection without a conflict.
`static int`	`SYSTEM_SELECTED`	The state indicating that this object has been selected in the configuration by the system as a result of propagation prior to the execution of defaults or search.
`static int`	`UFALSE`	The state indicating that a user has set this object to false.
`static int`	`UNKNOWN`	The state indicating that the domain of this node is still unbound.
`static int`	`USER_EXCLUDED`	The state indicating that a user has excluded this object.
`static int`	`USER_SELECTED`	The state indicating that a user has selected this object.
`static int`	`UTRUE`	The state indicating that a user has set this object to true.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getDetailedSelectionState()`	Get the current detailed selection state of the node.
`IStateValue.DetailedSelectionState`	`getDetailedSelectionStateValue()`	Get the current detailed selection state of the node.
`int`	`getSelectionState()`	Get the current selection state of the node.
`IStateValue.SelectionState`	`getSelectionStateValue()`	Get the current selection state of the node.
`int`	`getState()`	Get the logic state of the node.
`IStateValue.State`	`getStateValue()`	Get the logic state of the node.
`boolean`	`isBoundSelectionState()`	Returns true if the selection state is bound.
`boolean`	`isExcluded()`	Indicates if the node is excluded.
`boolean`	`isFalse()`	Tells whether this node is in false state.
`boolean`	`isSelected()`	Indicates if the node is selected.
`boolean`	`isTrue()`	Tells whether this node is in True state.

Methods inherited from interface oracle.apps.scm.configurator.runtime.core.IConfigurableNode
getConfigurableNodeType, getConfiguration, getConfiguratorPath, getDatabaseID, getDisplayName, getInputRequiredFlag, getName, getRuntimeID, getValidationErrorText, isBound, isChangedByAC, isChangedByAC, isDeleted, isInputRequired, isInputRequiredError, isProposed, isValid, removeAllUserDecisions, setInputRequiredFlag

- Field Detail
  - USER_SELECTED
```
static final int USER_SELECTED
```
    The state indicating that a user has selected this object.
  - USER_EXCLUDED
```
static final int USER_EXCLUDED
```
    The state indicating that a user has excluded this object.
  - SYSTEM_SELECTED
```
static final int SYSTEM_SELECTED
```
    The state indicating that this object has been selected in the configuration by the system as a result of propagation prior to the execution of defaults or search.
  - SYSTEM_EXCLUDED
```
static final int SYSTEM_EXCLUDED
```
    The state indicating that this node has been excluded from the configuration by the system and is not available for selection without a conflict.
  - SELECTABLE
```
static final int SELECTABLE
```
    The state indicating that this node is available for selection.
  - PROPOSED_EXCLUDED
```
static final int PROPOSED_EXCLUDED
```
    The state indicating that this object has been excluded in the configuration by the system as the result of the search.
  - PROPOSED_SELECTED
```
static final int PROPOSED_SELECTED
```
    The state indicating that this object has been selected in the configuration by the system as the result of the search.
  - SELECTED
```
static final int SELECTED
```
    The state indicating that this object is selected.
  - EXCLUDED
```
static final int EXCLUDED
```
    The state indicating that this object is excluded.
  - AVAILABLE
```
static final int AVAILABLE
```
    The state indicating that this object is available for selection.
  - UTRUE
```
static final int UTRUE
```
    The state indicating that a user has set this object to true.
  - UFALSE
```
static final int UFALSE
```
    The state indicating that a user has set this object to false.
  - LTRUE
```
static final int LTRUE
```
    The state indicating that the system has selected this node in the configuration as the result of propagation prior to the execution of the defaults or search.
  - LFALSE
```
static final int LFALSE
```
    The state indicating that the system has excluded this node from the configuration as the result of propagation prior to the execution of the defaults or search.
  - UNKNOWN
```
static final int UNKNOWN
```
    The state indicating that the domain of this node is still unbound.
  - PTRUE
```
static final int PTRUE
```
    The state indicating that the system has selected this node in the configuration as the result of the execution of the defaults or search.
  - PFALSE
```
static final int PFALSE
```
    The state indicating that the system has excluded this node in the configuration as the result of the execution of the defaults or search.
- Method Detail
  - isSelected
```
boolean isSelected()
```
    Indicates if the node is selected.
    
    Returns:
    
    true if the node is selected, false otherwise.
    
    See Also:
    
    IState#isTrue()
  - isExcluded
```
boolean isExcluded()
```
    Indicates if the node is excluded.
    
    Returns:
    
    true if the node is excluded, false otherwise.
    
    See Also:
    
    IState#isFalse()
  - isTrue
```
boolean isTrue()
```
    Tells whether this node is in True state.
    
    Returns:
    
    true if the state of the node is true, false otherwise.
  - isFalse
```
boolean isFalse()
```
    Tells whether this node is in false state.
    
    Returns:
    
    true if the state of the node is false, false otherwise.
  - getState
```
int getState()
```
    Get the logic state of the node.
    
    Returns:
    
    UTRUE if the node is user selected.
    UFALSE if the node is user excluded.
    LTRUE if the node is selected as the result of propagation prior to the execution of default or search.
    LFALSE if the node is excluded as the result of propagation prior to the execution of default or search.
    UNKNOWN if the node is not bound.
    PTRUE if the node is selected as the result of the execution of default or search.
    PFALSE if the node is excluded as the result of the execution of default or search.
  - getStateValue
```
IStateValue.State getStateValue()
```
    Get the logic state of the node.
    
    Returns:
    
    State.UTRUE if the node is user selected.
    State.UFALSE if the node is user excluded.
    State.LTRUE if the node is selected as the result of propagation prior to the execution of default or search.
    State.LFALSE if the node is excluded as the result of propagation prior to the execution of default or search.
    State.UNBOUND if the node is not bound.
    State.PTRUE if the node is selected as the result of the execution of default or search.
    State.PFALSE if the node is excluded as the result of the execution of default or search.
  - getSelectionStateValue
```
IStateValue.SelectionState getSelectionStateValue()
```
    Get the current selection state of the node.
    
    Returns:
    
    SelectionState.SELECTED if the node is selected.
    SelectionState.SELECTABLE if the node is selectable.
    SelectionState.EXCLUDED if the node is neither selected nor selectable.
  - getSelectionState
```
int getSelectionState()
```
    Get the current selection state of the node.
    
    Returns:
    
    SELECTED if the node is selected.
    AVAILABLE if the node is selectable.
    EXCLUDED if the node is neither selected nor selectable.
  - getDetailedSelectionState
```
int getDetailedSelectionState()
```
    Get the current detailed selection state of the node.
    
    Returns:
    
    USER_SELECTED if the node is user selected.
    USER_EXCLUDED if the node is user excluded.
    SYSTEM_SELECTED if the node is selected as the result of propagation prior to the execution of default or search.
    SYSTEM_EXCLUDED if the node is excluded as the result of propagation prior to the execution of default or search.
    SELECTABLE if the node is available for selection.
    PROPOSED_SELECTED if the node is recommended as a result of Search.
    PROPOSED_EXCLUDED if the node is not recommended as a result of Search.
  - getDetailedSelectionStateValue
```
IStateValue.DetailedSelectionState getDetailedSelectionStateValue()
```
    Get the current detailed selection state of the node.
    
    Returns:
    
    DetailedSelectionState.USER_SELECTED if the node is user selected.
    DetailedSelectionState.USER_EXCLUDED if the node is user excluded.
    DetailedSelectionState.SYSTEM_SELECTED if the node is selected as the result of propagation prior to the execution of default or search.
    DetailedSelectionState.SYSTEM_EXCLUDED if the node is excluded as the result of propagation prior to the execution of default or search.
    DetailedSelectionState.SELECTABLE if the node is available for selection.
    DetailedSelectionState.PROPOSED_SELECTED if the node is recommended as a result of Search.
    DetailedSelectionState.PROPOSED_EXCLUDED if the node is not recommended as a result of Search.
  - isBoundSelectionState
```
boolean isBoundSelectionState()
```
    Returns true if the selection state is bound.
    
    Returns:
    
    true if the selection state is bound.

Interface IStateValue

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.scm.configurator.runtime.core.IConfigurableNode

Field Summary

Method Summary

Methods inherited from interface oracle.apps.scm.configurator.runtime.core.IConfigurableNode

Field Detail

USER_SELECTED

USER_EXCLUDED

SYSTEM_SELECTED

SYSTEM_EXCLUDED

SELECTABLE

PROPOSED_EXCLUDED

PROPOSED_SELECTED

SELECTED

EXCLUDED

AVAILABLE

UTRUE

UFALSE

LTRUE

LFALSE

UNKNOWN

PTRUE

PFALSE

Method Detail

isSelected

isExcluded

isTrue

isFalse

getState

getStateValue

getSelectionStateValue

getSelectionState

getDetailedSelectionState

getDetailedSelectionStateValue

isBoundSelectionState