Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-05

oracle.apps.fnd.applcore.dt.patterns.metadata.creator.common
Class TreeLevel

java.lang.Object
  extended by oracle.apps.fnd.applcore.dt.patterns.metadata.creator.common.TreeLevel

public class TreeLevel
extends java.lang.Object

Generic "level" in a DT tree.

Author:
David Groves <david.groves@oracle.com>

Constructor Summary
TreeLevel(oracle.adfdt.model.objects.DataControl dataControl, oracle.binding.meta.AccessorDefinition acc)
          Construct this level.
 
Method Summary
 java.lang.String[] getAllLevelAttributeNames()
          Obtain an array of all attribute names for this level, appropriate for starting a shuttle with.
 oracle.binding.meta.VariableDefinition[] getAttributes()
          Get the attributes for this level.
 java.lang.String getChildAccessorName()
          Get the child accessor name that was used to get here (out parents accessor to this).
 java.util.List<TreeLevel> getChildLevels()
          Get all levels below this one.
 oracle.binding.meta.AccessorDefinition getIndependentAccessor()
          Find and lazily cache an independent AccessorDefinition to a VO in the given DataControl, this AccessorDefinition cannot be a part of the tree (unless it is the root AccessorDefinition).
 java.util.List<oracle.binding.meta.AccessorDefinition> getIndependentAccessorChildVOs()
          Find and lazily cache the child VOs of the independent AccessorDefinition obtained via getIndependentAccessor().
 oracle.binding.meta.NamedDefinition getNamedDefinition()
          Get the accessor for this level.
 oracle.adfdt.model.objects.CtrlHierTypeBinding getNodeDefinition()
          Get the Node Defintion.
 java.lang.String getSelectedChildAccessorName()
          Get the selected child accessor name that was used to get here (out parents accessor to this).
 java.lang.String getSelectedFilterAttr()
          Get the selected filter attribute (from the UI).
 java.lang.String getSelectedFilterAttrValue()
          Get the selected filter attribute value (from the UI).
 java.lang.String[] getSelectedLevelAttributeNames()
          Get the selected attribute names after the user has selected them in the shuttle.
 oracle.jbo.dt.common.controls.ShuttleValue getShuttleValue()
          Get the shuttle value containing user selected _attributes for this level.
 java.lang.String getStructureFullName()
          Get the structure full name - usually the fully qualified VO name.
 java.lang.String getTargetIterator()
          Get the target Iterator for performing CRUD operations at this tree level.
 TreeModelProvider getTreeModelProvider()
          Get the tree Model Provider.
 boolean isFilteringEnabled()
          Is filterEnabled property set?
 void setFilteringEnabled(boolean filteringEnabled)
          Set the filterEnabled property (from the checkbox).
 void setNodeDefinition(oracle.adfdt.model.objects.CtrlHierTypeBinding nodeDefinition)
          Set a nodeDefinition for this Level.
 void setSelectedChildAccessorName(java.lang.String selectedChildAccessorName)
          Set the selected child accessor name that was used to get here (out parents accessor to this).
 void setSelectedFilterAttr(java.lang.String selectedFilterAttr)
          Set the selected filter attribute (from the UI).
 void setSelectedFilterAttrValue(java.lang.String selectedFilterAttrValue)
          Set the selected filter attribute value (from the UI).
 void setTargetIterator(java.lang.String targetIterator)
          Set the target Iterator for performing CRUD operations at this tree level.
 void setTreeModelProvider(TreeModelProvider treeModelProvider)
          Set the tree Model Provider.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TreeLevel

public TreeLevel(oracle.adfdt.model.objects.DataControl dataControl,
                 oracle.binding.meta.AccessorDefinition acc)
Construct this level.

Parameters:
dataControl - datacontrol.
acc - accessor for this level in the tree.
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getShuttleValue

public oracle.jbo.dt.common.controls.ShuttleValue getShuttleValue()
Get the shuttle value containing user selected _attributes for this level.

Returns:
shuttle value.

getAllLevelAttributeNames

public java.lang.String[] getAllLevelAttributeNames()
Obtain an array of all attribute names for this level, appropriate for starting a shuttle with.

Returns:
all attr names for this level.

getSelectedLevelAttributeNames

