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

E22562-05

oracle.apps.fnd.applcore.flex.runtime.util.common.category
Class CategoryDef

java.lang.Object
  extended by oracle.apps.fnd.applcore.flex.runtime.util.common.category.CategoryDef
Direct Known Subclasses:
CategoryContextDef

public class CategoryDef
extends java.lang.Object

Author:
ssarnoba

Nested Class Summary
 class CategoryDef.MetadataQueryParams
           
 
Field Summary
static int ADFBC_USAGES_COLLECTION
           
static int CATEGORY_CONTEXTS_COLLECTION
           
static int CONTEXT_USAGES_COLLECTION
           
static int CONTEXTS_COLLECTION
           
static int FLEX_USAGES_COLLECTION
           
static int TABLE_USAGES_COLLECTION
           
static java.lang.String UNDETERMINED
           
static java.lang.String UNDETERMINED_CATAGEORY_CODE
           
 
Constructor Summary
protected CategoryDef(oracle.jbo.ApplicationModule metadataAm, oracle.jbo.ApplicationModule categoryMetadataAm, java.lang.String applicationId, java.lang.String categoryCode, java.lang.String dffCode, CategoryDef parentCategoryDef, EffCustomizations customizations, ApplicationResources appRes, boolean isCloned, CategoryConfig categoryConfig)
           
 
Method Summary
protected  void addBcArtifactsToDefImpl(BcArtifactCategory deAdfbcInstance, BcArtifactCategory wsAdfbcInstance, BcArtifactCategory csAdfbcInstance, BcArtifactCategory gsAdfbcInstance, BcArtifactCategory itfAdfbcInstance, BcArtifactCategory itcAdfbcInstance, oracle.jbo.Row adfBcUsageRow, java.lang.String tableUsageType)
           
 void addCategoryContextDef(CategoryContextDef ccDef)
           
 void addEffGroup(java.lang.String effGroupCode, boolean isInterface)
           
 void addPersistedDef(java.lang.String persistedDefName, oracle.jbo.mom.PersistableDefObject def)
           
 void addPrimaryAdfbcUsageRow(oracle.jbo.Row row)
           
 void addPrimaryAdfbcUsageRowInterface(oracle.jbo.Row row)
           
 void addPrimaryFlexUsageRow(oracle.jbo.Row row)
           
 void addPrimaryTableUsageRow(oracle.jbo.Row row)
           
 void addPrimaryTableUsageRowInterface(oracle.jbo.Row row)
           
 void addSubtypeCategoryDef(CategoryDef subtypeCdef)
           
 boolean artifactsCreated()
           
static CategoryDef createCategoryDef(oracle.jbo.ApplicationModule metadataAm, oracle.jbo.ApplicationModule categoryMetadataSvcAm, java.lang.String applicationId, java.lang.String categoryCode, java.lang.String dffCode, ApplicationResources appRes, EffCustomizations customizations, CategoryDef parentCategoryDef, boolean isCloned, CategoryConfig categoryConfig)
           
 void defineAndAddArtifactsForAdfbcUsageRow(oracle.jbo.Row adfBcUsageRow, java.lang.String tableUsageType)
           
 boolean defineDeclVoFromScratch()
           
 boolean descendantCategoriesDetermined()
           
 oracle.jbo.server.PDefApplicationModule findAmPdef(java.lang.String baseAmDefPersonalizationFullName)
           
 boolean flexMetadataIsQueried()
           
 boolean generateDeclarativeJbos()
           
 boolean generateInterfaceJbos()
           
 boolean generateWebServiceJbos()
           
 java.util.ArrayList<BcArtifactCategory> getAllBCArtifacts()
           
 java.util.List<CategoryDef> getAllSubtypeCategories()
           
 java.lang.String getApplicationId()
           
 java.lang.Long getApplicationIdLong()
           
 java.lang.Object getArtifact(java.lang.String flexUsageCode, int functionCode, java.lang.String effGroupCode)
           
 java.util.List<BcArtifactCategory> getBcArtifacts(int functionCode, java.lang.String effGroupCode)
           
 java.util.Map<java.lang.Integer,java.util.List<BcArtifactCategory>> getBcArtifacts(java.lang.String effGroupCode)
           
 java.lang.String getCategoryCode()
           
 CategoryConfig getCategoryConfig()
           
 CategoryContextDef getCategoryContextDef(java.lang.String contextCode)
           
 java.util.Set<CategoryContextDef> getCategoryContextDefs()
           
 oracle.jbo.ApplicationModule getCategoryMetadataAm()
           
 java.lang.String getCategoryName()
           
 CategoryDef getChildCategoryDefOnMainPath()
           
 ApplicationResources getConnectionUrl()
           
 EffCustomizations getCustomizations()
           
