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

E22562-02

oracle.apps.fnd.applcore.oaext.model
Class OAEntityDefImpl

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.mom.DefinitionObject
          extended by oracle.jbo.mom.PersistableDefObject
              extended by oracle.jbo.server.DefObject
                  extended by oracle.jbo.server.MetaObject
                      extended by oracle.jbo.server.RowDef
                          extended by oracle.jbo.server.EntityDefImpl
                              extended by oracle.apps.fnd.applcore.oaext.model.OAEntityDefImpl
All Implemented Interfaces:
oracle.jbo.common.ResourceBundleOwner, oracle.jbo.ExprValueSupplier, oracle.jbo.ExprWrappable, oracle.jbo.mom.xml.DefPersistable, oracle.jbo.mom.xml.PersistentDefinition, oracle.jbo.rules.ValidationManager, oracle.jbo.server.AttributeDependencyManager, oracle.jbo.server.OperationDefinitionContainer, oracle.jbo.StructureDef, oracle.jbo.VariableManagerOwner, oracle.jbo.VariableManagerOwnerBase
Direct Known Subclasses:
FndLabelEODefImpl, FndNodeEODefImpl, FndTreeEODefImpl, FndTreeStructureEODefImpl, FndTreeVersionEODefImpl, KFFMEntityDefImpl

public class OAEntityDefImpl
extends oracle.jbo.server.EntityDefImpl

Defines the metadata of an entity object which describes that object's structure.


Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject
oracle.jbo.mom.PersistableDefObject.CustomizationType, oracle.jbo.mom.PersistableDefObject.PersonalizationType
 
Field Summary
static byte PATTERN_ROW_STRIPING
          Set Id Row Striping partitioning pattern type In this pattern the SET_ID column is just a striping column and is not part of the unique keys for the table.
static byte PATTERN_ROW_STRIPING_COMMON
          Set Id Row Striping with Common Rows partitioning pattern type This is exactly the same as the Row Striping pattern with the exception that a special partition will be common to all other partitions.
static byte PATTERN_SETID_SUBSCRIPTION
          Set Id Set Membership Child Table partitioning pattern type.
static java.lang.String RCS_ID
          Oracle Applications internal source control identifier.
 
Fields inherited from class oracle.jbo.server.EntityDefImpl
DBOBJ_TYPE_OBJTAB, DBOBJ_TYPE_OBJTYP, DBOBJ_TYPE_TABLE, DBOBJ_TYPE_VIEW, EFFECTIVE_DATE_TYPE_DATED, EFFECTIVE_DATE_TYPE_EFFECTIVE_DATED, EFFECTIVE_DATE_TYPE_NONE, mAssocAccessors, mAssocs, mAttrAccessors, mBatchThreshold, mFKeys, mIsObjectTable, mOIDAttribute, mPrimaryKeys, mSource, mSourceType
 
Fields inherited from class oracle.jbo.server.RowDef
mAliasName, mBindingStyle
 
Fields inherited from class oracle.jbo.server.MetaObject
mComponentClass
 
Fields inherited from class oracle.jbo.mom.DefinitionObject
DEF_MDS_CLIENT_KEY, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY, PROPERTY_EXPRMAP
 
Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX
 
Fields inherited from interface oracle.jbo.mom.xml.DefPersistable
XML_STATEMENT
 
Constructor Summary
OAEntityDefImpl()
          Constructs a default entity definition.
OAEntityDefImpl(int defScope, java.lang.String name)
          Constructs an entity definition of a specific scope.
 
Method Summary
protected  void finishedLoading()
           
protected  void finishTLMetaDataLoading()
           
protected  oracle.jbo.server.AttributeDefImpl getAttributeDefImplByColumnName(java.lang.String colName)
          
 java.lang.String getBaseTableName()
           
 oracle.jbo.server.AttributeDefImpl getChangeIndicatorColumn()
          Returns the AttributeDef for the Change Indicator column for the datasource.
protected  oracle.jbo.server.ComponentOperations getComponentOperations()
           
 oracle.jbo.AttributeDef[] getDeterminantAttributeDefs()
          Returns an array of determinant attribute definitions defined on the entity.
 oracle.jbo.AttributeDef getDeterminantAttributeForReference(oracle.jbo.AttributeDef foreignKey)
          Returns the attribute definiton of the determinant attribute which drives the Set Id of the passed foreign key reference.
 java.lang.String getDeterminantAttributeType(oracle.jbo.AttributeDef determinantAttr)
          Returns the type of the determinant attribute.
protected  java.lang.String getEffectiveClientProxyClassName()
           
