Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.0.0)

E10653-01

oracle.jbo
Interface StructureDef

All Known Subinterfaces:
ViewDef, ViewObject, ViewObjectDynAttr
All Known Implementing Classes:
AccessorDefImpl, ClientViewDef, CmrAccessorViewImpl, DCDataVO, DomainStructureDef, DSEntityCache, DSViewObjectImpl, EntityCache, EntityCacheOverRowSet, EntityDefImpl, EntityDefOverRowSet, EntityFacadeCollImpl, FinderViewImpl, JUButtonBinding, JUButtonGroupBinding, JUComboBoxBinding, JUCtrlAdaptRangeBinding, JUCtrlAttrsBinding, JUCtrlBoolBinding, JUCtrlHierBinding, JUCtrlHierNodeBinding, JUCtrlListBinding, JUCtrlParameterBinding, JUCtrlRangeBinding, JUCtrlValueBinding, JUDefaultControlBinding, JUFormattedTextFieldBinding, JULabelBinding, JUListSingleSelBinding, JULovButtonBinding, JUProgressBarAttrBinding, JUScrollBarAttrBinding, JUSliderAttrBinding, JUSpinnerBinding, JUTableBinding, JUTextFieldBinding, JUTreeBinding, JUTreeNodeBinding, JUTreeTableBinding, MethodAccessorDefImpl, MethodAccessorDefImpl.ParameterInfoImpl, PlaceholderVOImpl, RowDef, ServerViewObjectSubclassDef, StructureDefHelper, StructureDefImpl, StructureDefImpl, ViewDefImpl, ViewObjectImpl, ViewObjectOnRowSets, ViewObjectSubclassDef, ViewUsageImpl, WSViewObjectImpl

public interface StructureDef

Imlemented by classes that access a View Object's or Entity Object's metadata.

Since:
JDeveloper 3.0
See Also:
ApplicationModule, RowSet

Method Summary
 AttributeDef findAttributeDef(java.lang.String name)
          Gets an attribute definition, given its name.
 int getAttributeCount()
          Returns the number of defined attributes.
 AttributeDef getAttributeDef(int index)
          Gets an attribute definition, given its index.
 AttributeDef[] getAttributeDefs()
          Gets the defined attributes.
 int getAttributeIndexOf(java.lang.String name)
          Finds the index (0-based) of the named attribute.
 java.lang.String getColumnNameForQuery(int index)
           
 java.lang.String getDefFullName()
          Returns the fully qualified name of the structure's base definition.
 java.lang.String getDefName()
          Returns the structure's base definition name (short form).
 java.lang.String getFullName()
          Returns the structure's fully qualified name.
 java.lang.String getName()
          Returns the structure's name (short form).
 AttributeDef lookupAttributeDef(java.lang.String name)
          Gets an attribute definition, given its name.
 

Method Detail

getName

java.lang.String getName()
Returns the structure's name (short form).

Returns:
name of the structure.

getFullName

java.lang.String getFullName()
Returns the structure's fully qualified name.

Returns:
fully qualified name of the structure.

getDefName

java.lang.String getDefName()
Returns the structure's base definition name (short form). Note that, in some cases, a StructureDef may have an instance name and definition name. For example, for a View Object, getName() returns the VO's instance name and getDefName() returns the View definition's name.

Returns:
name of the structure's base definition.

getDefFullName

java.lang.String getDefFullName()
Returns the fully qualified name of the structure's base definition. Note that, in some cases, a StructureDef may have an instance name and definition name. For example, for a View Object, getFullName() returns the VO's full instance name and getDefFullName() returns the View definition's full name.

Returns:
fully qualified name of the structure's base definition.

getAttributeDefs

AttributeDef[] getAttributeDefs()
Gets the defined attributes.

Returns:
an array of attribute definitions.

getAttributeCount

int getAttributeCount()
Returns the number of defined attributes.

Returns:
the number of attributes.

findAttributeDef

AttributeDef findAttributeDef(java.lang.String name)
Gets an attribute definition, given its name.

Parameters:
name - the name of an AttributeDef.
Returns:
an attribute definition
Throws:
NoDefException - - if the attribute is not found.

lookupAttributeDef

AttributeDef lookupAttributeDef(java.lang.String name)
Gets an attribute definition, given its name.

Parameters:
name - the name of an AttributeDef.
Returns:
an attribute definition if found, null otherwise

getAttributeDef

AttributeDef getAttributeDef(int index)
Gets an attribute definition, given its index.

Parameters:
index - the index of an AttributeDef, where the leftmost attribute has index zero.
Returns:
an attribute definition.

getAttributeIndexOf

int getAttributeIndexOf(java.lang.String name)
Finds the index (0-based) of the named attribute.

Parameters:
name - the attribute's name.
Returns:
an integer in the range 0 to getAttributeCount() - 1. If the named attribute is not found, it returns -1.

getColumnNameForQuery

java.lang.String getColumnNameForQuery(int index)

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.0.0)

E10653-01

Copyright © 1997, 2008, Oracle. All rights reserved.