oracle.adf.model.meta.bc4j

Class BC4JDataControlStructureDefinition

java.lang.Object

oracle.adf.model.meta.bc4j.BC4JDataControlStructureDefinition

All Implemented Interfaces:

Definition, NamedDefinition, StructureDefinition

public class BC4JDataControlStructureDefinition
extends java.lang.Object
implements StructureDefinition

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

Constructor Summary

Constructors

Constructor and Description
BC4JDataControlStructureDefinition(BC4JDataControlDefinition datacontrolDefinition)

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.
Definition	getDefinitionParent() Returns the parent of this metadata definition, which is the Definition that contains this Definition.
int	getDefinitionType() Retrieves the type of this definition.
java.lang.String	getFullName() Returns the full name of this Definition, which includes the name of any parent objects.
java.lang.String	getName() Returns the name of this Definition.
DefinitionContainer	getOperationDefinitions() Returns the metadata about the operations in this structure.
java.util.Hashtable	getProperties() Gets the table of properties.
java.lang.Object	getProperty(java.lang.String propertyName) Retrieves the value of a property with the given name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BC4JDataControlStructureDefinition

public BC4JDataControlStructureDefinition(BC4JDataControlDefinition datacontrolDefinition)

Method Detail

getAttributeDefinitions

public DefinitionContainer getAttributeDefinitions()

Description copied from interface: StructureDefinition

Returns the metadata about the attributes in this structure.

Specified by:

getAttributeDefinitions in interface StructureDefinition

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

public DefinitionContainer getAccessorDefinitions()

Description copied from interface: StructureDefinition

Returns the metadata about the accessors in this structure.

Specified by:

getAccessorDefinitions in interface StructureDefinition

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

public DefinitionContainer getOperationDefinitions()

Description copied from interface: StructureDefinition

Returns the metadata about the operations in this structure.

Specified by:

getOperationDefinitions in interface StructureDefinition

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

public DefinitionContainer getConstructorOperationDefinitions()

Description copied from interface: StructureDefinition

Returns the metadata about the constructor operations in this structure.

Specified by:

getConstructorOperationDefinitions in interface StructureDefinition

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

public DefinitionContainer getCriteriaDefinitions()

Description copied from interface: StructureDefinition

Returns the metadata about the criteria in this structure.

Specified by:

getCriteriaDefinitions in interface StructureDefinition

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

public DataControlDefinition getDataControlDefinition()

Description copied from interface: StructureDefinition

Retrieves the DataControlDefinition that this Structure belongs to.

Specified by:

getDataControlDefinition in interface StructureDefinition

Returns:

The DataControlDefinition that this Structure belongs to.

getDefinitionParent

public Definition getDefinitionParent()

Description copied from interface: NamedDefinition

Returns the parent of this metadata definition, which is the Definition that contains this Definition. For example, the parent of an AttributeDefinition could be a StructureDefinition if the attribute is contained in the structure.

Specified by:

getDefinitionParent in interface NamedDefinition

Returns:

The parent Definition

getName

public java.lang.String getName()

Description copied from interface: NamedDefinition

Returns the name of this Definition.

Specified by:

getName in interface NamedDefinition

Returns:

Name of this Definition.

getFullName

public java.lang.String getFullName()

Description copied from interface: NamedDefinition

Returns the full name of this Definition, which includes the name of any parent objects. The full name should reflect the runtime nesting level.

Specified by:

getFullName in interface NamedDefinition

Returns:

Full name of this Definition.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Description copied from interface: NamedDefinition

Retrieves the value of a property with the given name. Properties can be used for UI hints such as display width and height.

Specified by:

getProperty in interface NamedDefinition

Parameters:

propertyName - Name of the property to be retrieved.

Returns:

Value of the property with the given property name.

getProperties

public java.util.Hashtable getProperties()

Description copied from interface: NamedDefinition

Gets the table of properties. This returns a hashtable to ensure any modification done by caller would be synchronized. Note that this API has not been added to the JSR yet.

Specified by:

getProperties in interface NamedDefinition

Returns:

a hashtable of properties.

getDefinitionType

public int getDefinitionType()

Description copied from interface: Definition

Retrieves the type of this definition. It can be one of the TYPE_* constants defined in this class. This is useful to find out the actual type of the Definition without doing an instanceof operations.

Specified by:

getDefinitionType in interface Definition

Returns:

The type of definition that this Definition implementation class implements.