oracle.apps.scm.configurator.runtime.core

Interface IRuntimeNode

All Superinterfaces:

IConfigurableNode

All Known Subinterfaces:

IBom, IBomModelInstance, IBomOptionClass, IBomStdItem, IBooleanFeature, IComponentInstance, IComponentPort, IConnectorInstance, IConnectorPort, IDecimalFeature, IDecimalValue, IInstance, IIntegerFeature, IIntegerValue, IItemClassConnectorInstance, IItemClassConnectorPort, IOption, IOptionFeature, IPort, IQuantity, IQuantityOption, IQuantityOptionFeature, IState, ITextFeature, IVirtualComponent

public interface IRuntimeNode
extends IConfigurableNode

Represents configurable structure nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IRuntimeNode.StructureType The supported structure nodes

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

IConfigurableNode.ConfigurableType

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_FEATURES A pseudo-type that represents all feature types for use in getChildrenByType(IRuntimeNode.StructureType).
static int	BOM_MODEL BOM model type.
static int	BOM_OPTION_CLASS BOM option class type.
static int	BOM_STD_ITEM BOM standard item type.
static int	BOOLEAN_FEATURE Boolean feature type.
static int	COMPONENT Component type.
static int	COMPONENT_PORT Component port type.
static int	CONNECTOR_PORT Connector port type.
static int	COUNT_FEATURE Count feature type (for LCE compatibility).
static int	DECIMAL_FEATURE Decimal feature type.
static int	INTEGER_FEATURE Integer feature type.
static int	INTEGER_RESOURCE Integer Resource type.
static int	INTEGER_TOTAL Integer Total type.
static int	MISSING_NODE MissingNode type (for LCE compatibility).
static int	OPTION Option type.
static int	OPTION_FEATURE Option feature type.
static int	RESOURCE Resource type.
static int	TEXT_FEATURE Text feature type.
static int	TOTAL Total type.
static int	VIRTUAL_COMPONENT Virtual component type.

Method Summary

Modifier and Type	Method and Description
java.util.Set	getAvailableEventCommands() Returns a list of commands that can be used in CXCommandEvent objects on this node to cause one or more Configurator Extensions to execute.
IRuntimeNode	getChildByName(java.lang.String name) Returns a particular child identified by its name.
<T extends IRuntimeNode> java.util.List<T>	getChildren() Returns a list of children of this runtime node.
java.util.Collection<IRuntimeNode>	getChildrenByType(int type) Returns a collection(IRuntimeNode) of children nodes of the specified type.
java.util.Collection<IRuntimeNode>	getChildrenByType(IRuntimeNode.StructureType type) Returns a collection(IRuntimeNode) of children nodes of the specified type.
java.util.List<IConfigurationAttribute>	getConfigurationAttributeByName(java.lang.String name) Returns any configuration attributes by name across all types of configuration attributes.
IConfigurationAttribute	getConfigurationAttributeByName(java.lang.String name, IConfigurationAttribute.AttributeType type) Looks up the configuration attribute by name and type.
java.util.List<IConfigurationAttribute>	getConfigurationAttributes() Returns a list of all attributes assigned to this node regardless of type.
java.util.List<IConfigurationAttribute>	getConfigurationAttributes(IConfigurationAttribute.AttributeType type) Returns a list of all attributes assigned to this node for the requested type.
java.lang.String	getDescription() Gets the description of the node.
java.lang.String	getDisplayNamePath() Provides the display name path of this node, not including instance information.
java.lang.String	getNamePath() Returns the Name path of this node, including instance information.
int	getNodeType() Gets the type of this node.
IRuntimeNode	getParent() Returns the parent of this node.
java.util.Collection<IProperty>	getProperties() Returns a collection of the properties associated with this node.
IProperty	getPropertyByID(int id) Returns a particular property of this node, based on its ID.
IProperty	getPropertyByName(java.lang.String name) Returns a particular property of this node, based on its name.
IInstance	getRoot() Returns the root of this node.
IRuntimeNode.StructureType	getStructureType() Returns the type of structure node.
boolean	hasChildren() Returns true if this runtime node has children.
boolean	hasCount() Returns true if this node can have numeric value.
boolean	hasDescription() Returns true if there is a design-time description of the runtime node.
boolean	isDescendantOf(IRuntimeNode ancestorNode) Returns true if this is a descendant of the ancestorNode node.
boolean	isEffective() Returns true if this particular node is effective given the effectivity criteria of the model.
boolean	isInputRequiredInSubtree() Indicates if this, any of its descendants or active transactional attributes, requires user input.
boolean	isPriceAble() Indicates if the IRuntime node can support a price, not if the node currently has a price assigned.
boolean	isQuoteable() Returns true if this node is quoteable.
boolean	isRoot() Returns true if this is the root node of the runtime tree.
boolean	isSupplementalOrPortNode() Returns true if the IRuntimeNode represents supplemental node or port node.
boolean	isUiVisible() Returns true if this node appears as a selection in Ui.

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