static java.lang.String getDeclarativeVoDefFullname(oracle.jbo.Row adfBcUsageRow)
           
 EffCustomizations getEffCustomizations()
           
static java.lang.String getEffGroupCode(oracle.jbo.Row adfBcUsageRow)
           
 java.util.List<java.lang.String> getEffGroupCodes(int functionCode)
           
 java.util.List<java.lang.String> getEffGroupCodesInterface()
           
 java.util.List<java.lang.String> getEffGroupCodesNonInterface()
           
 java.lang.String getFlexfieldCode()
           
static java.lang.String getFlexUsageCode(oracle.jbo.Row adfBcUsageRow)
           
 oracle.jbo.ApplicationModule getMetadataAm()
           
 java.util.Map<oracle.jbo.Row,java.lang.String> getMetadataForCloning()
           
 CategoryDef.MetadataQueryParams getMetadataQueryParams()
           
 EFFBCModelerNaming getNamingScheme()
           
 java.util.List<CategoryDef> getOtherDescendantCategoryDefs()
           
protected static java.lang.String getPackageName(oracle.jbo.Row adfBcUsageRow)
           
 java.lang.String getParentCategoryCode()
           
 CategoryDef getParentCategoryDef()
           
 java.lang.String getParentCategoryName()
           
 Persistables getPersistables()
           
 java.util.HashMap getPersistedDefsMap()
           
protected static java.lang.String getPrefixName(oracle.jbo.Row adfBcUsageRow)
           
 oracle.jbo.Row getPrimaryAdfbcUsageRow(int functionCode, java.lang.String effGroupCode)
           
 oracle.jbo.Row getPrimaryAdfbcUsageRow(java.lang.String effGroupCode)
           
 oracle.jbo.Row getPrimaryAdfbcUsageRowInterface(java.lang.String effGroupCode)
           
 oracle.jbo.Row getPrimaryAdfbcUsageRows(java.lang.String entityGroupName)
           
 oracle.jbo.Row getPrimaryAdfbcUsageRowsInterface(java.lang.String effGroupCode)
           
 oracle.jbo.Row getPrimaryFlexUsageRows()
           
 BcArtifactCategory getPrimaryInstance(int functionCode, java.lang.String effGroupCode)
           
 oracle.jbo.Row getPrimaryTableUsageRows()
           
 oracle.jbo.Row getPrimaryTableUsageRowsInterface()
           
 ServiceEnabler getServiceEnabler()
           
 java.util.Collection<CategoryDef> getSiblingPlusSiblingChildrenCategoryDefs()
           
protected static java.lang.String getTableUsageCode(oracle.jbo.Row adfBcUsageRow)
           
 FlexfieldXSDGenerator getXsdGenerator()
           
 boolean isCategoryProcessedInPreviousRun()
           
 boolean isCloned()
           
 boolean isFlexMetadataQuerySuccessful()
           
 boolean isJboBuildSuccessful(int functionCode)
           
 boolean isPrimaryAdfbcUsageRowInterface(oracle.jbo.Row adfbcUsageRow)
           
 boolean isPrimaryFlexUsageUsageRow(oracle.jbo.Row flexUsageRow)
           
 boolean isPrimaryTableUsageRow(oracle.jbo.Row tableUsageRow)
           
 boolean isPrimaryTableUsageRowInterface(oracle.jbo.Row tableUsageRow)
           