public java.lang.String[] getSelectedLevelAttributeNames()
Get the selected attribute names after the user has selected them in the shuttle.

Returns:
selected attribute names.

getChildLevels

public java.util.List<TreeLevel> getChildLevels()
Get all levels below this one.

Returns:
List of possible tree levels.

getChildAccessorName

public java.lang.String getChildAccessorName()
Get the child accessor name that was used to get here (out parents accessor to this).

Returns:
child accessor name.

getNamedDefinition

public oracle.binding.meta.NamedDefinition getNamedDefinition()
Get the accessor for this level.

Returns:
accessor.

setSelectedChildAccessorName

public void setSelectedChildAccessorName(java.lang.String selectedChildAccessorName)
Set the selected child accessor name that was used to get here (out parents accessor to this).

Parameters:
selectedChildAccessorName - accessor name.

getSelectedChildAccessorName

public java.lang.String getSelectedChildAccessorName()
Get the selected child accessor name that was used to get here (out parents accessor to this).

Returns:
accessor name.

getStructureFullName

public java.lang.String getStructureFullName()
Get the structure full name - usually the fully qualified VO name.

Returns:
structure full name

setFilteringEnabled

public void setFilteringEnabled(boolean filteringEnabled)
Set the filterEnabled property (from the checkbox).

Parameters:
filteringEnabled - checkbox value.

isFilteringEnabled

public boolean isFilteringEnabled()
Is filterEnabled property set?

Returns:
checkbox value

setSelectedFilterAttr

public void setSelectedFilterAttr(java.lang.String selectedFilterAttr)
Set the selected filter attribute (from the UI).

Parameters:
selectedFilterAttr - selected filter attribute

getSelectedFilterAttr

public java.lang.String getSelectedFilterAttr()
Get the selected filter attribute (from the UI).

Returns:
selected filter attribute.

setSelectedFilterAttrValue

public void setSelectedFilterAttrValue(java.lang.String selectedFilterAttrValue)
Set the selected filter attribute value (from the UI).

Parameters:
selectedFilterAttrValue - selected filter attribute value.

getSelectedFilterAttrValue

public java.lang.String getSelectedFilterAttrValue()
Get the selected filter attribute value (from the UI).

Returns:
selected filter attribute value.

setTargetIterator

public void setTargetIterator(java.lang.String targetIterator)
Set the target Iterator for performing CRUD operations at this tree level.

Parameters:
targetIterator - target Iterator.

getTargetIterator

public java.lang.String getTargetIterator()
Get the target Iterator for performing CRUD operations at this tree level.

Returns:
target Iterator.

getIndependentAccessor

public oracle.binding.meta.AccessorDefinition getIndependentAccessor()
Find and lazily cache an independent AccessorDefinition to a VO in the given DataControl, this AccessorDefinition cannot be a part of the tree (unless it is the root AccessorDefinition). The first such AccessorDefinition found will be returned.

Returns:
independent AccessorDefinition for this lavel, null if none found.

getIndependentAccessorChildVOs

public java.util.List<oracle.binding.meta.AccessorDefinition> getIndependentAccessorChildVOs()
Find and lazily cache the child VOs of the independent AccessorDefinition obtained via getIndependentAccessor(). Return an empty list if no independent accessor is available or there are no child VOs.

Returns:
list of child VOs, empty list if none available.

getAttributes

public oracle.binding.meta.VariableDefinition[] getAttributes()
Get the attributes for this level.

Returns:
jsr227 attributres.

setNodeDefinition

public void setNodeDefinition(oracle.adfdt.model.objects.CtrlHierTypeBinding nodeDefinition)
Set a nodeDefinition for this Level. This value is stored here for convenience only.

Parameters:
nodeDefinition - node Definition.

getNodeDefinition

public oracle.adfdt.model.objects.CtrlHierTypeBinding getNodeDefinition()
Get the Node Defintion.

Returns:
Node Defintion.

setTreeModelProvider

public void setTreeModelProvider(TreeModelProvider treeModelProvider)
Set the tree Model Provider.

Parameters:
treeModelProvider - tree model provider.

getTreeModelProvider

public TreeModelProvider getTreeModelProvider()
Get the tree Model Provider.

Returns:
tree Model Provider.

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-05

Copyright © 2012 Oracle. All Rights Reserved.