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

E22562-01

oracle.apps.fnd.applcore.flex.runtime.util
Class EFFBCModeler

java.lang.Object
  extended by oracle.apps.fnd.applcore.flex.runtime.util.BCModeler
      extended by oracle.apps.fnd.applcore.flex.runtime.util.AbstractBCModeler
          extended by oracle.apps.fnd.applcore.flex.runtime.util.DFFBCModeler
              extended by oracle.apps.fnd.applcore.flex.runtime.util.EFFBCModeler

public class EFFBCModeler
extends DFFBCModeler

A modeler for entensible flexfield.


Nested Class Summary
static class EFFBCModeler.EffBcModelerMode
           
 
Nested classes/interfaces inherited from class oracle.apps.fnd.applcore.flex.runtime.util.AbstractBCModeler
AbstractBCModeler.BIEntity, AbstractBCModeler.BIValueLinkInfo, AbstractBCModeler.BIViewUsageInfo, AbstractBCModeler.EntityPersonalization, AbstractBCModeler.FlattenedSegment, AbstractBCModeler.IntegerSequence, AbstractBCModeler.SegmentAttrElements, AbstractBCModeler.SegmentAttributeInfo, AbstractBCModeler.SegmentValidators, AbstractBCModeler.TokenWrapper, AbstractBCModeler.ValidatorOnCondition
 
Nested classes/interfaces inherited from class oracle.apps.fnd.applcore.flex.runtime.util.BCModeler
BCModeler.Arguments, BCModeler.Option, BCModeler.Options, BCModeler.Parameter, BCModeler.ProgressStage
 
Field Summary
static boolean _pimLogging
           
 
Fields inherited from class oracle.apps.fnd.applcore.flex.runtime.util.DFFBCModeler
RUNTIME_VERSION
 
Fields inherited from class oracle.apps.fnd.applcore.flex.runtime.util.AbstractBCModeler
_configuration, _flexfieldDef, _flexfieldEntityUsage, _modelID, _namespace, _serviceEnabler, _writer, BI_ENTITY_ALIAS, BI_EO_USAGE_NAME, SQL_STRING_WRAPPER
 
Constructor Summary
  EFFBCModeler(FlexfieldNamespace namespace, FlexfieldDef ff, FlexfieldEntityUsage usage, BCModelerWriter writer, java.util.Map<BCModeler.Option,java.lang.Object> configuration, CategoryDef categoryDef, CategoryContextDef categoryContextDef, java.lang.String categoryCode, java.lang.String contextCode, java.lang.String applicationShortName, java.lang.String dffCode, java.lang.String connUrl, boolean isInterface)
          Deprecated. This metod will be removed soon. Use one of the other constructors
protected EFFBCModeler(FlexfieldNamespace namespace, FlexfieldDef ff, FlexfieldEntityUsage usage, BCModelerWriter writer, java.util.Map<BCModeler.Option,java.lang.Object> configuration, CategoryDef categoryDef, CategoryContextDef categoryContextDef, java.lang.String categoryCode, java.lang.String contextCode, java.lang.String applicationShortName, java.lang.String dffCode, java.lang.String connUrl, boolean isInterface, EffCustomizations customizations)
          Deprecated. This metod will be removed soon. Use one of the other constructors
protected EFFBCModeler(FlexfieldNamespace namespace, FlexfieldDef ff, FlexfieldEntityUsage usage, BCModelerWriter writer, java.util.Map<BCModeler.Option,java.lang.Object> configuration, java.lang.String applicationShortName, java.lang.String dffCode, java.lang.String connUrl, boolean isInterface, EffCustomizations customizations)
           
 
Method Summary
protected  oracle.jbo.server.AttributeDefImpl addEntitySegmentAttribute(oracle.jbo.server.EntityDefImpl eoDef, SegmentDef seg, ContextValueDef contextValueDef, boolean useAltDiscriminator)
           
static boolean attrHasLov(oracle.jbo.AttributeDef attributeDef)
           
 void buildInternal()
          Builds the model.
protected  oracle.jbo.server.EntityAssociation createEntityAssociation(java.lang.String eaDefFullName, boolean multiRow, java.lang.String srcEoDefFullName, oracle.jbo.server.EntityDefImpl destEo, java.lang.String contextCode)
           
protected  oracle.jbo.server.EntityAssociation[] createEntityAssociations(ExtensibleFlexfieldEntityUsage feu, oracle.jbo.server.EntityDefImpl contextEO, java.lang.String contextCode)
          This method can have custom entity associations for the Modelers.