COMPONENT

static final int COMPONENT

Component type.

COMPONENT_PORT

static final int COMPONENT_PORT

Component port type.

BOOLEAN_FEATURE

static final int BOOLEAN_FEATURE

Boolean feature type.

COUNT_FEATURE

static final int COUNT_FEATURE

Count feature type (for LCE compatibility).

INTEGER_FEATURE

static final int INTEGER_FEATURE

Integer feature type.

DECIMAL_FEATURE

static final int DECIMAL_FEATURE

Decimal feature type.

TEXT_FEATURE

static final int TEXT_FEATURE

Text feature type.

OPTION_FEATURE

static final int OPTION_FEATURE

Option feature type.

OPTION

static final int OPTION

Option type.

TOTAL

static final int TOTAL

Total type.

INTEGER_TOTAL

static final int INTEGER_TOTAL

Integer Total type.

RESOURCE

static final int RESOURCE

Resource type.

See Also:

Constant Field Values

INTEGER_RESOURCE

static final int INTEGER_RESOURCE

Integer Resource type.

See Also:

Constant Field Values

BOM_MODEL

static final int BOM_MODEL

BOM model type.

BOM_OPTION_CLASS

static final int BOM_OPTION_CLASS

BOM option class type.

BOM_STD_ITEM

static final int BOM_STD_ITEM

BOM standard item type.

CONNECTOR_PORT

static final int CONNECTOR_PORT

Connector port type.

MISSING_NODE

static final int MISSING_NODE

MissingNode type (for LCE compatibility).

See Also:

Constant Field Values

VIRTUAL_COMPONENT

static final int VIRTUAL_COMPONENT

Virtual component type.

ALL_FEATURES

static final int ALL_FEATURES

A pseudo-type that represents all feature types for use in getChildrenByType(IRuntimeNode.StructureType).

See Also:

Constant Field Values

Method Detail

getNodeType

int getNodeType()

Gets the type of this node.

Returns:

the type of this node.

getStructureType

IRuntimeNode.StructureType getStructureType()

Returns the type of structure node.

Returns:

The StructureType of the node.

getDisplayNamePath

java.lang.String getDisplayNamePath()

Provides the display name path of this node, not including instance information.

Returns:

the display name path. Cannot be null.

Details

• The display name path returned for a root node is the display name.
• The root node's display name is not included in the display name path of any other node.
• Caller is responsible for any character escaping.

getNamePath

java.lang.String getNamePath()

Returns the Name path of this node, including instance information.

Returns:

the Name path.

Details

• The name path returned for a root node is the node's name.
• The root node's name is not included in the name path of any other node.
• Caller is responsible for any character escaping.

getDescription

java.lang.String getDescription()

Gets the description of the node.

Returns:

the description of the node as defined in the model. Can be null.

Details

• Caller is responsible for any character escaping.

hasDescription

boolean hasDescription()

Returns true if there is a design-time description of the runtime node.

isEffective

boolean isEffective()

Returns true if this particular node is effective given the effectivity criteria of the model.

Returns:

true if the node is effective.

isInputRequiredInSubtree

boolean isInputRequiredInSubtree()

Indicates if this, any of its descendants or active transactional attributes, requires user input.

Returns:

true if this node, or any child node, requires user input.

getParent

IRuntimeNode getParent()

Returns the parent of this node.

Returns:

the node's parent. Can be null.

Details

• Returns null if the node is a root node.
• Or if the node is an instance that is not currently contained in any port.
• Or if the node is a connected product and not currently connected.
• Or if the node is deleted.

getRoot

IInstance getRoot()

Returns the root of this node.

Returns:

the nodes's root. Can be null.

Details

• Returns null if the node is an instance that is not currently contained in any port.
• Or if the node is a connected product and not currently connected.
• Or if the node is deleted.
• When invoked on a root node return the root node.

hasChildren

boolean hasChildren()

Returns true if this runtime node has children. False otherwise.

Returns:

true if the node has children.

false if the node has no children.

getChildren

<T extends IRuntimeNode> java.util.List<T> getChildren()

Returns a list of children of this runtime node.

Returns:

a list of children of this node.

an empty list if there is no children.

getChildrenByType

java.util.Collection<IRuntimeNode> getChildrenByType(int type)

Returns a collection(IRuntimeNode) of children nodes of the specified type.

Parameters:

type - the type of the children to retrieve.

Returns:

a collection of children nodes of the specified type.

getChildrenByType

java.util.Collection<IRuntimeNode> getChildrenByType(IRuntimeNode.StructureType type)

Returns a collection(IRuntimeNode) of children nodes of the specified type.

Parameters:

type - the type of the children to retrieve.

Returns:

a collection of children nodes of the specified type.

getChildByName

IRuntimeNode getChildByName(java.lang.String name)
                     throws NoSuchChildException

Returns a particular child identified by its name.

Note: This method is not supported for IOptionFeature. Use IOptionFeature.getOptionByName();

