oracle.apps.fnd.wf.design
Class DesignStore

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

All Implemented Interfaces:

Store

public class DesignStore

extends DesignBaseComponent

implements Store

DesignStore is the container for the workflow design store, which contains all of the workflow entities.

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

RCS_ID, 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

Fields inherited from interface oracle.apps.fnd.wf.common.Store

RCS_ID, RCS_ID_RECORDED

Constructor Summary

DesignStore()

Method Summary

void	create(WorkflowContext pCtx, Element pComponent) Creates a component in the design store.
java.lang.String	getAccessLevel() Returns the access level of this design store.
java.lang.String	getDisplayName() Not used
static DesignStore	getInstance(WorkflowContext ctx) Factory method for a design store.
ItemType	getItemType(java.lang.String pItemName) Returns an item type given a item type name.
ItemType	getItemType(WorkflowContext pCtx, java.lang.String pItemName) Returns an item type in the design store given a item type name, or creates one if it's not already exist or not loaded.
java.util.Iterator	getItemTypes() Returns the iterator that points to a list of item type(s).
java.lang.String	getLanguage() Returns the language used in this design store.
Loader	getLoader() Returns the loader associates with this design store.
java.lang.String	getMajorVersion() Returns the major version of this design store.
java.lang.String	getMinorVersion() Returns the minor version of this design store.
java.lang.String	getStoreLocation() Returns the location of this design store.
void	load(WorkflowContext pCtx, Element pComponent) Loads a component from design store.
ItemType	loadItem(WorkflowContext pCtx, java.lang.String pItemName) Creates an item type within this design store and populates the item type.
void	loadStore(WorkflowContext pWFContext) Populates the design store based on the store information retrieved from the loader.
void	save(WorkflowContext pCtx, Element pComponent) Saves a component to design store.
void	saveStore(WorkflowContext pWFContext) Saves the design store to a specific format (wft, xml, database) based on the version of loader used.
void	setAccessLevel(java.lang.String pAccessLevel) Setter function for the access level of this design store.
void	setLanguage(java.lang.String pLanguage) Setter function for the language used in this design store.
void	setLoader() Sets the loader associates with this design store based on store type.
void	setMajorVersion(java.lang.String pMajorVersion) Setter function for the major version of this design store.
void	setMinorVersion(java.lang.String pMinorVersion) Setter function for the minor version of this design store.
void	setStoreLocation(java.lang.String pStoreLocation) Setter function for the location of this design store.
void	setStoreType(java.lang.String pStoreType) Setter function for the type of the store is used in this design store.

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

assign, createRuntimeInstance, getAccessController, getAttribute, getAttributes, getDescription, resolveReference, 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

Constructor Detail

DesignStore

public DesignStore()

Method Detail

getInstance

public static DesignStore getInstance(WorkflowContext ctx)
                               throws WorkflowException

Factory method for a design store. The configuration must be passed in through the context object

Parameters:

ctx - :WorkflowContext context within we create this design store For example

     Hashmap map = new Hashmap();
     
     map.put(WorkflowContext.WF_DESIGN_STORE_LOCATION,"file:///d:/temp/wfdemo.wft");
     map.put(WorkflowContext.WF_DESIGN_STORE_TYPE,WorkflowContext.WF_WFT_STORE);
     WorkflowContext ctx = new WorkflowContext(map);
     DesignStore designStore = DesignStore.getInstance(ctx);
 

Returns:

DesignStore a design store instance from the store manager

getAccessLevel

public java.lang.String getAccessLevel()

Returns the access level of this design store.

Returns:

Access level.

setAccessLevel

public void setAccessLevel(java.lang.String pAccessLevel)

Setter function for the access level of this design store.

Parameters:

pAccessLevel - : Access level.

getMajorVersion

public java.lang.String getMajorVersion()

Returns the major version of this design store.

Returns:

Major version.

setMajorVersion

public void setMajorVersion(java.lang.String pMajorVersion)