protected  oracle.jbo.server.ViewDefImpl createViewDefImpl(int scope, java.lang.String name, java.lang.String baseViewDefName)
           
protected  java.lang.String generateEntityAssociationReverseWhereClause(oracle.jbo.server.EntityAssociation ea, java.lang.String contextCode, oracle.jbo.server.EntityDefImpl srcEo, oracle.jbo.server.EntityDefImpl destEo)
          Generates reverse where clause for entity association(s) created by EFF BC Modeler.
static java.lang.String generateSQLExpressionForUOMAttr(java.lang.String numColName, java.lang.String entityAliasName, java.lang.String uomClass)
          This method generates the query to be used for sql derived attribute as part of the UOM setup.
protected  java.lang.String getAdditionalEODefFullName(java.lang.String flexUsageCode, boolean isInterface, java.lang.String effGroupCode)
          This method returns null for EFF BC Modeler, but returns public EO Def full name for public EO defined in PIM
 EffCustomizations getEffCustomizations()
           
protected  oracle.jbo.server.AttributeDefImpl[] getEntityAssociationDestColumns(oracle.jbo.server.EntityDefImpl destEo, oracle.jbo.server.AttributeDefImpl[] srcPkeyCols)
          Gets the attributes from the foreign EO that match those specified in the array.
protected  oracle.jbo.server.AttributeDefImpl[] getEntityAssociationSourceColumns(oracle.jbo.server.EntityDefImpl srcEo)
           
static EFFBCModeler.EffBcModelerMode getMode(BCModeler.Arguments args)
           
 ServiceEnabler getServiceEnabler()
           
protected  java.lang.String getUomUEAttributeName(java.lang.String segmentName)
          Attribute name created as "u" + + "UE"; RLAL: Changing this method accessibility from private to protected, as pim bc modeler needs to call it for pointing uom based red line attrs to ue attr.
 boolean isContextModeler()
           
static boolean isPimLoggingEnabled()
           
static boolean isUomAttrName(java.lang.String attrName)
           
protected  void setEntityAssociationCustomWhereClause(oracle.jbo.server.EntityAssociation ea, java.lang.StringBuffer sb, oracle.jbo.server.EntityDefImpl srcEo, oracle.jbo.server.EntityDefImpl destEO)
          OVERRIDABLE - TUD Setup Entity Association custom where clause to be appended by PIM BC Modeler or other implementing team.
protected  void setEntityAssociationSourceColumns(oracle.jbo.server.EntityAssociation ea, oracle.jbo.server.EntityDefImpl srcEO, oracle.jbo.server.EntityDefImpl destEO, oracle.jbo.server.AttributeDefImpl[] srcPkeyCols)
          This method will be overridden in PIM BC Modeler to use different source attributes for Child/Master and Default/Inherit cases.
static void setPimLogging(boolean _pimLogging)
           
protected static void validateColumns(oracle.jbo.server.AttributeDefImpl[] keyColumns)
           
static void workaroundHandleHistoryAttrs(oracle.jbo.server.ViewDefImpl viewDef)
           
 
Methods inherited from class oracle.apps.fnd.applcore.flex.runtime.util.DFFBCModeler
addBIPrimaryKeys, addSegmentAttribute, buildSegmentAttribute, createApplicationModuleDefImpl, createViewDefImpl, getBIAssociationInfo, getBIModelType, getFlexfieldEntity, getPropertyBoundValueMap, getVersion, isBIGlobalSegment
 
Methods inherited from class oracle.apps.fnd.applcore.flex.runtime.util.AbstractBCModeler
addBISegmentProperties, addContextNameToResourceBundle, addEntityTransientAttribute, addEntityValueSetCustomProperties, addKeyAttributes, addSegmentAttr, addSegmentAttribute, addValueSetParameterTransients, addValueSetTransients, build, buildBIApplicationModule, buildBIAssociation, buildBIEntity, buildBIEntity, buildBIViewDefAndViewLinks, buildBIViewLink, buildListDataSourceViewObjects, buildSegmentAttr, concatenate, concatenate, copySegmentAttrElements, copyTypeInfoFromEntity, createFlexfieldEntity, escapeSQLString, getAlias, getBIConcatenatedSegments, getBIEqualizationLabels, getBIFlattenedSegments, getBITransactionAMDefFullName, getDiscrValueToViewObjectMap, getEntityAttributeType, getEntityDiscrProperties, getEntityPersonalization, getEntityProperties, getEstimatedListObjWriteCount, getPackages, getPropertyBoundValue, getReport, getResourceBundleBuilder, getResourceBundleClass, getValidatorOnCondition, isDebugMode, isValueSetValueDisplaySupported, populateCommonProperties, populateDiscrViewObjectMap, populateProperties, populateProperties, populateSegmentUIHints, populateSegmentUIHints, setDebugMode, setResourceBundleClass
 
