Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-05

oracle.apps.fnd.applcore.flex.uimodeler.util.common
Class UIModelerPageService

java.lang.Object
  extended by oracle.apps.fnd.applcore.flex.uimodeler.util.common.UIModelerPageService

public class UIModelerPageService
extends java.lang.Object

Standard UIModeler PageService for generating UIModeler artifacts.

Author:
Srini Rangarajan <srini.rangarajan&064;oracle.com>

Constructor Summary
UIModelerPageService(UIModelerContext context)
          Constructor for UIModeler Page Service.
 
Method Summary
static java.lang.String buildBaseHintProperty(java.lang.String attribute, java.lang.String property)
          Builder for base hint property.
 boolean contextTaskflowExists(java.lang.String fragName)
          Deletes a given taskflow from MDS.
 org.w3c.dom.DocumentFragment createReplacementDocumentFragment(org.w3c.dom.Document doc, java.lang.String attrName, boolean table)
          Creates the document fragment content which will be used as replacement.
 oracle.webcenter.page.model.PageDef creatRegionTaskflowandFragment(java.lang.String nameFormat, java.lang.String title, java.lang.String pageTemplate, java.lang.String pageTemplatePath, java.lang.String cssStyle, java.lang.String schemeBGImage, java.lang.String schemeBGColor)
          Creates the Region Taskflow And Page Fragment with given paramters.
 oracle.webcenter.page.model.PageDef creatRegionTaskflowandFragmentForContext(java.lang.String contextTFName, java.lang.String contextFragName, java.lang.String contextPageDefName)
           
 void deleteContextTaskFlow(java.lang.String taskFlowName, java.lang.String fragName, java.lang.String pageDefName)
          Deletes a given context taskflow/pageDef and jsff from MDS.
 void deleteFragment(oracle.webcenter.page.model.PageDef fragmentPageDef)
          Deletes a given page fragment.
 void deleteTaskFlow(java.lang.String taskFlowName)
          Deletes a given taskflow from MDS.
 void flushMDSChanges()
          Flushes the MDS Changes for consistency.
protected  java.lang.String getBindingExpressionBase()
          Getter for Expression Base.
 oracle.adfdt.model.objects.PageDefinition getDTPageDef(java.lang.String pageDefName)
          Gets the page definition for given pageDef.
 java.lang.String getExpression(java.lang.String attrName, java.lang.String suffix)
          Gets the expression generated for an attribute.
 oracle.webcenter.page.model.PageDef getPageDef(java.lang.String pageName)
          Gets the PageDef for given page.
 oracle.adf.view.rich.dt.Page getPageObject(java.lang.String pageName)
          Gets the Page for given page name.
 java.lang.String getTableRowExpression(java.lang.String attrName, java.lang.String suffix)
          JSFExpressionUtils already has utilities to generate certain jsf element properties.
 oracle.webcenter.page.model.PageService getWebcenterPageService()
          Gets the handle of Webcenetre Page Service instance.