Parameters:

name - the name of the child to retrieve.

Returns:

a child of this node with the specified name.

Throws:

NoSuchChildException - when the requested child does not exist.

Details:

• If there exists two children with same name, then the child which ever is is first hit during the look-up is returned. A parent with non-unqiuely named children can happen in case of component port's contained instances. Use IPort.getInstanceByNumber() for deterministic look-up in such case.

getProperties

java.util.Collection<IProperty> getProperties()

Returns a collection of the properties associated with this node.

Returns:

collection of IProperty

getPropertyByName

IProperty getPropertyByName(java.lang.String name)

Returns a particular property of this node, based on its name. Returns null if a property of the given name does not exist.

Parameters:

name - the name of the property to retrieve.

Returns:

the requested property of this node.

null if a property of the given name does not exist.

getPropertyByID

IProperty getPropertyByID(int id)

Returns a particular property of this node, based on its ID. Returns null if a property of the given id does not exist.

Parameters:

id - the id of the property to retrieve.

Returns:

the requested property with the specified ID.

null if a property of the given ID does not exist.

getConfigurationAttributes

java.util.List<IConfigurationAttribute> getConfigurationAttributes(IConfigurationAttribute.AttributeType type)

Returns a list of all attributes assigned to this node for the requested type.

Parameters:

type - The type of attribute to retrieve. Cannot be null.

Returns:

The list of configuration attributes defined for the IRuntimeNode. Cannot be null but can be empty. No order or grouping of attributes is specified. Immutable.

Details

• When type is TRANSACTIONAL and item is not active no Transactional Item Attributes are returned.

getConfigurationAttributes

java.util.List<IConfigurationAttribute> getConfigurationAttributes()

Returns a list of all attributes assigned to this node regardless of type.

Returns:

The list of configuration attributes defined for the IRuntimeNode. Cannot be null but can be empty. No order or grouping of attributes is specified. Immutable.

Details

• When type is TRANSACTIONAL and item is not active no Transactional Item Attributes are returned.

getConfigurationAttributeByName

IConfigurationAttribute getConfigurationAttributeByName(java.lang.String name,
                                                        IConfigurationAttribute.AttributeType type)
                                                 throws NoSuchAttributeException

Looks up the configuration attribute by name and type.

Parameters:

name - The attribute name. Cannot be null. For User Defined Attributes the name refers to UDA's attributeGroupName.attributeName.

type - The attribute type. Cannot be null.

Returns:

The IConfigurationAttribute.

Throws:

NoSuchAttributeException -

Details

• When type is TRANSACTIONAL and item is not active NoSuchAttributeException is thrown. Use IBom.hasActiveTransactionalAttributes() to test for active transactional attributes.

getConfigurationAttributeByName

java.util.List<IConfigurationAttribute> getConfigurationAttributeByName(java.lang.String name)
                                                                 throws NoSuchAttributeException

Returns any configuration attributes by name across all types of configuration attributes.

Parameters:

name - The attribute name. Cannot be null. For User Defined Attributes the name refers to UDA's attributeGroupName.attributeName.

Returns:

The list of configuration attributes. It is possible that configuration attributes of different types share the same name. No order or grouping of attributes is specified. Immutable.

Throws:

NoSuchAttributeException - If the named configuration attribute is not found

isRoot

boolean isRoot()

Returns true if this is the root node of the runtime tree.

Returns:

true if this is the root node of the runtime tree.

false if this is not the root node of the runtime tree.

isDescendantOf

boolean isDescendantOf(IRuntimeNode ancestorNode)

Returns true if this is a descendant of the ancestorNode node. False otherwise.

Returns:

true if this is a descendant of the specified ancestor node.

false if this is not a descendant of the specified ancestor node.

isQuoteable

boolean isQuoteable()

Returns true if this node is quoteable. False otherwise.

Returns:

true if this node is quoteable.

false if this node is not quoteable

getAvailableEventCommands

java.util.Set getAvailableEventCommands()

Returns a list of commands that can be used in CXCommandEvent objects on this node to cause one or more Configurator Extensions to execute.

Returns:

the set of available commands.

hasCount

boolean hasCount()

Returns true if this node can have numeric value.

Used by Delta Manager.

Returns:

true if this node can have a numeric value.

false if this node cannot have a numeric value.

isUiVisible

boolean isUiVisible()

Returns true if this node appears as a selection in Ui. Note that a node with "isUiVisible" false will still be included in a "show all nodes" Ui.

Returns:

true if this node appears as a selection in UI.

false if this node does not appear as a selection in UI.

isPriceAble

boolean isPriceAble()

Indicates if the IRuntime node can support a price, not if the node currently has a price assigned.

Returns:

true if the node can have a price and supports IPrice.

See Also:

IPrice

isSupplementalOrPortNode

boolean isSupplementalOrPortNode()

Returns true if the IRuntimeNode represents supplemental node or port node.

Returns:

true if the node is supplemental node or port node.