oracle.apps.fnd.wf.design
Class Activity

java.lang.Object
  |
  +--oracle.apps.fnd.wf.common.Element
        |
        +--oracle.apps.fnd.wf.common.BaseComponent
              |
              +--oracle.apps.fnd.wf.design.DesignBaseComponent
                    |
                    +--oracle.apps.fnd.wf.design.DesignBaseAttributeComponent
                          |
                          +--oracle.apps.fnd.wf.design.Activity

Direct Known Subclasses:

FunctionActivity, Notification, Process

public abstract class Activity

extends DesignBaseAttributeComponent

Activity is the base class for all the workflow activities, which includes FunctionActivity, Process, and Notification.

Field Summary

static java.lang.String	EVENT_TYPE
static java.lang.String	FUNCTION_TYPE
static java.lang.String	NOTIFICATION_TYPE
static java.lang.String	PROCESS_TYPE
static java.lang.String	RCS_ID
static boolean	RCS_ID_RECORDED

Fields inherited from class oracle.apps.fnd.wf.common.Element

ELEMENT_DB_CREATED, ELEMENT_DB_CREATING, ELEMENT_DB_DIRTY, ELEMENT_DB_LOADED, ELEMENT_DB_LOADING, ELEMENT_DB_NOT_INITIALIZED, ELEMENT_DB_SAVED, ELEMENT_DB_SAVING

Constructor Summary

Activity()
Use this constructor only if the activity name is not available.

Activity(java.lang.String id)
Use this constructor if the activity name is available.

Method Summary

void	assign(DesignBaseComponent pComponent) Assigns the information from another Activity to this activity.
void	copyActivity(Activity pAct) Copies the member variables from pAct to this activity.
ProcessActivity	createNode() Returns a newly created process activity base on this activity.
java.lang.String	getActionOnRevisit() Returns the Workflow Engine action when this activity is transitioned to more than once.
int	getCost() Returns the execution cost of this activity.
java.lang.String	getEffectiveDate() Returns the effective date of this activity in String format.
java.lang.String	getErrorItemType() Returns the internal name of the item type that owns the error process.
java.lang.String	getErrorProcess() Returns the error process to execute in the event that an error occurs in the current activity.
java.lang.String	getExecuteRole() Returns the role who can execute this activity.
java.lang.String	getFunctionType() Returns the type of Function associates to this activity.
java.lang.String	getIconName() Returns the icon name associates with this activity.
ItemType	getItemType() Returns the item type associates to this activity.
LookupType	getLookupType() Returns the lookup type associates to this activity that matches the result type of the existing activity.
java.lang.String	getMessageName() Returns the name of the message associates to this activity.
java.lang.String	getReadRole() Returns the role who has read access to this activity.
java.lang.String	getResult() Returns the result type of this activity.
java.lang.String	getTempFunction() Returns the name of the function associates to this activity.
abstract java.lang.String	getType() Returns the type of activity ("PROCESS", "FUNCTION", etc).
int	getVersion() Returns the version of this activity.
java.lang.String	getWriteRole() Returns the role who has write access to this activity.
boolean	isRunnable() Returns if the process is enabled for execution.
void	resolveReference() Creates function class if there's no Java Function class created.
void	setActionOnRevisit(java.lang.String pActionOnRevisit) Setter function for the Workflow Engine action when this activity is transitioned to more than once.
void	setCost(int pCost) Setter function for the execution cost of this activity.
void	setEffectiveDate(java.lang.String pEffDate) Setter function for the effective date of this activity.
void	setErrorItemType(java.lang.String pErrorItemType) Setter function for the internal name of the item type that owns the error process.
void	setErrorProcess(java.lang.String pErrorProcess) Setter function for the error process to execute in the event that an error occurs in the current activity.
void	setExecuteRole(java.lang.String pExecuteRole) Setter function for the role who can execute this activity.
void	setFunctionType(java.lang.String pFunctionType) Setter function for the type of Function associates to this activity.
void	setIconName(java.lang.String pIconName) Setter function for the icon name associates with this activity.
void	setMessageName(java.lang.String pMessageName) Setter function for the name of the message associates to this activity.
void	setReadRole(java.lang.String pReadRole) Setter function for the role who has read access to this activity.
void	setResult(java.lang.String pResult) Setter function for the result type of this activity.
void	setRunnable(boolean pIsRunnable) Setter function for whether a process is enable during execution time.
void	setTempFunction(java.lang.String pFunctionName) Setter function for the function name associates to this activity.
void	setVersion(int pVersion) Setter function for the version of this activity.
void	setWriteRole(java.lang.String pWriteRole) Setter function for the role who has write access to this activity.
boolean	validate(oracle.apps.fnd.wf.WFContext pCtx, int pType) Returns the validation of this activity.