static boolean isPrimaryUsageLevel(oracle.jbo.Row adfBcUsageRow, java.lang.String primaryFlexUsageCode)
           
 boolean isSubtypeCategoriesDetermined()
           
 boolean isUndeterminedCategory()
           
 void saveMetadataForCloning(java.util.Map<oracle.jbo.Row,java.lang.String> adfbcUsageRowToUsageType)
           
 void setArtifactsCreated()
           
 void setCategoryAMsPersisted()
           
protected  void setCategoryMetadataAm(oracle.jbo.ApplicationModule _categoryMetadataAm)
           
 void setCategoryProcessedInPreviousRun(boolean categoryProcessedInPreviousRun)
           
 void setCategoryVOsPersistedOrPersistDelayed()
           
 void setDescendantCategories(java.util.List<CategoryDef> descendantCdefs, CategoryDef childCategoryDefOnMainPath)
           
 void setJboBuildOutcomeSucceeded(int functionCode, boolean succeeded)
           
 void setMetadataAm(oracle.jbo.ApplicationModule am)
           
 void setMetadataIsQueried()
           
 void setMetadataQueryFlags(java.lang.String flexUsageCode, boolean restrictByFlexUsage, boolean tableTypeIsInterface, boolean restrictByTableType, boolean restrictByEntityGroup, java.lang.String effGroupCode)
           
 void setMetadataQuerySuccessfulAndValidate()
           
 void setPrimaryFlexUsageRow(oracle.jbo.Row primaryFlexfieldUsageRow)
           
 void setPrimaryTableUsageRow(oracle.jbo.Row primaryTableUsageRow, boolean isInterface)
           
 void setSiblingPlusSiblingChildrenCategories(java.util.List<CategoryDef> descendantCdefs)
           
 void setSubtypeCategoriesDetermined(boolean val)
           
 java.lang.String toString()
           
static CategoryDef undeterminedParentCategoryDef()
           
 void validate(boolean afterDefiningJbos)
           
 void validate(boolean afterDefiningJbos, boolean afterDefiningArtifacts, boolean afterQueryingFlexMetadata)
           
 void validateAfterCreatingHeader()
           
 boolean vosPersistedOrPersistDelayed()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FLEX_USAGES_COLLECTION

public static final int FLEX_USAGES_COLLECTION
See Also:
Constant Field Values

ADFBC_USAGES_COLLECTION

public static final int ADFBC_USAGES_COLLECTION
See Also:
Constant Field Values

CONTEXTS_COLLECTION

public static final int CONTEXTS_COLLECTION
See Also:
Constant Field Values

CONTEXT_USAGES_COLLECTION

public static final int CONTEXT_USAGES_COLLECTION
See Also:
Constant Field Values

TABLE_USAGES_COLLECTION

public static final int TABLE_USAGES_COLLECTION
See Also:
Constant Field Values

CATEGORY_CONTEXTS_COLLECTION

public static final int CATEGORY_CONTEXTS_COLLECTION
See Also:
Constant Field Values

UNDETERMINED_CATAGEORY_CODE

public static final java.lang.String UNDETERMINED_CATAGEORY_CODE
See Also:
Constant Field Values

UNDETERMINED

public static final java.lang.String UNDETERMINED
See Also:
Constant Field Values
Constructor Detail

CategoryDef

protected CategoryDef(oracle.jbo.ApplicationModule metadataAm,
                      oracle.jbo.ApplicationModule categoryMetadataAm,
                      java.lang.String applicationId,
                      java.lang.String categoryCode,
                      java.lang.String dffCode,
                      CategoryDef parentCategoryDef,
                      EffCustomizations customizations,
                      ApplicationResources appRes,
                      boolean isCloned,
                      CategoryConfig categoryConfig)
Method Detail

undeterminedParentCategoryDef

public static CategoryDef undeterminedParentCategoryDef()

defineAndAddArtifactsForAdfbcUsageRow

public void defineAndAddArtifactsForAdfbcUsageRow(oracle.jbo.Row adfBcUsageRow,
                                                  java.lang.String tableUsageType)

setCategoryMetadataAm

protected void setCategoryMetadataAm(oracle.jbo.ApplicationModule _categoryMetadataAm)

getApplicationId

