oracle.adf.model.adapter.dataformat

Class MethodReturnDef

java.lang.Object

oracle.adf.model.adapter.dataformat.ParamDef

oracle.adf.model.adapter.dataformat.MethodReturnDef

All Implemented Interfaces:

AccessorDefinition, AccessorParameterDefinition, AttributeDefinition, Definition, NamedDefinition, OperationReturnDefinition, ParameterDefinition, VariableDefinition

public class MethodReturnDef
extends ParamDef
implements OperationReturnDefinition, AccessorDefinition

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
MethodReturnDef(java.lang.String name, OperationDefinition parent, java.lang.String javaType, java.lang.String elementJavaType)
MethodReturnDef(java.lang.String name, OperationDefinition parent, java.lang.String javaType, java.lang.String elementName, java.lang.String elementJavaType)
MethodReturnDef(java.lang.String name, java.lang.String javaType, OperationDefinition parent, boolean isCollection)
MethodReturnDef(java.lang.String name, StructureDefinition def, OperationDefinition parent, boolean isCollection)
MethodReturnDef(java.lang.String name, StructureDefinition def, OperationDefinition parent, boolean isCollection, boolean isScalarCollection)

Method Summary

Modifier and Type	Method and Description
StructureDefinition	getCollectionStructure() Retrieves the metadata of the collection itself.
int	getDefinitionType() Retrieves the type of this definition.
AccessorDefinition	getParentAccessor() Retrieves the AccessorDefinition of the parent accessor.
void	setCollectionStructure(StructureDefinition def) Set the structure definition for the collection if the return is a collection.
void	setParentAccessor(AccessorDefinition parentAccessor)

Methods inherited from class oracle.adf.model.adapter.dataformat.ParamDef

getDataControlDefinition, getDefinitionParent, getFullName, getJavaTypeString, getName, getProperties, getProperty, getSourceTypeString, getStructure, isAccessor, isCollection, isKey, isReadOnly, isScalarCollection, setParent, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.binding.meta.ParameterDefinition

isAccessor

Methods inherited from interface oracle.binding.meta.AttributeDefinition

getSourceTypeString, isKey, isReadOnly

Methods inherited from interface oracle.binding.meta.VariableDefinition

getDataControlDefinition, getJavaTypeString

Methods inherited from interface oracle.binding.meta.NamedDefinition

getDefinitionParent, getFullName, getName, getProperties, getProperty

Methods inherited from interface oracle.binding.meta.AccessorDefinition

getStructure, isCollection, isScalarCollection

Constructor Detail

MethodReturnDef

public MethodReturnDef(java.lang.String name,
                       java.lang.String javaType,
                       OperationDefinition parent,
                       boolean isCollection)

MethodReturnDef

public MethodReturnDef(java.lang.String name,
                       OperationDefinition parent,
                       java.lang.String javaType,
                       java.lang.String elementJavaType)

MethodReturnDef

public MethodReturnDef(java.lang.String name,
                       OperationDefinition parent,
                       java.lang.String javaType,
                       java.lang.String elementName,
                       java.lang.String elementJavaType)

MethodReturnDef

public MethodReturnDef(java.lang.String name,
                       StructureDefinition def,
                       OperationDefinition parent,
                       boolean isCollection)

MethodReturnDef

public MethodReturnDef(java.lang.String name,
                       StructureDefinition def,
                       OperationDefinition parent,
                       boolean isCollection,
                       boolean isScalarCollection)

Method Detail

getCollectionStructure

public StructureDefinition getCollectionStructure()

Description copied from interface: AccessorDefinition

Retrieves the metadata of the collection itself. It is possible that the collection itself has operations defined, such as if the collection is a class that implements a java.util.Collection interface and contains methods for searching through its elements. Please note that this is different from the getStructure API, which returns the metadata of the collection elements.

Specified by:

getCollectionStructure in interface AccessorDefinition

Overrides:

getCollectionStructure in class ParamDef

Returns:

The metadata describing the structure of the collection, or null if there is none available for the collection.

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

Overrides:

getDefinitionType in class ParamDef

Returns:

The type of definition that this Definition implementation class implements.

getParentAccessor

public AccessorDefinition getParentAccessor()

Description copied from interface: AccessorDefinition

Retrieves the AccessorDefinition of the parent accessor. A parent accessor is the accessor from which this accessor is obtained from. For example, we have a Dept structure, which contains an accessor called emps that returns a collection of Employee. Each Employee structure in turn contains an accessor called address that returns a structured type Address. The parent accessor of address would be the accessor emps in the Dept structure.

Specified by:

getParentAccessor in interface AccessorDefinition

Overrides:

getParentAccessor in class ParamDef

Returns:

The definition of the parent accessor.

setCollectionStructure

public void setCollectionStructure(StructureDefinition def)

Set the structure definition for the collection if the return is a collection. Collection structures usually contain methods applicable for the collection.

setParentAccessor

public void setParentAccessor(AccessorDefinition parentAccessor)