oracle.owb.processflow
Interface ProcessActivityParameterOwner

All Superinterfaces:

OWBNamedObject

All Known Subinterfaces:

Activity, BaseProcess, ProcessFlow, SubProcess

public interface ProcessActivityParameterOwner

extends OWBNamedObject

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

Method Summary

ProcessActivityParameter	createParameter(java.lang.String name) Creates a process activity parameter with a specfied name and direction.
ProcessActivityParameter	createParameter(java.lang.String name, int direction) Creates a process activity parameter with a specfied name and direction.
ProcessActivityParameter	createParameter(java.lang.String name, int direction, boolean isFinal) Creates a process activity parameter with a specfied name, direction and Boolean flag.
ProcessActivityParameter	findParameter(java.lang.String name) Finds the Parameter of ProcessFlow or Activity.
ProcessActivityParameter[]	getParameters() gets the array of Parameters of ProcessFlow or Activity.
ProcessActivityParameter[]	getParameters(int direction) gets the array of Parameters of ProcessFlow or Activity.
int	getPosition() Retrive the position of the parameter in the signature of the owning function or mapping.
void	setPosition(int position) Set the position of the parameter in the signature of the owning function or mapping.

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

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

Method Detail

createParameter

public ProcessActivityParameter createParameter(java.lang.String name)
                                         throws NameSpaceException,
                                                InvalidFormatException,
                                                oracle.owb.processflow.WBProcessInvalidOperationException,
                                                OWBException

Creates a process activity parameter with a specfied name and direction.

Parameters:

name - The name with which to create the parameter

Returns:

The newly create activity parameter.

Throws:

NameSpaceException - if Process Flow Parameter name is not unique.

InvalidFormatException - if the desired name does not satisfy the format requirements.

oracle.owb.processflow.WBProcessInvalidOperationException - if the type of Parameter is one that cannot be created by a user.

OWBException - if any internal error is encountered.

createParameter

public ProcessActivityParameter createParameter(java.lang.String name,
                                                int direction)
                                         throws NameSpaceException,
                                                InvalidFormatException,
                                                oracle.owb.processflow.WBProcessInvalidOperationException,
                                                OWBException

Creates a process activity parameter with a specfied name and direction.

Parameters:

name - The name with which to create the parameter

direction - The direction of the parameter, one of IN, OUT or INOUT

• ProcessActivityParameter.DIRECTION_INPUT
• ProcessActivityParameter.DIRECTION_OUTPUT
• ProcessActivityParameter.DIRECTION_INPUT_OUTPUT

Returns:

The newly create activity parameter.

Throws:

NameSpaceException - if Process Flow Parameter name is not unique.

InvalidFormatException - if the desired name does not satisfy the format requirements.

oracle.owb.processflow.WBProcessInvalidOperationException - if the type of Parameter is one that cannot be created by a user.

OWBException - if any internal error is encountered.

createParameter

public ProcessActivityParameter createParameter(java.lang.String name,
                                                int direction,
                                                boolean isFinal)
                                         throws NameSpaceException,
                                                InvalidFormatException,
                                                oracle.owb.processflow.WBProcessInvalidOperationException,
                                                OWBException

Creates a process activity parameter with a specfied name, direction and Boolean flag. If parameters are added to a parameter owner whose signature should not be altered, e.g. a parameter owner representing a mapping or a function, these objects cannot have their signatures altered.

Parameters:

name - The name with which to create the parameter

direction - The direction of the parameter, one of IN, OUT or INOUT

• ProcessActivityParameter.DIRECTION_INPUT
• ProcessActivityParameter.DIRECTION_OUTPUT
• ProcessActivityParameter.DIRECTION_INPUT_OUTPUT
isFinal - Boolean flag indicating if this is parameter name or direction cannot (true) or can (false) be modified.
Returns:
The newly create activity parameter.
Throws:
NameSpaceException - if Process Flow Parameter name is not unique.
InvalidFormatException - if the desired name does not satisfy the format requirements.
oracle.owb.processflow.WBProcessInvalidOperationException - if the type of Parameter is one that cannot be created by a user.
OWBException - if any internal error is encountered.

getParameters

public ProcessActivityParameter[] getParameters()

gets the array of Parameters of ProcessFlow or Activity.

Returns:

Arrary of ProcessActivityParameter object.

getParameters

public ProcessActivityParameter[] getParameters(int direction)

gets the array of Parameters of ProcessFlow or Activity.

Parameters:

direction - Process or Activity parameter.

Returns:

Arrary of ProcessActivityParameter object.

findParameter

public ProcessActivityParameter findParameter(java.lang.String name)

Finds the Parameter of ProcessFlow or Activity.

Parameters:

name - String object of Activity parameter.

Returns:

ProcessActivityParameter object.

getPosition

public int getPosition()
                throws OWBException

Retrive the position of the parameter in the signature of the owning function or mapping.

Returns:

the position of this parameter in the list of parameters.

Throws:

OWBException - if any internal error is encountered.

See Also:

setPosition(int)

setPosition

public void setPosition(int position)
                 throws OWBException

Set the position of the parameter in the signature of the owning function or mapping.

Parameters:

position - integer value of setting position for a parameter.

Throws:

OWBException - if any internal error is encountered.

See Also:

getPosition()