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

E10653-01

oracle.adf.model.utils
Class StandardOperationDef

java.lang.Object
  extended by oracle.adf.model.utils.StandardOperationDef
All Implemented Interfaces:
Definition, NamedDefinition, OperationDefinition

public class StandardOperationDef
extends java.lang.Object
implements OperationDefinition

Definition for standard operations


Field Summary
 
Fields inherited from interface oracle.adf.model.meta.OperationDefinition
ACTION_BINDING_CONTAINER_EXECUTE, ACTION_BINDING_CONTAINER_FIND, ACTION_COMMIT_TRANSACTION, ACTION_CREATE_INSERT_ROW, ACTION_CREATE_ROW, ACTION_CREATE_TEMP_WITH_PARAMS, ACTION_CREATE_WITH_PARAMS, ACTION_CUSTOM_EXECUTES_START, ACTION_EXECUTE, ACTION_EXECUTE_WITH_PARAMS, ACTION_FIND, ACTION_FIRST, ACTION_INVOKE_METHOD, ACTION_ITERATOR_BINDING_EXECUTE, ACTION_ITERATOR_BINDING_FIND, ACTION_LAST, ACTION_NEXT, ACTION_NEXT_SET, ACTION_PREVIOUS, ACTION_PREVIOUS_SET, ACTION_REMOVE_CURRENT_ROW, ACTION_REMOVEROW_WITH_KEY, ACTION_RESET, ACTION_RESET_STATE, ACTION_ROLLBACK_TRANSACTION, ACTION_SETCURRENTROW_WITH_KEY, ACTION_SETCURRENTROW_WITH_KEYVALUE
 
Fields inherited from interface oracle.binding.meta.OperationDefinition
CUSTOM
 
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
StandardOperationDef(int id)
           
StandardOperationDef(int id, java.lang.String name)
           
 
Method Summary
 BaseValueObjectDefinition addParameter(java.lang.String name, java.lang.String javaType, java.lang.String fullName)
          Add a parameter to the standard operation.
 DataControlDefinition getDataControlDefinition()
          Retrieves the DataControlDefinition that this Operation belongs to.
static java.lang.String getDefaultKeyForId(int nId)
           
static java.lang.String getDefaultLabelForId(int nId)
           
static java.lang.String getDefaultNameForId(int nId)
           
 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.
static int getOperationCodeFromId(java.lang.String sId)
           
 int getOperationId()
          Retrieves the operation id of the operation.
 DefinitionContainer getOperationParameters()
          Retrieves the metadata of the parameters of the operation.
 OperationReturnDefinition getOperationReturnType()
          Retrieves the metadata of the return type of the operation.
 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.
 boolean isStatic()
           
 void setDataControlDefinition(DataControlDefinition dataControlDefinition)
          Set the DataControlDefinition to be returned in the interface method getDataControlDefinition.
 void setFullName(java.lang.String fullName)
          The fullname to be returned by the getFullName() interface method can be overriden by the value set by this method.
 void setName(java.lang.String name)
          The name to be returned by the getName() interface method, should the default one used in the constructor need to be overwritten.
 void setOperationReturn(OperationReturnDefinition operationReturnDef)
          Set the return type of the standard operation.
 void setParent(StructureDefinition parent)
          Set the parent definition to be returned in the interface method getParent.
 void setProperty(java.lang.String propertyName, java.lang.Object propertyValue)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardOperationDef

public StandardOperationDef(int id,
                            java.lang.String name)
Parameters:
id - The action id for the action. See oracle.adf.model.meta.OperationDefinition for list.
name - Name (key) for the action. This name should not be localized.

StandardOperationDef

public StandardOperationDef(int id)
Method Detail

getOperationCodeFromId

public static int getOperationCodeFromId(java.lang.String sId)

getDefaultNameForId

public static java.lang.String getDefaultNameForId(int nId)

getDefaultKeyForId

public static java.lang.String getDefaultKeyForId(int nId)

getDefaultLabelForId

public static java.lang.String getDefaultLabelForId(int nId)

getOperationParameters

public DefinitionContainer getOperationParameters()
Description copied from interface: OperationDefinition
Retrieves the metadata of the parameters of the operation.

Specified by:
getOperationParameters in interface OperationDefinition
Returns:
A DefinitionContainer containing the metadata of all parameters in the operation. There should be one ParameterDefinition object in the DefinitionContainer containing metadata for each parameter. If there are no paremeters, or if the operation is a common operation, an instance of EmptyDefinitionContainer should be returned.
See Also:
ParameterDefinition, EmptyDefinitionContainer

getOperationReturnType

public OperationReturnDefinition getOperationReturnType()
Description copied from interface: OperationDefinition
Retrieves the metadata of the return type of the operation.

Specified by:
getOperationReturnType in interface OperationDefinition
Returns:
Metadata of the return type of the operation. If the operation does not return any value, or if it is a common operation, null can be returned.

getOperationId

public int getOperationId()
Description copied from interface: OperationDefinition
Retrieves the operation id of the operation.

Specified by:
getOperationId in interface OperationDefinition
Returns:
The id of the operation, or CUSTOM if this is a custom operation.

setDataControlDefinition

public void setDataControlDefinition(DataControlDefinition dataControlDefinition)
Set the DataControlDefinition to be returned in the interface method getDataControlDefinition.

Parameters:
dataControlDefinition - The DataControlDefinition that this standard operation belongs to.

getDataControlDefinition

public DataControlDefinition getDataControlDefinition()
Description copied from interface: OperationDefinition
Retrieves the DataControlDefinition that this Operation belongs to.

Specified by:
getDataControlDefinition in interface OperationDefinition
Returns:
The DataControlDefinition that this Operation belongs to.

setParent

public void setParent(StructureDefinition parent)
Set the parent definition to be returned in the interface method getParent.

Parameters:
parent - The parent definition of this action definition.

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

setName

public void setName(java.lang.String name)
The name to be returned by the getName() interface method, should the default one used in the constructor need to be overwritten.

Parameters:
name - The name to be returned when getName() is called.

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.

addParameter

public BaseValueObjectDefinition addParameter(java.lang.String name,
                                              java.lang.String javaType,
                                              java.lang.String fullName)
Add a parameter to the standard operation. For use by adding parameter for the "ExecuteWithParam" operation.

Parameters:
name - Name of the parameter.
javaType - A String containing the Java type of the parameter.
fullName - full name of the parameter.
Returns:
The parameter definition created and added to the list of parameter definitions of this operation definition.

setOperationReturn

public void setOperationReturn(OperationReturnDefinition operationReturnDef)
Set the return type of the standard operation.

Parameters:
operationReturnDef - The operation return definition to be returned when getOperationReturnType() is called.

setFullName

public void setFullName(java.lang.String fullName)
The fullname to be returned by the getFullName() interface method can be overriden by the value set by this method.

Parameters:
fullName - The full name to be returned when getFullName() is called.

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.

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.Object propertyValue)

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.

isStatic

public boolean isStatic()
Specified by:
isStatic in interface OperationDefinition
Returns:
true if this operation definition represents a static method.

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.