Methods inherited from class oracle.apps.fnd.applcore.flex.runtime.util.BCModeler
escapeJavaString, getFactory, getFactory, isDevelopmentMode, main, notifyAction, notifyProgress, notifyProgress, run, run, run
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_pimLogging

public static boolean _pimLogging
Constructor Detail

EFFBCModeler

protected EFFBCModeler(FlexfieldNamespace namespace,
                       FlexfieldDef ff,
                       FlexfieldEntityUsage usage,
                       BCModelerWriter writer,
                       java.util.Map<BCModeler.Option,java.lang.Object> configuration,
                       java.lang.String applicationShortName,
                       java.lang.String dffCode,
                       java.lang.String connUrl,
                       boolean isInterface,
                       EffCustomizations customizations)

EFFBCModeler

public EFFBCModeler(FlexfieldNamespace namespace,
                    FlexfieldDef ff,
                    FlexfieldEntityUsage usage,
                    BCModelerWriter writer,
                    java.util.Map<BCModeler.Option,java.lang.Object> configuration,
                    CategoryDef categoryDef,
                    CategoryContextDef categoryContextDef,
                    java.lang.String categoryCode,
                    java.lang.String contextCode,
                    java.lang.String applicationShortName,
                    java.lang.String dffCode,
                    java.lang.String connUrl,
                    boolean isInterface)
Deprecated. This metod will be removed soon. Use one of the other constructors


EFFBCModeler

protected EFFBCModeler(FlexfieldNamespace namespace,
                       FlexfieldDef ff,
                       FlexfieldEntityUsage usage,
                       BCModelerWriter writer,
                       java.util.Map<BCModeler.Option,java.lang.Object> configuration,
                       CategoryDef categoryDef,
                       CategoryContextDef categoryContextDef,
                       java.lang.String categoryCode,
                       java.lang.String contextCode,
                       java.lang.String applicationShortName,
                       java.lang.String dffCode,
                       java.lang.String connUrl,
                       boolean isInterface,
                       EffCustomizations customizations)
Deprecated. This metod will be removed soon. Use one of the other constructors

Method Detail

buildInternal

public void buildInternal()
Description copied from class: AbstractBCModeler
Builds the model.

Overrides:
buildInternal in class DFFBCModeler

getEntityAssociationSourceColumns

protected oracle.jbo.server.AttributeDefImpl[] getEntityAssociationSourceColumns(oracle.jbo.server.EntityDefImpl srcEo)

getEntityAssociationDestColumns

protected oracle.jbo.server.AttributeDefImpl[] getEntityAssociationDestColumns(oracle.jbo.server.EntityDefImpl destEo,
                                                                               oracle.jbo.server.AttributeDefImpl[] srcPkeyCols)
Gets the attributes from the foreign EO that match those specified in the array. The NAMES must match.

Parameters:
srcPkeyCols -
Returns:

createEntityAssociation

protected oracle.jbo.server.EntityAssociation createEntityAssociation(java.lang.String eaDefFullName,
                                                                      boolean multiRow,
                                                                      java.lang.String srcEoDefFullName,
                                                                      oracle.jbo.server.EntityDefImpl destEo,
                                                                      java.lang.String contextCode)

createViewDefImpl

protected oracle.jbo.server.ViewDefImpl createViewDefImpl(int scope,
                                                          java.lang.String name,
                                                          java.lang.String baseViewDefName)

addEntitySegmentAttribute

protected oracle.jbo.server.AttributeDefImpl addEntitySegmentAttribute(oracle.jbo.server.EntityDefImpl eoDef,
                                                                       SegmentDef seg,
                                                                       ContextValueDef contextValueDef,
                                                                       boolean useAltDiscriminator)

setEntityAssociationSourceColumns

protected void setEntityAssociationSourceColumns(oracle.jbo.server.EntityAssociation ea,
                                                 oracle.jbo.server.EntityDefImpl srcEO,
                                                 oracle.jbo.server.EntityDefImpl destEO,
                                                 oracle.jbo.server.AttributeDefImpl[] srcPkeyCols)