protected  java.lang.String getEffectiveComponentInterfaceName()
           
 java.lang.String getReferenceGroupName()
          Returns the reference group name.
 oracle.jbo.AttributeDef getSetIdAttributeDef()
          Returns the attribute def of the Set Id attribute which should be named as 'SetId'.
 byte getSetIdPattern()
          Returns the Set Id pattern used by this reference.
 java.lang.String getSubscriptionTableName()
          Returns the subscription name used by the Set Id pattern SETID_SUBSCRIPTION_TABLE.
 boolean hasDocSeqColumns()
           
protected  boolean hasLOBAttrs()
           
 boolean isSetIdEnabled()
          Indicates if the EO is Set Id enabled reference.
 boolean isTranslatable()
           
protected static void loadFromXML(oracle.jbo.mom.xml.DefElement arg0, oracle.jbo.server.RemotableCompDef arg1)
           
protected  void loadOperationDefinitions(oracle.jbo.mom.xml.DefElement arg0)
           
protected  void loadProperties(oracle.jbo.mom.xml.DefElement xmlElement)
           
 void resolveDefObject()
           
 
Methods inherited from class oracle.jbo.server.EntityDefImpl
addAssocAccessor, addAttribute, addAttributeOfKind, addEntityAssociation, addEventAttr, addPropertyChangeListener, addPropertyChangeListener, addTrigger, addUniqueKeyValidation, addUniqueKeyValidator, addUniquePKValidation, addValidator, addVetoableChangeListener, addVetoableChangeListener, addVetoableChangeListener, checkEntityLocked, createAltKey, createBlankInstance, createBlankInstance2, createDef, createEntityDef, createInstance, createInstance2, createKey, findAttributeDef, findByAltKey, findByPKExtended, findByPrimaryKey, findDefObject, findDefObjectNoSub, findInCacheByAltKeyExtended, findInCacheByPKExtended, findInCacheByPrimaryKey, getAllDefNames, getAllEntityInstances, getAllEntityInstancesIterator, getAllExtendedDefObjects, getAssociationDefImpl, getAssociationDefImpl, getAssociationDefImpls, getAttributeCount, getAttributeDef, getAttributeDefImpl, getAttributeDefImpl, getAttributeDefImpls, getAttributeDefs, getBaseComponentClass, getBatchThreshold, getChangeIndicatorColumn2, getCollClass, getColumnNameForQuery, getCreateEvents, getCurrentSequencedRowChar, getDataSecurityAttribute, getDefTypeId, getDefXMLElementTag, getDeleteEvents, getEffDtNextRowsVOName, getEffDtPreviousRowsVOName, getEffectiveDateSequenceAttr, getEffectiveDateSequenceFlagAttr, getEffectiveDateTransientAttr, getEffectiveDateTransientAttrName, getEffectiveDateType, getEffectiveEndDateAttr, getEffectiveStartDateAttr, getEJBAppProviderURL, getEJBHome, getEJBHomeJNDIName, getEntityAssociations, getEventDef, getEventNamespace, getEventParentAttrs, getEventPayloadNamespace, getEventTransAttrs, getExtendedDefObjects, getExtendedDefObjectsInternal, getForeignKeyAttrs, getHintValue, getLowestEffDtSequenceValue, getMaxAttrConst, getNextEffSequenceRowsVOName, getOIDAttribute, getOwnerRowType, getPermissionDef, getPrevEffSequenceRowsVOName, getPrimaryKeys, getPriorSequencedRowChar, getProperty, getQuery, getRawAttributeDefs, getRefAttrIndex, getRetrievedOnInsertAttributes, getRetrievedOnInsertPrimaryKeys, getRetrievedOnUpdateAttributes, getRetrievedOnUpdatePrimaryKeys, getRowClass, getSelectClause, getSelectClause, getSource, getSourceType, getTriggersOfType, getUniqueKeys, getUpdateEvents, getValidators, hasDataSecurity, hasEffectiveDateSequence, isAssociationAccessorRetained, isEffectiveDated, isObjectTable, isOIDInPrimaryKey, isRefPKBased, isRowIDPrimaryKey, isSingleUseKeyStatement, isUpdatable, isUpdateChangedColumns, isUseGlueCode, isUseReturningClause, loadAttribute, loadCustomDef, loadFromXML, loadViewAccessors, loadXMLContents, lookupAttributeDef, lookupValidator, newInstance, newInstance2, removePropertyChangeListener, removePropertyChangeListener, removeTrigger, removeValidator, removeVetoableChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, resolveReferences, setAssociationAccessorRetained, setBatchThreshold, setChangeIndicatorColumn, setCollClass, setDefForComponent, setEffectiveDateType, setEJBAppProviderURL, setEJBHomeJNDIName, setEventNamespace, setEventPayloadNamespace, setOwnerRowType, setPermissionDef, setRefPKBased, setRowClass, setSingleUseKeyStatement, setSource, setSourceType, setUpdatable, setUpdateChangedColumns, setUseGlueCode, setUseReturningClause, unsetDefForComponent, writeChildren, writeContents
 