public java.lang.String getApplicationId()

getApplicationIdLong

public java.lang.Long getApplicationIdLong()

getCategoryCode

public java.lang.String getCategoryCode()

getFlexfieldCode

public java.lang.String getFlexfieldCode()

getMetadataAm

public oracle.jbo.ApplicationModule getMetadataAm()

setMetadataAm

public void setMetadataAm(oracle.jbo.ApplicationModule am)

getCategoryMetadataAm

public oracle.jbo.ApplicationModule getCategoryMetadataAm()

getCategoryName

public java.lang.String getCategoryName()

isPrimaryUsageLevel

public static boolean isPrimaryUsageLevel(oracle.jbo.Row adfBcUsageRow,
                                          java.lang.String primaryFlexUsageCode)

getPackageName

protected static java.lang.String getPackageName(oracle.jbo.Row adfBcUsageRow)
Parameters:
adfBcUsageRow - - representing a row from the table FND_DF_ADFBC_USAGES
Returns:
- e.g "oracle.apps.ego.flex.item"
Since:
2008-08-01

getPrefixName

protected static java.lang.String getPrefixName(oracle.jbo.Row adfBcUsageRow)

getTableUsageCode

protected static java.lang.String getTableUsageCode(oracle.jbo.Row adfBcUsageRow)

getFlexUsageCode

public static java.lang.String getFlexUsageCode(oracle.jbo.Row adfBcUsageRow)

getParentCategoryName

public java.lang.String getParentCategoryName()

getParentCategoryCode

public java.lang.String getParentCategoryCode()

getDeclarativeVoDefFullname

public static java.lang.String getDeclarativeVoDefFullname(oracle.jbo.Row adfBcUsageRow)

addBcArtifactsToDefImpl

protected void addBcArtifactsToDefImpl(BcArtifactCategory deAdfbcInstance,
                                       BcArtifactCategory wsAdfbcInstance,
                                       BcArtifactCategory csAdfbcInstance,
                                       BcArtifactCategory gsAdfbcInstance,
                                       BcArtifactCategory itfAdfbcInstance,
                                       BcArtifactCategory itcAdfbcInstance,
                                       oracle.jbo.Row adfBcUsageRow,
                                       java.lang.String tableUsageType)
Parameters:
deAdfbcInstance - - could be null
wsAdfbcInstance - - could be null
csAdfbcInstance - - could be null
gsAdfbcInstance - - could be null
itfAdfbcInstance - - could be null
adfBcUsageRow -
tableUsageType -

getBcArtifacts

public java.util.Map<java.lang.Integer,java.util.List<BcArtifactCategory>> getBcArtifacts(java.lang.String effGroupCode)

getAllBCArtifacts

public java.util.ArrayList<BcArtifactCategory> getAllBCArtifacts()

isPrimaryFlexUsageUsageRow

public boolean isPrimaryFlexUsageUsageRow(oracle.jbo.Row flexUsageRow)

setPrimaryFlexUsageRow

public void setPrimaryFlexUsageRow(oracle.jbo.Row primaryFlexfieldUsageRow)

isPrimaryTableUsageRow

public boolean isPrimaryTableUsageRow(oracle.jbo.Row tableUsageRow)

setPrimaryTableUsageRow

public void setPrimaryTableUsageRow(oracle.jbo.Row primaryTableUsageRow,
                                    boolean isInterface)

getConnectionUrl

public ApplicationResources getConnectionUrl()

getPrimaryTableUsageRowsInterface

public oracle.jbo.Row getPrimaryTableUsageRowsInterface()

getPrimaryTableUsageRows

public oracle.jbo.Row getPrimaryTableUsageRows()

getPrimaryFlexUsageRows

public oracle.jbo.Row getPrimaryFlexUsageRows()

getPrimaryAdfbcUsageRows

public oracle.jbo.Row getPrimaryAdfbcUsageRows(java.lang.String entityGroupName)

getParentCategoryDef

public CategoryDef getParentCategoryDef()

addPrimaryAdfbcUsageRow

public void addPrimaryAdfbcUsageRow(oracle.jbo.Row row)

