oracle.adf.controller.metadata.model

Interface MethodCall

All Superinterfaces:

Activity, AdfcNode, IdHolder, NodeHolder, UIInfo

public interface MethodCall
extends Activity

Represents metadata for a method call activity. For example:

  <method-call>
    <method>#{pageFlowScope.taxService.calculateSalesTax}</method>
    <parameter>
      <class>java.lang.Double</class>
      <value>#{pageFlowScope.shoppingCart.totalPurchasePrice}</value>
    </parameter>
      <outcome>
      <to-string/>
    </outcome>
  </method-call>
 

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addParameter(Parameter parameter) Adds a new parameter to this method call.
boolean	convertToString() Indicates whether a value returned from a method should be converted to Java String.
java.lang.String	getDefaultOutcome() Retrieves a constant representing the default outcome of this method.
java.lang.String	getMethod() Retrieves a method EL expression representing this method call.
java.util.List<Parameter>	getParameters() Retrieves the List of input parameters to this method.
java.lang.String	getReturnValue() The EL expression used to store method's return value.
boolean	removeParameter(Parameter parameter) Removes specified parameter from a method call definition.
boolean	setConvertToString(boolean convertToString) If convertToString is true, and a method call has a fixed outcome defined, the fixed outcome will be removed and to-string element will be added.
boolean	setDefaultOutcome(java.lang.String defaultOutcome) Adds a literal outcome that will be returned when this method call activity executes.
boolean	setMethod(java.lang.String method) Sets a method expression for this method call activity.
boolean	setReturnValue(java.lang.String returnValue) Sets a return value for this method call activity.

Methods inherited from interface oracle.adf.controller.metadata.model.Activity

getId, getMetadataObject, getType

Methods inherited from interface oracle.adf.controller.metadata.model.UIInfo

getDescription, getDisplayName, getLargeIcon, getSmallIcon, getUIInfo, setDescription, setDisplayName, setLargeIcon, setSmallIcon

Methods inherited from interface oracle.adf.controller.metadata.model.AdfcNode

getParsingContext, validate

Methods inherited from interface oracle.adf.controller.metadata.model.IdHolder

getIdAttribute, setIdAttribute

Methods inherited from interface oracle.adf.controller.metadata.model.NodeHolder

getNode

Method Detail

getMethod

java.lang.String getMethod()

Retrieves a method EL expression representing this method call. For example,

#{pageFlowScope.taxService.calculateSalesTax

Returns:

String representation of an EL expression

getParameters

java.util.List<Parameter> getParameters()

Retrieves the List of input parameters to this method.

Returns:

input parameter list

convertToString

boolean convertToString()

Indicates whether a value returned from a method should be converted to Java String.

Returns:

true, if #toString() should be called on the result when setting the outcome of this method call activity.

getDefaultOutcome

java.lang.String getDefaultOutcome()

Retrieves a constant representing the default outcome of this method. For example, "success" or "failure".

Returns:

String logical outcome of this method call activity, or null, if no default outcome specified.

getReturnValue

java.lang.String getReturnValue()

The EL expression used to store method's return value.

Returns:

String representation of an EL expression, or null.

setConvertToString

boolean setConvertToString(boolean convertToString)

If convertToString is true, and a method call has a fixed outcome defined, the fixed outcome will be removed and to-string element will be added. If convertToString is false, this is a noop. Use setDefaultOutcome(java.lang.String) instead.

Parameters:

convertToString -

Returns:

true, if to-string was successfully added. False otherwise.

setDefaultOutcome

boolean setDefaultOutcome(java.lang.String defaultOutcome)

Adds a literal outcome that will be returned when this method call activity executes. If a to-string outcome is specified, it will be removed. If defaultOutcome is a null or empty String, no action will be taken.

Parameters:

defaultOutcome -

Returns:

true, if fixed outcome was successfully added, false otherwis

setMethod

boolean setMethod(java.lang.String method)

Sets a method expression for this method call activity.

Parameters:

method - the EL expression representing this method call, must not be null

Returns:

true, if method was successfully set, false otherwise

setReturnValue

boolean setReturnValue(java.lang.String returnValue)

Sets a return value for this method call activity. If value is null, return value element will be removed from the activity definition.

Parameters:

returnValue - the return value to set

Returns:

true, if return value was successfully set or removed, false otherwise

addParameter

boolean addParameter(Parameter parameter)

Adds a new parameter to this method call.

Parameters:

parameter - a new method parameter, must not be null

Returns:

true, if parameter was successfully added, false otherwise

removeParameter

boolean removeParameter(Parameter parameter)

Removes specified parameter from a method call definition. Parameter must not be null, and must exists in the method call definition.

Parameters:

parameter - method parameter to be removed

Returns:

true, if parameter was successfully added, false otherwise