Methods inherited from class oracle.jbo.server.RowDef
addAltKey, addExtendedDefObject, addForwardDependency, addForwardDependency, addListBindingDef, addListBindingDef, addViewAccessorDef, appendBindingNameForAttr, appendBindingSpec, appendBindingSpec, discrValuesQualify, findAltKeyDef, findAttrDefIncludingPDef, findDefForDiscrValues, findListBindingDef, findViewAccessorDef, getAliasName, getAllProperties, getAltKeyAttrDefs, getAltKeyAttrDefs, getAltKeyCount, getAltKeyDef, getAltKeyIndex, getAltKeyNames, getAttributeIndexOf, getBackwardDependencies, getBackwardDependencyAttributes, getBindingStyle, getDataSourceDef, getDefFullName, getDefName, getDiscrColumns, getExprVarVal, getForwardDependencies, getForwardDependencyAttributes, getListBindingDefs, getViewAccessorDefs, loadListBindings, loadViewAccessor, lookupAltKeyDef, lookupListBindingDef, lookupViewAccessorDef, registerDefObject, removeAltKey, removeListBindingDef, removeViewAccessorDef, resolvePropertyRaw, setAliasName, setBindingStyle, setDiscrColumns, setExprVarVal, setThrowOnListBindingMismatch, throwOnListBindingMismatch, verifyExtendedDefObjects, writeXMLContents
 
Methods inherited from class oracle.jbo.server.MetaObject
deregisterSessionObject, getMessageBundleClass, getMsgBundleDef, getPackageDef, getPackageName, getPersDef, getPersDefNoUpdateCheck, getResourceBundleDef, getResourcePrefix, isDynamic, loadResourceBundle, registerSessionDefObject, setMessageBundleClass, setResourceBundleDef
 
Methods inherited from class oracle.jbo.server.DefObject
ensureVariableManager, getBaseDefObject, getDefXMLNameSpace, getVariableManager, getVarMgrParents, hasVariables, loadVariables, setBaseDefObject, setBaseDefObject, setName, setParent
 
Methods inherited from class oracle.jbo.mom.PersistableDefObject
addDefImport, allocatePropertyMap, checkEditable, close, createFromXML, findDefImport, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefWriter, getEditObject, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getOrigObject, getPropertyMap, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isNew, isPersonalizationEnabled, isPersonalizationEnabled, loadDefImports, mergePropertyMap, objectRemoved, reapplyChanges, reapplyChangesToChildren, reapplyChangesToContents, registerClass, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, updateChildrenList, verifyVersion, writeObject, writeVersion
 
Methods inherited from class oracle.jbo.mom.DefinitionObject
addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getContainerDef, getContainerName, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, isBaseDefFor, isDynamicDefinitionObject, isObjectResolved, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName, suppressUpdateCheck
 
Methods inherited from class oracle.jbo.common.NamedObjectImpl
getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getPropertyExpressionsMap, getResourcesFromBundle, getStringFromMessageBundle, isPropertyExpression, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setFullName, setPropertiesMap, setPropertiesMap2, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.StructureDef
getAttributeIndexOf, getDefFullName, getDefName, getFullName, getName
 
Methods inherited from interface oracle.jbo.rules.ValidationManager
getFullName, getName, getResourceBundleDef
 
Methods inherited from interface oracle.jbo.VariableManagerOwner
getName
 
Methods inherited from interface oracle.jbo.mom.xml.DefPersistable
getFullName
 

Field Detail

RCS_ID

public static final java.lang.String RCS_ID
Oracle Applications internal source control identifier.

See Also:
Constant Field Values

PATTERN_ROW_STRIPING

public static final byte PATTERN_ROW_STRIPING
Set Id Row Striping partitioning pattern type In this pattern the SET_ID column is just a striping column and is not part of the unique keys for the table. The filtration is simply done using: WHERE SET_ID = :1

See Also:
Constant Field Values

PATTERN_ROW_STRIPING_COMMON

public static final byte PATTERN_ROW_STRIPING_COMMON
Set Id Row Striping with Common Rows partitioning pattern type This is exactly the same as the Row Striping pattern with the exception that a special partition will be common to all other partitions. This common partition (Set) will be using the reserved SET_ID=0. The filtration is simply done using: WHERE SET_ID IN (:1, 0)

See Also:
Constant Field Values

PATTERN_SETID_SUBSCRIPTION