addPrimaryAdfbcUsageRowInterface

public void addPrimaryAdfbcUsageRowInterface(oracle.jbo.Row row)

addPrimaryTableUsageRow

public void addPrimaryTableUsageRow(oracle.jbo.Row row)

addPrimaryTableUsageRowInterface

public void addPrimaryTableUsageRowInterface(oracle.jbo.Row row)

addPrimaryFlexUsageRow

public void addPrimaryFlexUsageRow(oracle.jbo.Row row)

isPrimaryTableUsageRowInterface

public boolean isPrimaryTableUsageRowInterface(oracle.jbo.Row tableUsageRow)

isPrimaryAdfbcUsageRowInterface

public boolean isPrimaryAdfbcUsageRowInterface(oracle.jbo.Row adfbcUsageRow)

getPrimaryAdfbcUsageRowsInterface

public oracle.jbo.Row getPrimaryAdfbcUsageRowsInterface(java.lang.String effGroupCode)

getPersistables

public Persistables getPersistables()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

addCategoryContextDef

public void addCategoryContextDef(CategoryContextDef ccDef)

getCategoryContextDefs

public java.util.Set<CategoryContextDef> getCategoryContextDefs()

createCategoryDef

public static CategoryDef createCategoryDef(oracle.jbo.ApplicationModule metadataAm,
                                            oracle.jbo.ApplicationModule categoryMetadataSvcAm,
                                            java.lang.String applicationId,
                                            java.lang.String categoryCode,
                                            java.lang.String dffCode,
                                            ApplicationResources appRes,
                                            EffCustomizations customizations,
                                            CategoryDef parentCategoryDef,
                                            boolean isCloned,
                                            CategoryConfig categoryConfig)

validate

public void validate(boolean afterDefiningJbos)

validate

public void validate(boolean afterDefiningJbos,
                     boolean afterDefiningArtifacts,
                     boolean afterQueryingFlexMetadata)
Parameters:
afterDefiningJbos - - after DT@Rt
afterDefiningArtifacts - - after creating BcArtifact lists (which comes after querying flex metadata)

getCategoryContextDef

public CategoryContextDef getCategoryContextDef(java.lang.String contextCode)

getPrimaryAdfbcUsageRowInterface

public oracle.jbo.Row getPrimaryAdfbcUsageRowInterface(java.lang.String effGroupCode)

getPrimaryAdfbcUsageRow

public oracle.jbo.Row getPrimaryAdfbcUsageRow(java.lang.String effGroupCode)

getPrimaryInstance

public BcArtifactCategory getPrimaryInstance(int functionCode,
                                             java.lang.String effGroupCode)
                                      throws NoSuchArtifactException
Throws:
NoSuchArtifactException

getPrimaryAdfbcUsageRow

public oracle.jbo.Row getPrimaryAdfbcUsageRow(int functionCode,
                                              java.lang.String effGroupCode)

findAmPdef

public oracle.jbo.server.PDefApplicationModule findAmPdef(java.lang.String baseAmDefPersonalizationFullName)

generateDeclarativeJbos

public boolean generateDeclarativeJbos()

setCategoryVOsPersistedOrPersistDelayed

public void setCategoryVOsPersistedOrPersistDelayed()

setCategoryAMsPersisted

public void setCategoryAMsPersisted()

vosPersistedOrPersistDelayed

public boolean vosPersistedOrPersistDelayed()

setJboBuildOutcomeSucceeded

public void setJboBuildOutcomeSucceeded(int functionCode,
                                        boolean succeeded)

isJboBuildSuccessful

public boolean isJboBuildSuccessful(int functionCode)

generateWebServiceJbos

public boolean generateWebServiceJbos()

generateInterfaceJbos

public boolean generateInterfaceJbos()

defineDeclVoFromScratch

public boolean defineDeclVoFromScratch()

getNamingScheme

public EFFBCModelerNaming getNamingScheme()

getEffCustomizations

public EffCustomizations getEffCustomizations()

getCustomizations

public EffCustomizations getCustomizations()

saveMetadataForCloning

public void saveMetadataForCloning(java.util.Map<oracle.jbo.Row,java.lang.String> adfbcUsageRowToUsageType)