static void initFlexSetupIcons(org.w3c.dom.Document viewDoc, java.lang.String flexCode, java.lang.String appCode, java.lang.String flexNameTranslated, java.lang.String flexDescription)
           
 void setContainerPageName(java.lang.String documentRef, UIModelerContext modelerContext)
           
 void updateFragmentwithTaskFlowEntries(java.lang.String documentRef, java.util.ArrayList<java.lang.String> fragments, UIModelerContext modelerContext, oracle.jbo.server.ViewDefImpl contextViewDef)
          Updates the Fragments with proper taskflow entries.
 void updatePageDefwithCriteriaForContext(java.lang.String documentRef, java.lang.String amDCProv, java.lang.String amDC, java.lang.String amInstName, java.lang.String voInstName, java.lang.String vlaName)
          Updates Page Def with Criteria for Context.
 void updatePageDefwithCriteriaForListofPages(java.lang.String documentRef, java.util.Map<java.lang.String,java.lang.String> parametersforpageDef)
          Updates the PageDef with Criteria details.
 void updatePageDefwithTaskFlowEntries(java.lang.String documentRef, java.util.ArrayList<java.lang.String> fragments, java.util.ArrayList<java.lang.String> contextCodes, java.util.Map<java.lang.String,java.lang.String> parametersforpageDef, oracle.adfdt.model.objects.PageDefinition DTpageDef, java.util.ArrayList<java.lang.String> viewPrivileges, java.util.ArrayList<java.lang.String> editPrivileges, java.lang.String entityTableName, java.util.Map<java.lang.String,java.lang.String> paramsMap, java.lang.String dcName, java.lang.String catVOName, java.lang.String catAMName)
          Update PageDef with TaskFlow Entries.
 void updatePageListWithCustomLinkDocFrag(org.w3c.dom.Document doc, org.w3c.dom.DocumentFragment docFrag)
          Updates Pages list with custom link for document fragments.
 void updateReplacementFrags(java.util.Map<java.lang.String,oracle.jbo.AttributeDef> listBindingNames, java.util.Map<java.lang.String,oracle.jbo.AttributeDef> lovNames, java.util.Map<java.lang.String,oracle.jbo.AttributeDef> checkBoxAttrs, java.util.Map<java.lang.String,org.w3c.dom.DocumentFragment> replaceLOVJSFfragMap, org.w3c.dom.DocumentFragment widgetFrag, java.lang.String documentRef, oracle.adf.view.rich.dt.Page page)
          Updates Doc .
 void updateReplacementFragsforTable(java.util.Map<java.lang.String,oracle.jbo.AttributeDef> listBindingNames, java.util.Map<java.lang.String,oracle.jbo.AttributeDef> lovNames, java.util.Map<java.lang.String,org.w3c.dom.DocumentFragment> replaceLOVJSFfragMap, org.w3c.dom.Element widgetFrag, oracle.adf.view.rich.dt.Page page)
          For each of the LOV attributes, replace the errorneously created text component with the generated LOVs.
 void updateTaskFlowwithCriteriaForContext(java.lang.String documentRef, java.lang.String amDCProv, java.lang.String amDC, java.lang.String amInstName, java.lang.String voInstName, java.lang.String vlaName)
          Updates context taskflow with parameter values for EffCategoryPagesBean#createDetailRowIfNotExists
 void updateWithFrag(java.util.Map<java.lang.String,oracle.jbo.AttributeDef> listBindingAttrNames, java.util.Map<java.lang.String,oracle.jbo.AttributeDef> lovNames, java.util.Map<java.lang.String,org.w3c.dom.DocumentFragment> replaceLOVJSFfragMap, org.w3c.dom.DocumentFragment df, oracle.adf.view.rich.dt.Page page, UIModelerContext modelercontext)
          Updates with LOVs details for fragments.
 void updateWithReplacementFrag(java.lang.String attrName, org.w3c.dom.DocumentFragment lovreplaceFrag, org.w3c.dom.DocumentFragment widgetFrag, oracle.adf.view.rich.dt.Page page, java.lang.String accessorVOName)
          For Lovs and other erroroneously created components modifcations.
 void updateWithReplacementFragForTable(java.lang.String attrName, org.w3c.dom.DocumentFragment lovreplaceFrag, org.w3c.dom.Element appsTable, oracle.adf.view.rich.dt.Page page, java.lang.String accessorVOName)
          For Lovs and other erroroneously created componets modifcations.
 void updateWithTable(org.w3c.dom.Element appsTable, org.w3c.dom.Document viewDocument, java.lang.String tag, java.lang.String tagId)
          updates the Page with Table element entries.
 void updateWithTable(org.w3c.dom.Element appsTable, oracle.adf.view.rich.dt.Page page, java.lang.String tag, java.lang.String tagId, UIModelerContext modelerContext)
          Updates the content delivery attribute for a table.
 void updateWithTable(org.w3c.dom.Element appsTable, oracle.adf.view.rich.dt.Page page, UIModelerContext modelerContext)
          updates the Page with Table element entries.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UIModelerPageService

public UIModelerPageService(UIModelerContext context)
Constructor for UIModeler Page Service.

Parameters:
context - as UIModelerContext
See Also:
UIModelerContext
Method Detail

creatRegionTaskflowandFragment

