oracle.apps.fnd.wf.design
Class ItemType

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.ItemType

public class ItemType

extends DesignBaseAttributeComponent

ItemType is the container for the workflow item type. An item type is a classification of the components that make up a workflow process. You must associate any component that you create for a process, such as a function activity or a message, with a particular item type. Often it makes sense to define an item type so that it describes the item being managed by your workflow process.

Field Summary

static java.lang.String	PTYPE_PERM
static java.lang.String	PTYPE_TEMP
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

ItemType()
Use this constructor only if the item type name is not available.

ItemType(java.lang.String id)
Use this constructor if the item type name is available.

Method Summary

Activity	getActivity(java.lang.String pActivityName) Returns the activity in this item type that matches the given activity name.
java.lang.String	getExecuteRole() Returns the user role that has execute permission to this item type.
java.util.List	getFunctions() Returns a list of function(s) associate with this item type.
Message	getMessage(java.lang.String pMessageName) Returns the message in this item type that matches the given message name.
java.math.BigDecimal	getPersistenceDuration() Returns the persistence duration, which controls how long (in days) a status audit trail is maintained for each instance of the item type if the persistence type is temporary.
java.lang.String	getPersistenceType() Returns the persistence type, which controls how long a status audit trail is maintained for each instance of the item type.
Process	getProcess(java.lang.String pProcessName) Returns the process in this item type that matches the given process name.
java.lang.String	getReadRole() Returns the user role that has read access to this item type.
Function	getSelector() Returns the selector function associate with this item type, which determines which PL/SQL function to execute in any given situation.
java.lang.String	getWriteRole() Returns the user role that has write access to this item type.
boolean	isLoaded() Returns if this item type is loaded to the design store.
void	resolveReference() Resolves the Role definition reference to the actual Role base on the role name defined in this item type if it is not already exist.
void	setExecuteRoleName(java.lang.String pExecuteRoleName) Setter function for role name that has execute permission to this item type.
void	setLoaded(boolean pLoaded) Setter function for whether the item type is loaded to the design store.
void	setPersistenceDuration(java.math.BigDecimal pPersistenceDays) Setter function for the persistence duration.
void	setPersistenceType(java.lang.String pPersistenceType) Setter function for the persistence type.
void	setReadRoleName(java.lang.String pReadRoleName) Setter function for role name that has read access to the item type.
void	setSelector(Function pSelector) Setter function for the selector function.
void	setWriteRoleName(java.lang.String pWriteRoleName) Setter function for role name that has write access to the item type.

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

PTYPE_PERM

public static final java.lang.String PTYPE_PERM

PTYPE_TEMP

public static final java.lang.String PTYPE_TEMP

Constructor Detail

ItemType

public ItemType(java.lang.String id)

Use this constructor if the item type name is available.

Parameters:

id - : Item type name.

ItemType

public ItemType()

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

Method Detail

getFunctions

public java.util.List getFunctions()

Returns a list of function(s) associate with this item type.

Returns:

A list of function(s).

getSelector

public Function getSelector()

Returns the selector function associate with this item type, which determines which PL/SQL function to execute in any given situation.

Returns:

Selector function.

setSelector

public void setSelector(Function pSelector)

Setter function for the selector function.

Parameters:

pSelector - : Selector function.

getPersistenceType

public java.lang.String getPersistenceType()

Returns the persistence type, which controls how long a status audit trail is maintained for each instance of the item type.

Returns:

Persistence type of the item type.

setPersistenceType

public void setPersistenceType(java.lang.String pPersistenceType)

Setter function for the persistence type. It should match one of the pre-defined persistence types.

Parameters:

pPersistenceType - : Persistence type.

getPersistenceDuration

public java.math.BigDecimal getPersistenceDuration()

Returns the persistence duration, which controls how long (in days) a status audit trail is maintained for each instance of the item type if the persistence type is temporary.

Returns:

Persistence duration.

setPersistenceDuration

public void setPersistenceDuration(java.math.BigDecimal pPersistenceDays)

Setter function for the persistence duration. Used only when persistence type is temporary.

Parameters:

pPersistenceDays - : Persistence duration.

isLoaded

public boolean isLoaded()

Returns if this item type is loaded to the design store.

Returns:

True if the item type is already loaded.

setLoaded

public void setLoaded(boolean pLoaded)

Setter function for whether the item type is loaded to the design store.

Parameters:

pLoaded - : True if item type is loaded.

getReadRole

public java.lang.String getReadRole()

Returns the user role that has read access to this item type. Currently returns role name since Role is not fully implemented in Phase 2. When Role is fully implemented this method will return to a Role object instead.

Returns:

Role name.

setReadRoleName

public void setReadRoleName(java.lang.String pReadRoleName)

Setter function for role name that has read access to the item type.

Parameters:

pReadRoleName - : Role name.

getWriteRole

public java.lang.String getWriteRole()

Returns the user role that has write access to this item type. Currently returns role name since Role is not fully implemented in Phase 2. When Role is fully implemented this method will return to a Role object instead.

Returns:

Role name.

setWriteRoleName

public void setWriteRoleName(java.lang.String pWriteRoleName)

Setter function for role name that has write access to the item type.

Parameters:

pWriteRoleName - : Role name.

getExecuteRole

public java.lang.String getExecuteRole()

Returns the user role that has execute permission to this item type. Currently returns role name since Role is not fully implemented in Phase 2. When Role is fully implemented this method will return to a Role object instead.

Returns:

Role name.

setExecuteRoleName

public void setExecuteRoleName(java.lang.String pExecuteRoleName)

Setter function for role name that has execute permission to this item type.

Parameters:

pReadRoleName - : Role name.

getActivity

public Activity getActivity(java.lang.String pActivityName)

Returns the activity in this item type that matches the given activity name.

Parameters:

pActivityName - : Activity name.

Returns:

Activity.

getProcess

public Process getProcess(java.lang.String pProcessName)

Returns the process in this item type that matches the given process name.

Parameters:

pProcessName - : Process name.

Returns:

Process.

getMessage

public Message getMessage(java.lang.String pMessageName)

Returns the message in this item type that matches the given message name.

Parameters:

pMessageName - : Message name.

Returns:

Message.

resolveReference

public void resolveReference()

Resolves the Role definition reference to the actual Role base on the role name defined in this item type if it is not already exist. Not implemented in phase 2!

Overrides:

resolveReference in class DesignBaseComponent