This method will be overridden in PIM BC Modeler to use different source attributes for Child/Master and Default/Inherit cases.

Parameters:
ea -
srcEO - - used in PIM BC Modeler to get different attributes
destEO - - used in PIM BC Modeler to get condition based on C_EXT_ATTR ... properties.
srcPkeyCols -

generateEntityAssociationReverseWhereClause

protected java.lang.String generateEntityAssociationReverseWhereClause(oracle.jbo.server.EntityAssociation ea,
                                                                       java.lang.String contextCode,
                                                                       oracle.jbo.server.EntityDefImpl srcEo,
                                                                       oracle.jbo.server.EntityDefImpl destEo)
Generates reverse where clause for entity association(s) created by EFF BC Modeler. In case of EFF this will return null, however PIM will override this to return a string containing the reverse where clause. TUD: Add description to TUD for PIM Uptake.

Parameters:
ea -
contextCode -
srcEo -
destEo -
Returns:

setEntityAssociationCustomWhereClause

protected void setEntityAssociationCustomWhereClause(oracle.jbo.server.EntityAssociation ea,
                                                     java.lang.StringBuffer sb,
                                                     oracle.jbo.server.EntityDefImpl srcEo,
                                                     oracle.jbo.server.EntityDefImpl destEO)
OVERRIDABLE - TUD Setup Entity Association custom where clause to be appended by PIM BC Modeler or other implementing team. SSARONBA: Here is the default EFF where clause, which we DON'T want to enforce to be present in the subclass' logic.

Parameters:
ea - the Entity Association
sb - the built association clause text
destEO - the destination entity

createEntityAssociations

protected oracle.jbo.server.EntityAssociation[] createEntityAssociations(ExtensibleFlexfieldEntityUsage feu,
                                                                         oracle.jbo.server.EntityDefImpl contextEO,
                                                                         java.lang.String contextCode)
This method can have custom entity associations for the Modelers. PIM Modeler will need an extra association from public base entity to context entity.

Parameters:
feu -
contextEO -
contextCode -
Returns:

getAdditionalEODefFullName

protected java.lang.String getAdditionalEODefFullName(java.lang.String flexUsageCode,
                                                      boolean isInterface,
                                                      java.lang.String effGroupCode)
This method returns null for EFF BC Modeler, but returns public EO Def full name for public EO defined in PIM

Parameters:
flexUsageCode - - flexfield usage code
isInterface -
effGroupCode -
Returns:
string for name of EO Def

getEffCustomizations

public EffCustomizations getEffCustomizations()

validateColumns

protected static void validateColumns(oracle.jbo.server.AttributeDefImpl[] keyColumns)

generateSQLExpressionForUOMAttr

public static java.lang.String generateSQLExpressionForUOMAttr(java.lang.String numColName,
                                                               java.lang.String entityAliasName,
                                                               java.lang.String uomClass)
This method generates the query to be used for sql derived attribute as part of the UOM setup.

Parameters:
numColName - the name of the number db column (e.g ATTRIBUTE_NUMBER1).
entityAliasName - the entity alias name for declarative (null for context).
uomClass - the uom class name.
Returns:
sql expression to be used for sql derived attribute.

getUomUEAttributeName

protected java.lang.String getUomUEAttributeName(java.lang.String segmentName)
Attribute name created as "u" + + "UE"; RLAL: Changing this method accessibility from private to protected, as pim bc modeler needs to call it for pointing uom based red line attrs to ue attr.

Parameters:
segmentName -
Returns:
The name of the UOM UE attribute corresponding to segmentName

isUomAttrName

public static boolean isUomAttrName(java.lang.String attrName)
Parameters:
attrName - - Name of attribute
Returns:
true if the attribute name follows the convention used for UOM attributes

workaroundHandleHistoryAttrs

public static void workaroundHandleHistoryAttrs(oracle.jbo.server.ViewDefImpl viewDef)

getMode

public static EFFBCModeler.EffBcModelerMode getMode(BCModeler.Arguments args)

attrHasLov

public static boolean attrHasLov(oracle.jbo.AttributeDef attributeDef)
Parameters:
attributeDef -
Returns:
true if the attribute has an LOV associated to it.

setPimLogging

public static void setPimLogging(boolean _pimLogging)

isPimLoggingEnabled

public static boolean isPimLoggingEnabled()

isContextModeler

public boolean isContextModeler()

getServiceEnabler

public ServiceEnabler getServiceEnabler()

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

E22562-01

Copyright © 2011 Oracle. All Rights Reserved.