public oracle.webcenter.page.model.PageDef creatRegionTaskflowandFragment(java.lang.String nameFormat,
                                                                          java.lang.String title,
                                                                          java.lang.String pageTemplate,
                                                                          java.lang.String pageTemplatePath,
                                                                          java.lang.String cssStyle,
                                                                          java.lang.String schemeBGImage,
                                                                          java.lang.String schemeBGColor)
Creates the Region Taskflow And Page Fragment with given paramters.

Parameters:
nameFormat - as String for Name Format
title - string to be used
pageTemplate - Page Template to be used
pageTemplatePath - Path for selected page template
cssStyle - css style name
schemeBGImage - scheme for background image
schemeBGColor - scheme for background color
Returns:
PageDef for Created taskflow fragment

creatRegionTaskflowandFragmentForContext

public oracle.webcenter.page.model.PageDef creatRegionTaskflowandFragmentForContext(java.lang.String contextTFName,
                                                                                    java.lang.String contextFragName,
                                                                                    java.lang.String contextPageDefName)

getPageObject

public oracle.adf.view.rich.dt.Page getPageObject(java.lang.String pageName)
Gets the Page for given page name.

Parameters:
pageName - as Name of the Page
Returns:
Instance of the Page

flushMDSChanges

public void flushMDSChanges()
Flushes the MDS Changes for consistency.


updateFragmentwithTaskFlowEntries

public void updateFragmentwithTaskFlowEntries(java.lang.String documentRef,
                                              java.util.ArrayList<java.lang.String> fragments,
                                              UIModelerContext modelerContext,
                                              oracle.jbo.server.ViewDefImpl contextViewDef)
Updates the Fragments with proper taskflow entries.

Parameters:
documentRef - as String
fragments - List of Fragments
modelerContext - as UIModelerContext

setContainerPageName

public void setContainerPageName(java.lang.String documentRef,
                                 UIModelerContext modelerContext)

getPageDef

public oracle.webcenter.page.model.PageDef getPageDef(java.lang.String pageName)
Gets the PageDef for given page.

Parameters:
pageName - as String
Returns:
PageDef for given page

deleteTaskFlow

public void deleteTaskFlow(java.lang.String taskFlowName)
Deletes a given taskflow from MDS.

Parameters:
taskFlowName - Candidate taskflow name

deleteContextTaskFlow

public void deleteContextTaskFlow(java.lang.String taskFlowName,
                                  java.lang.String fragName,
                                  java.lang.String pageDefName)
Deletes a given context taskflow/pageDef and jsff from MDS.

Parameters:
taskFlowName - Candidate taskflow name

contextTaskflowExists

public boolean contextTaskflowExists(java.lang.String fragName)
Deletes a given taskflow from MDS.

Parameters:
fragName - Name of the context jsff

deleteFragment

public void deleteFragment(oracle.webcenter.page.model.PageDef fragmentPageDef)
Deletes a given page fragment.

Parameters:
fragmentPageDef - as PageDef

updatePageDefwithCriteriaForListofPages

public void updatePageDefwithCriteriaForListofPages(java.lang.String documentRef,
                                                    java.util.Map<java.lang.String,java.lang.String> parametersforpageDef)
Updates the PageDef with Criteria details.

Parameters:
documentRef - Name of the page document
parametersforpageDef - map of paramters for pageDefs

getDTPageDef

public oracle.adfdt.model.objects.PageDefinition getDTPageDef(java.lang.String pageDefName)
Gets the page definition for given pageDef.

Parameters:
pageDefName - as String
Returns:
PageDefinition for given pageDef

updateWithTable

public void updateWithTable(org.w3c.dom.Element appsTable,
                            oracle.adf.view.rich.dt.Page page,
                            UIModelerContext modelerContext)
updates the Page with Table element entries.

Parameters:
appsTable - as Element
page - as Page
modelerContext - UIModelerContext

updateWithTable

public void updateWithTable(org.w3c.dom.Element appsTable,
                            org.w3c.dom.Document viewDocument,
                            java.lang.String tag,
                            java.lang.String tagId)
updates the Page with Table element entries.

Parameters:
appsTable - as Element
viewDocument - as Document
tag - name as String
tagId - as Id of the Tag

updateWithFrag

