oracle.owb.processflow
Interface BaseProcess

All Superinterfaces:

ActivityType, OWBNamedObject, ProcessActivityParameterOwner

All Known Subinterfaces:

ProcessFlow, SubProcess

public interface BaseProcess

extends ProcessActivityParameterOwner, ActivityType

A BaseProcess is the interface that defines the base functionality of all process interfaces namely ProcessFLow and SubProcess . The common functionality across all sub-interfaces are defined here, the common functions are listed below:

• Owns one or more ProcessActivityParameterOwner instances which collectively define the signature of this logical process.
• Owns one or more ProcessData instances to define the data store of variables that are needed while defining the process flow.
• Owns one or more Activity instances that define what warehouse process is being defined.
• Owns one or more Transition instances to capture all of the dependency information of the process.

Field Summary

Fields inherited from interface oracle.owb.processflow.ActivityType

ACTIVITY_TYPE_AND, ACTIVITY_TYPE_EMAIL, ACTIVITY_TYPE_END, ACTIVITY_TYPE_END_ERROR, ACTIVITY_TYPE_END_WARNING, ACTIVITY_TYPE_EXTERNAL, ACTIVITY_TYPE_FILE_EXISTS, ACTIVITY_TYPE_FORK, ACTIVITY_TYPE_FTP, ACTIVITY_TYPE_FUNCTION, ACTIVITY_TYPE_MAP, ACTIVITY_TYPE_OR, ACTIVITY_TYPE_START, ACTIVITY_TYPE_SUBPROCESS

Method Summary

Activity	createActivity(java.lang.String activityName, int activitytype) Creates and returns instance of Activity of a ProcessFlow.
Activity	createActivity(java.lang.String activityName, Map mapping) Creates and returns instance of Activity of a ProcessFlow.
Activity	createActivity(java.lang.String activityName, Transformation function) Creates and returns instance of Activity of a ProcessFlow.
Transition	createTransition(Activity sourceActivity, Activity destinationActivity) Create a transition betweeen two process activities.
Transition	createTransition(java.lang.String transName, Activity sourceActivity, Activity destinationActivity) Create a transition betweeen two process activities.
Activity	findActivity(java.lang.String name) Find an Activity in the ProcessFlow with the specified name.
Transition	findTransition(Activity sourceActivity, Activity destinationActivity) Find a transition between two process activities.
Transition	findTransition(java.lang.String name) Find the transition of the ProcessFlow.
Activity[]	getActivities() Finds all Activities of the ProcessFlow.
Activity[]	getActivities(int activityType) Finds all Activities of the ProcessFlow for a given activity type.
Activity	getEndActivity() Find an End Activity in the ProcessFlow.
Activity	getStartActivity() Find an Start Activity in the ProcessFlow.
Transition[]	getTransitions() Find an array of all the transitions of the ProcessFlow.

Methods inherited from interface oracle.owb.processflow.ProcessActivityParameterOwner

createParameter, createParameter, createParameter, findParameter, getParameters, getParameters, getPosition, setPosition

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

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

Method Detail

createActivity

public Activity createActivity(java.lang.String activityName,
                               int activitytype)
                        throws NameSpaceException,
                               oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException,
InvalidFormatException,
                               oracle.wh.repos.sdk.exceptions.WBStringException,
                               java.lang.Exception

Creates and returns instance of Activity of a ProcessFlow.

Parameters:

activityName - The name with which to create the Activity

activitytype - The type code of the activity that is being created

Returns:

The newly create Activity.

Throws:

NameSpaceException - if Process Flow name is not unique.

oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException - if the type of activity is one that cannot be created by a user, example of this could be the user creation of a second Start or End activity of a process.

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

oracle.wh.repos.sdk.exceptions.WBStringException - if any String definition related error is encountered.

java.lang.Exception - if any internal error is encountered.

createActivity

public Activity createActivity(java.lang.String activityName,
Map mapping)
                        throws NameSpaceException,
                               oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException,
InvalidFormatException,
                               oracle.wh.repos.sdk.exceptions.WBStringException,
                               java.lang.Exception

Creates and returns instance of Activity of a ProcessFlow.

Parameters:

activityName - is String object for name of Map activity.

mapping - is mapping A Map object. This is a OWB Design time object.

Returns:

The newly create Mapping Activity.

Throws:

NameSpaceException - if Process Flow name is not unique.

oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException - if the Map type of activity is one that cannot be created by a user.

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

oracle.wh.repos.sdk.exceptions.WBStringException - if any String definition related error is encountered.

java.lang.Exception - if any internal error is encountered.

createActivity

public Activity createActivity(java.lang.String activityName,
Transformation function)
                        throws NameSpaceException,
                               oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException,
InvalidFormatException,
                               oracle.wh.repos.sdk.exceptions.WBStringException,
                               java.lang.Exception

Creates and returns instance of Activity of a ProcessFlow.

Parameters:

activityName - is String object for name of Transformation activity.

function - is Transformation object. This is a OWB Design time object.

Returns:

The newly create Transformation Activity. Example, Oracle Functions

Throws:

NameSpaceException - if Process Flow name is not unique.

oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException - if the Function or Procedure type of activity is one that cannot be created by a user.

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

oracle.wh.repos.sdk.exceptions.WBStringException - if any String definition related error is encountered.

java.lang.Exception - if any internal error is encountered.

findActivity

public Activity findActivity(java.lang.String name)
                      throws OWBException

Find an Activity in the ProcessFlow with the specified name. The names of the Activity must be unique, so only one Activity will be returned.

Parameters:

name - - The name of the activity.

Returns:

An Activity with the specified name, null if not found.

Throws:

OWBException - if any internal error is encountered.

getActivities

public Activity[] getActivities()
                         throws OWBException

Finds all Activities of the ProcessFlow.

Returns:

An array of Activities, null if not found.

Throws:

OWBException - if any internal error is encountered.

getActivities

public Activity[] getActivities(int activityType)
                         throws OWBException

Finds all Activities of the ProcessFlow for a given activity type.

Returns:

An array of Activities, null if not found.

Throws:

OWBException - if any internal error is encountered.

getStartActivity

public Activity getStartActivity()
                          throws OWBException

Find an Start Activity in the ProcessFlow.

Returns:

A Start Activity.

Throws:

OWBException - if any internal error is encountered.

getEndActivity

public Activity getEndActivity()
                        throws OWBException

Find an End Activity in the ProcessFlow.

Returns:

A End Activity.

Throws:

OWBException - if any internal error is encountered.

createTransition

public Transition createTransition(Activity sourceActivity,
Activity destinationActivity)
                            throws OWBException,
                                   oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException,
NameSpaceException,
InvalidFormatException

Create a transition betweeen two process activities.

Parameters:

sourceActivity - The source activity for this transition.

destinationActivity - The destination activity for this transition.

Returns:

The newly created transition.

Throws:

NameSpaceException - if Process Flow name is not unique.

oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException - if the transition cannot be created.

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

OWBException - if any internal error is encountered.

createTransition

public Transition createTransition(java.lang.String transName,
Activity sourceActivity,
Activity destinationActivity)
                            throws OWBException,
                                   oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException,
NameSpaceException,
InvalidFormatException

Create a transition betweeen two process activities.

Parameters:

transName - a String name of the Transition.

sourceActivity - The source activity for this transition.

destinationActivity - The destination activity for this transition.

Returns:

The newly created transition.

Throws:

NameSpaceException - if Process Flow name is not unique.

oracle.wh.repos.sdk.processflow.exceptions.WBProcessInvalidOperationException - if the transition cannot be created.

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

OWBException - if any internal error is encountered.

findTransition

public Transition findTransition(Activity sourceActivity,
Activity destinationActivity)
                          throws OWBException

Find a transition between two process activities.

Parameters:

sourceActivity - The source activity for this transition.

destinationActivity - The destination activity for this transition.

Returns:

A Transition object, null if not found.

Throws:

OWBException - if any internal error is encountered.

findTransition

public Transition findTransition(java.lang.String name)
                          throws OWBException

Find the transition of the ProcessFlow.

Parameters:

name - String type name of the transition.

Returns:

A Transition object, null if not found.

Throws:

OWBException - if any internal error is encountered.

getTransitions

public Transition[] getTransitions()
                            throws OWBException

Find an array of all the transitions of the ProcessFlow.

Returns:

An array of Transition object, null if not found.

Throws:

OWBException - if any internal error is encountered.