getMetadataForCloning

public java.util.Map<oracle.jbo.Row,java.lang.String> getMetadataForCloning()

isCloned

public boolean isCloned()

isFlexMetadataQuerySuccessful

public boolean isFlexMetadataQuerySuccessful()

setMetadataQuerySuccessfulAndValidate

public void setMetadataQuerySuccessfulAndValidate()

isUndeterminedCategory

public boolean isUndeterminedCategory()

setDescendantCategories

public void setDescendantCategories(java.util.List<CategoryDef> descendantCdefs,
                                    CategoryDef childCategoryDefOnMainPath)

getChildCategoryDefOnMainPath

public CategoryDef getChildCategoryDefOnMainPath()

descendantCategoriesDetermined

public boolean descendantCategoriesDetermined()

getOtherDescendantCategoryDefs

public java.util.List<CategoryDef> getOtherDescendantCategoryDefs()

validateAfterCreatingHeader

public void validateAfterCreatingHeader()

getArtifact

public java.lang.Object getArtifact(java.lang.String flexUsageCode,
                                    int functionCode,
                                    java.lang.String effGroupCode)

getBcArtifacts

public java.util.List<BcArtifactCategory> getBcArtifacts(int functionCode,
                                                         java.lang.String effGroupCode)

getEffGroupCodesInterface

public java.util.List<java.lang.String> getEffGroupCodesInterface()

getEffGroupCodesNonInterface

public java.util.List<java.lang.String> getEffGroupCodesNonInterface()

getEffGroupCode

public static java.lang.String getEffGroupCode(oracle.jbo.Row adfBcUsageRow)

setMetadataIsQueried

public void setMetadataIsQueried()

flexMetadataIsQueried

public boolean flexMetadataIsQueried()

addEffGroup

public void addEffGroup(java.lang.String effGroupCode,
                        boolean isInterface)

getEffGroupCodes

public java.util.List<java.lang.String> getEffGroupCodes(int functionCode)

setMetadataQueryFlags

public void setMetadataQueryFlags(java.lang.String flexUsageCode,
                                  boolean restrictByFlexUsage,
                                  boolean tableTypeIsInterface,
                                  boolean restrictByTableType,
                                  boolean restrictByEntityGroup,
                                  java.lang.String effGroupCode)
Parameters:
restrictByFlexUsage - - set this to false if you need the primary flex usage info

getMetadataQueryParams

public CategoryDef.MetadataQueryParams getMetadataQueryParams()

getCategoryConfig

public CategoryConfig getCategoryConfig()

getServiceEnabler

public ServiceEnabler getServiceEnabler()

addSubtypeCategoryDef

public void addSubtypeCategoryDef(CategoryDef subtypeCdef)

getAllSubtypeCategories

public java.util.List<CategoryDef> getAllSubtypeCategories()

getSiblingPlusSiblingChildrenCategoryDefs

public java.util.Collection<CategoryDef> getSiblingPlusSiblingChildrenCategoryDefs()

setSiblingPlusSiblingChildrenCategories

public void setSiblingPlusSiblingChildrenCategories(java.util.List<CategoryDef> descendantCdefs)

setCategoryProcessedInPreviousRun

public void setCategoryProcessedInPreviousRun(boolean categoryProcessedInPreviousRun)

isCategoryProcessedInPreviousRun

public boolean isCategoryProcessedInPreviousRun()

setArtifactsCreated

public void setArtifactsCreated()

artifactsCreated

public boolean artifactsCreated()

getXsdGenerator

public FlexfieldXSDGenerator getXsdGenerator()

isSubtypeCategoriesDetermined

public boolean isSubtypeCategoriesDetermined()

setSubtypeCategoriesDetermined

public void setSubtypeCategoriesDetermined(boolean val)

addPersistedDef

public void addPersistedDef(java.lang.String persistedDefName,
                            oracle.jbo.mom.PersistableDefObject def)

getPersistedDefsMap

public java.util.HashMap getPersistedDefsMap()

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

E22562-05

Copyright © 2012 Oracle. All Rights Reserved.