public void updateWithFrag(java.util.Map<java.lang.String,oracle.jbo.AttributeDef> listBindingAttrNames,
                           java.util.Map<java.lang.String,oracle.jbo.AttributeDef> lovNames,
                           java.util.Map<java.lang.String,org.w3c.dom.DocumentFragment> replaceLOVJSFfragMap,
                           org.w3c.dom.DocumentFragment df,
                           oracle.adf.view.rich.dt.Page page,
                           UIModelerContext modelercontext)
Updates with LOVs details for fragments.

Parameters:
listBindingAttrNames - Map for binding attributesdef
lovNames - Map for LOV Names
replaceLOVJSFfragMap - documentfragment's map for LOVs
df - as Document Fragment
page - as Page instance

getWebcenterPageService

public oracle.webcenter.page.model.PageService getWebcenterPageService()
Gets the handle of Webcenetre Page Service instance.

Returns:
PageService instance

updatePageListWithCustomLinkDocFrag

public void updatePageListWithCustomLinkDocFrag(org.w3c.dom.Document doc,
                                                org.w3c.dom.DocumentFragment docFrag)
Updates Pages list with custom link for document fragments.

Parameters:
doc - as Document
docFrag - as DocumentFragment

updatePageDefwithCriteriaForContext

public void updatePageDefwithCriteriaForContext(java.lang.String documentRef,
                                                java.lang.String amDCProv,
                                                java.lang.String amDC,
                                                java.lang.String amInstName,
                                                java.lang.String voInstName,
                                                java.lang.String vlaName)
Updates Page Def with Criteria for Context.

Parameters:
documentRef - as Document Name
amDCProv - Data Provided AM Name
amDC - data control AM name
amInstName - AM instance Name
voInstName - VO instance Name
vlName - View Link Name

updateTaskFlowwithCriteriaForContext

public void updateTaskFlowwithCriteriaForContext(java.lang.String documentRef,
                                                 java.lang.String amDCProv,
                                                 java.lang.String amDC,
                                                 java.lang.String amInstName,
                                                 java.lang.String voInstName,
                                                 java.lang.String vlaName)
Updates context taskflow with parameter values for EffCategoryPagesBean#createDetailRowIfNotExists

Parameters:
documentRef - as Document Name
amDCProv - Data Provided AM Name
amDC - data control AM name
amInstName - AM instance Name
voInstName - VO instance Name
vlName - View Link Name

updatePageDefwithTaskFlowEntries

public void updatePageDefwithTaskFlowEntries(java.lang.String documentRef,
                                             java.util.ArrayList<java.lang.String> fragments,
                                             java.util.ArrayList<java.lang.String> contextCodes,
                                             java.util.Map<java.lang.String,java.lang.String> parametersforpageDef,
                                             oracle.adfdt.model.objects.PageDefinition DTpageDef,
                                             java.util.ArrayList<java.lang.String> viewPrivileges,
                                             java.util.ArrayList<java.lang.String> editPrivileges,
                                             java.lang.String entityTableName,
                                             java.util.Map<java.lang.String,java.lang.String> paramsMap,
                                             java.lang.String dcName,
                                             java.lang.String catVOName,
                                             java.lang.String catAMName)
Update PageDef with TaskFlow Entries.

Parameters:
documentRef - as Document Name
fragments - as List of Fragment names
parametersforpageDef - Paramters Map for PageDef

updateWithReplacementFrag

public void updateWithReplacementFrag(java.lang.String attrName,
                                      org.w3c.dom.DocumentFragment lovreplaceFrag,
                                      org.w3c.dom.DocumentFragment widgetFrag,
                                      oracle.adf.view.rich.dt.Page page,
                                      java.lang.String accessorVOName)
For Lovs and other erroroneously created components modifcations.

Parameters:
attrName - Name of he attribute
lovreplaceFrag - as DocumentFragment for lov replacement
widgetFrag - as DocumentFragment for widget
page - as Page
accessorVOName - Name of accessor VO

updateWithReplacementFragForTable

public void updateWithReplacementFragForTable(java.lang.String attrName,
                                              org.w3c.dom.DocumentFragment lovreplaceFrag,
                                              org.w3c.dom.Element appsTable,
                                              oracle.adf.view.rich.dt.Page page,
                                              java.lang.String accessorVOName)
For Lovs and other erroroneously created componets modifcations. This is for the table use case.