Methods inherited from class oracle.apps.fnd.wf.design.DesignBaseAttributeComponent

addFunction, getAttribute, getFunction

Methods inherited from class oracle.apps.fnd.wf.design.DesignBaseComponent

assign, createRuntimeInstance, getAccessController, getAttributes, getDescription, getDisplayName, setDescription, setDisplayName, setName, setResolved, toString

Methods inherited from class oracle.apps.fnd.wf.common.BaseComponent

addChild, getChildByTypeAndName, getChildren, getChildrenByName, getChildrenByType, getName, getParent, removeChild, removeChildren

Methods inherited from class oracle.apps.fnd.wf.common.Element

create, getDBStatus, getId, load, save, setStore

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RCS_ID

public static final java.lang.String RCS_ID

RCS_ID_RECORDED

public static final boolean RCS_ID_RECORDED

FUNCTION_TYPE

public static final java.lang.String FUNCTION_TYPE

PROCESS_TYPE

public static final java.lang.String PROCESS_TYPE

NOTIFICATION_TYPE

public static final java.lang.String NOTIFICATION_TYPE

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

Constructor Detail

Activity

public Activity(java.lang.String id)

Use this constructor if the activity name is available.

Parameters:

id - : Activity name.

Activity

public Activity()

Use this constructor only if the activity name is not available. Once the activity name is retrieved, setName() should be used to set the activity name.

Method Detail

copyActivity

public void copyActivity(Activity pAct)

Copies the member variables from pAct to this activity.

Parameters:

pAct - : Activity whom the values are copied from.

getVersion

public int getVersion()

Returns the version of this activity.

Returns:

Version of this activity.

setVersion

public void setVersion(int pVersion)

Setter function for the version of this activity.

Parameters:

pVersion - : Version of this activity.

getIconName

public java.lang.String getIconName()

Returns the icon name associates with this activity.

Returns:

Name of the icon.

setIconName

public void setIconName(java.lang.String pIconName)

Setter function for the icon name associates with this activity.

Parameters:

pIconName - : Name of the icon.

getEffectiveDate

public java.lang.String getEffectiveDate()

Returns the effective date of this activity in String format.

Returns:

Effective date.

setEffectiveDate

public void setEffectiveDate(java.lang.String pEffDate)

Setter function for the effective date of this activity.

Parameters:

pEffDate - : Effective date.

getResult

public java.lang.String getResult()

Returns the result type of this activity.

Returns:

Result type.

setResult

public void setResult(java.lang.String pResult)

Setter function for the result type of this activity.

Parameters:

pResult - : Result type.

getCost

public int getCost()

Returns the execution cost of this activity.

Returns:

Cost (1-100).

setCost

public void setCost(int pCost)

Setter function for the execution cost of this activity.

Parameters:

pCost - : Cost (1-100).

getReadRole

public java.lang.String getReadRole()

Returns the role who has read access to this activity.

Returns:

Role that can read this activity .

setReadRole

public void setReadRole(java.lang.String pReadRole)

Setter function for the role who has read access to this activity.

Parameters:

pReadRole - : Role that can read this activity.

getWriteRole

public java.lang.String getWriteRole()

Returns the role who has write access to this activity.

