oracle.owb.processflow
Interface ProcessActivityParameter

All Superinterfaces:

Attribute, Datatyped, Extensible, OWBNamedObject, Parameter, ProcessData, PropertyOwner

public interface ProcessActivityParameter

extends ProcessData, Parameter

A ProcessActivityParameter Interface that encapsule an object that can own several Parameter instances to create a signature.

Field Summary

static int	DIRECTION_INPUT Constant used to specify direction of a parameter.
static int	DIRECTION_INPUT_OUTPUT Constant used to specify direction of a parameter.
static int	DIRECTION_OUTPUT Constant used to specify direction of a parameter.

Method Summary

void	bindToStartParameter(ProcessActivityParameter param) Ensure that this parameter receives its value from one of the parameters of the process itself, and this enables passing parameters of the process through to the activities, thus parameterizing the process flow.
ProcessActivityParameter	getBoundParameter() Get the parameter that this parameter is bound to.
Datatype	getDatatype() Retrieve the data type code of the parameter, based on the data type code defined in DataType.
int	getDirection() Retrieve the direction of the parameter, one of IN, OUT or INOUT in the signature of the owning function or mapping.
ProcessActivityParameterOwner	getOwner() Retrieve the owner of this activity parameter, which can be a process or an activity.
void	setDatatype(java.lang.String dtype) Set the data type code of the parameter, based on the data type code defined in DataType.

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.foundation.type.Datatyped

getLength, getPrecision, getScale, isPrecisionOmitted, setDatatype, setLength, setPrecision, setPrecisionOmitted, setScale

Methods inherited from interface oracle.owb.transformation.Parameter

getDefaultValue, getFunction, getPosition, isInput, isOutput, setDefaultValue, setInput, setOutput

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Field Detail

DIRECTION_INPUT

public static final int DIRECTION_INPUT

Constant used to specify direction of a parameter.

DIRECTION_OUTPUT

public static final int DIRECTION_OUTPUT

Constant used to specify direction of a parameter.

DIRECTION_INPUT_OUTPUT

public static final int DIRECTION_INPUT_OUTPUT

Constant used to specify direction of a parameter.

Method Detail

getOwner

public ProcessActivityParameterOwner getOwner()
                                       throws OWBException

Retrieve the owner of this activity parameter, which can be a process or an activity.

Returns:

owner of ProcessActivityParameter, ProcessActivityParameterOwner object.

Throws:

OWBException - if any internal error is encountered.

getDirection

public int getDirection()
                 throws OWBException

Retrieve the direction of the parameter, one of IN, OUT or INOUT in the signature of the owning function or mapping.

Returns:

the direction of this parameter in the list of parameters.

Throws:

OWBException - if any internal error is encountered.

getDatatype

public Datatype getDatatype()
                     throws OWBException

Retrieve the data type code of the parameter, based on the data type code defined in DataType.

Specified by:

getDatatype in interface Datatyped

Returns:

the datatype of this parameter in the list of parameters.

Throws:

OWBException - if any internal error is encountered.

See Also:

setDatatype(java.lang.String)

setDatatype

public void setDatatype(java.lang.String dtype)
                 throws OWBException

Set the data type code of the parameter, based on the data type code defined in DataType.

Parameters:

dtype - the datatype of this parameter in the list of parameters.

Returns:

the datatype of this parameter in the list of parameters.

Throws:

OWBException - if any internal error is encountered.

See Also:

getDatatype()

bindToStartParameter

public void bindToStartParameter(ProcessActivityParameter param)
                          throws OWBException

Ensure that this parameter receives its value from one of the parameters of the process itself, and this enables passing parameters of the process through to the activities, thus parameterizing the process flow.

Parameters:

param - A ProcessActivityParameter that is a process parameter which means it is a parameter on the start activity of the process flow. If a null parameter is passed in the parameter is unbound if it was previously bound else no affect.

Throws:

OWBException - is thrown if the parameter passed in is not a parameter owned by the start activity of the process flow.

getBoundParameter

public ProcessActivityParameter getBoundParameter()
                                           throws OWBException

Get the parameter that this parameter is bound to.

Returns:

The bound parameter or null if it is unbound.

Throws:

OWBException - if any internal error is encountered.