Parameters:
attrName - Name of he attribute
lovreplaceFrag - as DocumentFragment for lov replacement
appsTable - as Element for apps table widget
page - as Page
accessorVOName - Name of accessor VO

createReplacementDocumentFragment

public org.w3c.dom.DocumentFragment createReplacementDocumentFragment(org.w3c.dom.Document doc,
                                                                      java.lang.String attrName,
                                                                      boolean table)
Creates the document fragment content which will be used as replacement.

Parameters:
doc - Document where replacement is needed
attrName - as the attribute for which fragment will be generated
table - - if this is a table usecase, then the fragment would need to be a little different
Returns:
Document Fragment generated

buildBaseHintProperty

public static java.lang.String buildBaseHintProperty(java.lang.String attribute,
                                                     java.lang.String property)
Builder for base hint property.

Parameters:
attribute - Name of the attribute
property - Property Name
Returns:
Expression string for the property

getExpression

public java.lang.String getExpression(java.lang.String attrName,
                                      java.lang.String suffix)
Gets the expression generated for an attribute.

Parameters:
attrName - as String
suffix - as String
Returns:
Expression string

getBindingExpressionBase

protected java.lang.String getBindingExpressionBase()
Getter for Expression Base.

Returns:
Expression Base String

updateReplacementFrags

public void updateReplacementFrags(java.util.Map<java.lang.String,oracle.jbo.AttributeDef> listBindingNames,
                                   java.util.Map<java.lang.String,oracle.jbo.AttributeDef> lovNames,
                                   java.util.Map<java.lang.String,oracle.jbo.AttributeDef> checkBoxAttrs,
                                   java.util.Map<java.lang.String,org.w3c.dom.DocumentFragment> replaceLOVJSFfragMap,
                                   org.w3c.dom.DocumentFragment widgetFrag,
                                   java.lang.String documentRef,
                                   oracle.adf.view.rich.dt.Page page)
Updates Doc . with the Replacement fragment.

Parameters:
listBindingNames - Map for Attribute Defs for list bindings
lovNames - Mapfor attributeDefs for LOVs
replaceLOVJSFfragMap - Mpa for document fragments for LOVs which will be used as replacement fragment
widgetFrag - as Document Fragment
page - as Page
documentRef - as pageDef name

updateReplacementFragsforTable

public void updateReplacementFragsforTable(java.util.Map<java.lang.String,oracle.jbo.AttributeDef> listBindingNames,
                                           java.util.Map<java.lang.String,oracle.jbo.AttributeDef> lovNames,
                                           java.util.Map<java.lang.String,org.w3c.dom.DocumentFragment> replaceLOVJSFfragMap,
                                           org.w3c.dom.Element widgetFrag,
                                           oracle.adf.view.rich.dt.Page page)
For each of the LOV attributes, replace the errorneously created text component with the generated LOVs.

Parameters:
lovNames - - Map of LOV attributes
replaceLOVJSFfragMap - - Map with replacement fragments for LOV
widgetFrag - - the Element that is generated by the native APIs
page - - Page object so we can update the document

getTableRowExpression

public java.lang.String getTableRowExpression(java.lang.String attrName,
                                              java.lang.String suffix)
JSFExpressionUtils already has utilities to generate certain jsf element properties. This method uses that to create the hints for the header.

Parameters:
attrName - - attribute for which the property is being build
suffix - - end part to be added to the expression
Returns:
formatted property string

updateWithTable

public void updateWithTable(org.w3c.dom.Element appsTable,
                            oracle.adf.view.rich.dt.Page page,
                            java.lang.String tag,
                            java.lang.String tagId,
                            UIModelerContext modelerContext)
Updates the content delivery attribute for a table. Also, if not this does not come in with a PANELBOX tag, then customize it.

Parameters:
appsTable - - Table Element
page - - required to update the document
tag - - incoming tag
tagId - - tag to look for if incoming tag is null

initFlexSetupIcons

public static void initFlexSetupIcons(org.w3c.dom.Document viewDoc,
                                      java.lang.String flexCode,
                                      java.lang.String appCode,
                                      java.lang.String flexNameTranslated,
                                      java.lang.String flexDescription)

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-05

Copyright © 2012 Oracle. All Rights Reserved.