Setter function for the major version of this design store.

Parameters:

pMajorVersion - : Major version.

getMinorVersion

public java.lang.String getMinorVersion()

Returns the minor version of this design store.

Returns:

Minor version.

setMinorVersion

public void setMinorVersion(java.lang.String pMinorVersion)

Setter function for the minor version of this design store.

Parameters:

pMinorVersion - : Minor version.

getLanguage

public java.lang.String getLanguage()

Returns the language used in this design store.

Returns:

Language name.

setLanguage

public void setLanguage(java.lang.String pLanguage)

Setter function for the language used in this design store.

Parameters:

pLanguage - : Language.

getStoreLocation

public java.lang.String getStoreLocation()

Returns the location of this design store.

Specified by:

getStoreLocation in interface Store

Returns:

Store location.

setStoreLocation

public void setStoreLocation(java.lang.String pStoreLocation)

Setter function for the location of this design store.

Specified by:

setStoreLocation in interface Store

Parameters:

pStoreLocation - : Store location.

setStoreType

public void setStoreType(java.lang.String pStoreType)

Setter function for the type of the store is used in this design store. Valid types are WF_DB_STORE, WF_XML_STORE, WF_WFT_STORE.

Parameters:

pStoreType - : Store Type.

loadStore

public void loadStore(WorkflowContext pWFContext)
               throws WorkflowException

Populates the design store based on the store information retrieved from the loader.

Parameters:

pWFContext - : Workflow context.

saveStore

public void saveStore(WorkflowContext pWFContext)
               throws java.lang.Exception

Saves the design store to a specific format (wft, xml, database) based on the version of loader used.

Parameters:

pWFContext - : Workflow context.

getDisplayName

public java.lang.String getDisplayName()

Not used

Overrides:

getDisplayName in class DesignBaseComponent

Returns:

Display Name.

loadItem

public ItemType loadItem(WorkflowContext pCtx,
                         java.lang.String pItemName)
                  throws WorkflowException

Creates an item type within this design store and populates the item type.

Parameters:

pCtx - : Workflow context.

pItemName - : Item type name.

Returns:

Item type.

getItemType

public ItemType getItemType(java.lang.String pItemName)

Returns an item type given a item type name.

Parameters:

pItemName - : Item type name.

Returns:

Item type within the design store that matches the given name.

getItemType

public ItemType getItemType(WorkflowContext pCtx,
                            java.lang.String pItemName)
                     throws WorkflowException

Returns an item type in the design store given a item type name, or creates one if it's not already exist or not loaded.

Parameters:

pCtx - : Workflow context.

pItemName - : Item type name.

Returns:

Item type.

getItemTypes

public java.util.Iterator getItemTypes()

Returns the iterator that points to a list of item type(s).

Returns:

Iterator that points to a list of item type(s).

setLoader

public void setLoader()
               throws java.lang.Exception

Sets the loader associates with this design store based on store type.

getLoader

public Loader getLoader()

Returns the loader associates with this design store.

Specified by:

getLoader in interface Store

Returns:

Loader.

load

public final void load(WorkflowContext pCtx,
                       Element pComponent)
                throws WorkflowException

Loads a component from design store. Not used in WFT loader. WFT loader should use loadStore instead.

Specified by:

load in interface Store

Parameters:

pCtx - : Workflow context.

pComponent - : Component.

save

public final void save(WorkflowContext pCtx,
                       Element pComponent)
                throws WorkflowException

Saves a component to design store. Not used in WFT loader. WFT loader should use saveStore instead.

Specified by:

save in interface Store

Parameters:

pCtx - : Workflow context.

pComponent - : Component.

create

public final void create(WorkflowContext pCtx,
                         Element pComponent)
                  throws WorkflowException

Creates a component in the design store. Not used in WFT loader. WFT loader should use loadStore instead.

Specified by:

create in interface Store

Parameters:

pCtx - : Workflow context.

pComponent - : Component.