oracle.binding.meta

Interface StructureDefinition

All Superinterfaces:

Definition, NamedDefinition

All Known Subinterfaces:

EditableStructureDefinition

All Known Implementing Classes:

BC4JDataControlStructureDefinition, BC4JViewObjectStructureDefinition, DescribeStructureDef, EntityStructureDefinitionImpl, ODataStructureDef, StructureDef, StructureDefHolder, StructureDefinitionImpl

public interface StructureDefinition
extends NamedDefinition

Contains metadata for a structure such as a datacontrol, an accessor, or a parameter.

Field Summary

Fields inherited from interface oracle.binding.meta.Definition

TYPE_ACCESSOR, TYPE_ATTRIBUTE, TYPE_CRITERIA, TYPE_CRITERIA_ITEM, TYPE_CRITERIA_OPERATOR, TYPE_CRITERIA_ROW, TYPE_DATACONTROL, TYPE_DEFINITION, TYPE_DEFINITIONCONTEXT, TYPE_NAMED, TYPE_OPERATION, TYPE_OPERATIONRETURN, TYPE_PARAMETER, TYPE_STRUCTURE, TYPE_VARIABLE

Method Summary

Modifier and Type	Method and Description
DefinitionContainer	getAccessorDefinitions() Returns the metadata about the accessors in this structure.
DefinitionContainer	getAttributeDefinitions() Returns the metadata about the attributes in this structure.
DefinitionContainer	getConstructorOperationDefinitions() Returns the metadata about the constructor operations in this structure.
DefinitionContainer	getCriteriaDefinitions() Returns the metadata about the criteria in this structure.
DataControlDefinition	getDataControlDefinition() Retrieves the DataControlDefinition that this Structure belongs to.
DefinitionContainer	getOperationDefinitions() Returns the metadata about the operations in this structure.

Methods inherited from interface oracle.binding.meta.NamedDefinition

getDefinitionParent, getFullName, getName, getProperties, getProperty

Methods inherited from interface oracle.binding.meta.Definition

getDefinitionType

Method Detail

getAttributeDefinitions

DefinitionContainer getAttributeDefinitions()

Returns the metadata about the attributes in this structure.

Returns:

A DefinitionContainer containing the metadata of all attributes in the structure. There should be one AttributeDefinition object in the DefinitionContainer containing metadata for each attribute. If there are no attribute, an instance of EmptyDefinitionContainer should be returned.

See Also:

EmptyDefinitionContainer, AttributeDefinition

getAccessorDefinitions

DefinitionContainer getAccessorDefinitions()

Returns the metadata about the accessors in this structure.

Returns:

A DefinitionContainer containing the metadata of all acessors in the structure. There should be one AccessorDefinition object in the DefinitionContainer containing metadata for each accessor. If there are no accessor, an instance of EmptyDefinitionContainer should be returned.

See Also:

EmptyDefinitionContainer, AccessorDefinition

getOperationDefinitions

DefinitionContainer getOperationDefinitions()

Returns the metadata about the operations in this structure.

Returns:

A DefinitionContainer containing the metadata of all operations in the structure. There should be one OperationDefinition object in the DefinitionContainer containing metadata for each operation. If there are no operation, an instance of EmptyDefinitionContainer should be returned.

See Also:

EmptyDefinitionContainer, OperationDefinition

getConstructorOperationDefinitions

DefinitionContainer getConstructorOperationDefinitions()

Returns the metadata about the constructor operations in this structure.

Returns:

A DefinitionContainer containing the metadata of all constructor operations in the structure. There should be one OperationDefinition object in the DefinitionContainer containing metadata for each operation. If there are no operation, an instance of EmptyDefinitionContainer should be returned.

See Also:

EmptyDefinitionContainer, OperationDefinition

getCriteriaDefinitions

DefinitionContainer getCriteriaDefinitions()

Returns the metadata about the criteria in this structure.

Returns:

A DefinitionContainer containing the metadata of all criteria in the structure. There should be one Criteria definition object in the DefinitionContainer containing metadata for each criteria. If there are no criteria, an instance of EmptyDefinitionContainer should be returned.

See Also:

EmptyDefinitionContainer, OperationDefinition

getDataControlDefinition

DataControlDefinition getDataControlDefinition()

Retrieves the DataControlDefinition that this Structure belongs to.

Returns:

The DataControlDefinition that this Structure belongs to.