Returns:

Role that can write to this activity .

setWriteRole

public void setWriteRole(java.lang.String pWriteRole)

Setter function for the role who has write access to this activity.

Parameters:

pWriteRole - : Role that can write to this activity.

getExecuteRole

public java.lang.String getExecuteRole()

Returns the role who can execute this activity.

Returns:

Role that can execute this activity .

setExecuteRole

public void setExecuteRole(java.lang.String pExecuteRole)

Setter function for the role who can execute this activity.

Parameters:

pExecuteRole - : Role that can execute this activity.

getErrorProcess

public java.lang.String getErrorProcess()

Returns the error process to execute in the event that an error occurs in the current activity.

Returns:

Error process of this activity.

setErrorProcess

public void setErrorProcess(java.lang.String pErrorProcess)

Setter function for the error process to execute in the event that an error occurs in the current activity.

Parameters:

pErrorProcess - : Error process of this activity.

getErrorItemType

public java.lang.String getErrorItemType()

Returns the internal name of the item type that owns the error process.

Returns:

Internal name of the item type that owns the error process.

setErrorItemType

public void setErrorItemType(java.lang.String pErrorItemType)

Setter function for the internal name of the item type that owns the error process.

Parameters:

pErrorItemType - : Internal name of the item type that owns the error process.

getActionOnRevisit

public java.lang.String getActionOnRevisit()

Returns the Workflow Engine action when this activity is transitioned to more than once.

Returns:

Revisit action.

setActionOnRevisit

public void setActionOnRevisit(java.lang.String pActionOnRevisit)

Setter function for the Workflow Engine action when this activity is transitioned to more than once.

Parameters:

pActionOnRevisit - : Revisit action.

getFunctionType

public java.lang.String getFunctionType()

Returns the type of Function associates to this activity.

Returns:

Type of function associates to this activity.

setFunctionType

public void setFunctionType(java.lang.String pFunctionType)

Setter function for the type of Function associates to this activity.

Parameters:

pFunctionType - : Type of function associates to this activity.

getMessageName

public java.lang.String getMessageName()

Returns the name of the message associates to this activity.

Returns:

Message name.

setMessageName

public void setMessageName(java.lang.String pMessageName)

Setter function for the name of the message associates to this activity.

Parameters:

pMessageName - : Message name.

getTempFunction

public java.lang.String getTempFunction()

Returns the name of the function associates to this activity. Internal use only. User is not suppose to retrieve function name using this method. Instead one should obtain function name from the child Function class.

Returns:

Function name.

setTempFunction

public void setTempFunction(java.lang.String pFunctionName)

Setter function for the function name associates to this activity. Internal use only.

Parameters:

pFunctionName - : Effective date.

isRunnable

public boolean isRunnable()

Returns if the process is enabled for execution.

Returns:

True if the process is enabled, false otherwise.

setRunnable

public void setRunnable(boolean pIsRunnable)

Setter function for whether a process is enable during execution time.

Parameters:

pIsRunnable - : True if the process is enabled, false otherwise.

getItemType

public ItemType getItemType()

Returns the item type associates to this activity.

Returns:

Item type.

getLookupType

public LookupType getLookupType()

Returns the lookup type associates to this activity that matches the result type of the existing activity.

Returns:

Lookup type.

getType

public abstract java.lang.String getType()

Returns the type of activity ("PROCESS", "FUNCTION", etc).

Returns:

Type of activity.

validate

public boolean validate(oracle.apps.fnd.wf.WFContext pCtx,
                        int pType)

Returns the validation of this activity.

Returns:

True if validation passed, false otherwise.

createNode

public ProcessActivity createNode()

Returns a newly created process activity base on this activity.

Returns:

Process activity.

assign

public void assign(DesignBaseComponent pComponent)

Assigns the information from another Activity to this activity.

Parameters:

pComponent - : Activity.

resolveReference

public void resolveReference()

Creates function class if there's no Java Function class created.

Overrides:

resolveReference in class DesignBaseComponent