public static final byte PATTERN_SETID_SUBSCRIPTION
Set Id Set Membership Child Table partitioning pattern type. The filtration is done by joining with the child table and filtering by SET_ID: WHERE PARENT.PK1=CHILD.PK1 AND CHILD.SET_ID = :1

See Also:
Constant Field Values
Constructor Detail

OAEntityDefImpl

public OAEntityDefImpl()
Constructs a default entity definition.


OAEntityDefImpl

public OAEntityDefImpl(int defScope,
                       java.lang.String name)
Constructs an entity definition of a specific scope.

Parameters:
defScope - the definition scope
name - the name
Method Detail

getBaseTableName

public java.lang.String getBaseTableName()

isTranslatable

public boolean isTranslatable()

resolveDefObject

public void resolveDefObject()
Overrides:
resolveDefObject in class oracle.jbo.server.EntityDefImpl

finishedLoading

protected void finishedLoading()
Overrides:
finishedLoading in class oracle.jbo.server.EntityDefImpl

finishTLMetaDataLoading

protected void finishTLMetaDataLoading()

hasDocSeqColumns

public boolean hasDocSeqColumns()

isSetIdEnabled

public boolean isSetIdEnabled()
Indicates if the EO is Set Id enabled reference.

Returns:
boolean

getReferenceGroupName

public java.lang.String getReferenceGroupName()
Returns the reference group name.

Returns:
reference group name

getSetIdPattern

public byte getSetIdPattern()
Returns the Set Id pattern used by this reference.

Returns:
Set Id pattern which can be: ROW_STRIPING, ROW_STRIPING_COMMON, or SETID_SUBSCRIPTION.

getSubscriptionTableName

public java.lang.String getSubscriptionTableName()
Returns the subscription name used by the Set Id pattern SETID_SUBSCRIPTION_TABLE.

Returns:
subscription table name used by the Set Id pattern SETID_SUBSCRIPTION_TABLE.

getDeterminantAttributeDefs

public oracle.jbo.AttributeDef[] getDeterminantAttributeDefs()
Returns an array of determinant attribute definitions defined on the entity.

Returns:
array of AttributeDef determinant types

getDeterminantAttributeType

public java.lang.String getDeterminantAttributeType(oracle.jbo.AttributeDef determinantAttr)
Returns the type of the determinant attribute.

Parameters:
determinantAttr - The determinant attribute definition.
Returns:
the type of the determinant which could be: BU, RR, LED, LED, ...

getSetIdAttributeDef

public oracle.jbo.AttributeDef getSetIdAttributeDef()
Returns the attribute def of the Set Id attribute which should be named as 'SetId'.

Returns:
the attribute definition of the Set Id attribute

getDeterminantAttributeForReference

public oracle.jbo.AttributeDef getDeterminantAttributeForReference(oracle.jbo.AttributeDef foreignKey)
Returns the attribute definiton of the determinant attribute which drives the Set Id of the passed foreign key reference.

Parameters:
foreignKey - The foreign key of the Set Id enabled reference.
Returns:
the determinant attribute name.

loadProperties

protected void loadProperties(oracle.jbo.mom.xml.DefElement xmlElement)
Overrides:
loadProperties in class oracle.jbo.server.DefObject

hasLOBAttrs

protected boolean hasLOBAttrs()
Overrides:
hasLOBAttrs in class oracle.jbo.server.EntityDefImpl

getAttributeDefImplByColumnName

protected oracle.jbo.server.AttributeDefImpl getAttributeDefImplByColumnName(java.lang.String colName)

Overrides:
getAttributeDefImplByColumnName in class oracle.jbo.server.EntityDefImpl

getChangeIndicatorColumn

public oracle.jbo.server.AttributeDefImpl getChangeIndicatorColumn()
Returns the AttributeDef for the Change Indicator column for the datasource. It returns null if the the column does not exist.

The Change Indicator column is used, in some applications, to indicate changes in the underlying row in the datastore. It usually takes the form of a Timestamp or a Counter and, is compared at change time, against the value in the cache, to check for consistency.

Overrides:
getChangeIndicatorColumn in class oracle.jbo.server.EntityDefImpl
Returns:
the Change Indicator column or null if none exists.

getEffectiveClientProxyClassName

protected java.lang.String getEffectiveClientProxyClassName()

getEffectiveComponentInterfaceName

protected java.lang.String getEffectiveComponentInterfaceName()

loadFromXML

protected static void loadFromXML(oracle.jbo.mom.xml.DefElement arg0,
                                  oracle.jbo.server.RemotableCompDef arg1)

getComponentOperations

protected oracle.jbo.server.ComponentOperations getComponentOperations()

loadOperationDefinitions

protected void loadOperationDefinitions(oracle.jbo.mom.xml.DefElement arg0)

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

E22562-02

Copyright © 2011 Oracle. All Rights Reserved.