oracle.jbo
Interface StructureDef

All Known Subinterfaces:

ViewObject, ViewObjectDynAttr

All Known Implementing Classes:

DomainStructureDef, EntityCache, EntityDefImpl, JUCtrlValueBinding, RowDef, StructureDefHelper, StructureDefImpl, ViewDefImpl, ViewObjectImpl, 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	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

public java.lang.String getName()

Returns the structure's name (short form).

Returns:

name of the structure.

getFullName

public java.lang.String getFullName()

Returns the structure's fully qualified name.

Returns:

fully qualified name of the structure.

getDefName

public 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

public 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

public AttributeDef[] getAttributeDefs()

Gets the defined attributes.

Returns:

an array of attribute definitions.

getAttributeCount

public int getAttributeCount()

Returns the number of defined attributes.

Returns:

the number of attributes.

findAttributeDef

public 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

public 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

public 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

public 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.