Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.1.0)

E17483-02

oracle.jbo.server
Class ComponentObjectImpl

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.server.NamedObjectImpl
          extended by oracle.jbo.server.ComponentObjectImpl
All Implemented Interfaces:
ComponentObject, ExprWrappable, GenericHints, OperationContainer, Properties, VariableManagerOwner, VariableManagerOwnerBase
Direct Known Subclasses:
AssociationReference, ContainerObjectImpl, EntityCache, RowReference, ViewLinkImpl, ViewObjectImpl

public class ComponentObjectImpl
extends NamedObjectImpl
implements ComponentObject, VariableManagerOwner, OperationContainer

Abstract class for ComponentObjectImpl. Users need to extend this class to plug generic components in Business Components for Java Framework


Field Summary
 
Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX
 
Fields inherited from interface oracle.jbo.GenericHints
PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP
 
Constructor Summary
ComponentObjectImpl()
           
 
Method Summary
 void addListener(ComponentObjectListener listener)
          Add a listener for the Component Object
 void applyPersonalization()
           
protected  void create()
           
static ComponentObjectImpl createRef(java.lang.String name, DefObject bo)
           
protected  VariableValueManager createVariableValueManager(VariableManagerOwnerBase owner, VariableManager[] varMgrParents)
           
 VariableValueManager ensureVariableManager()
          Returns this object's Variable Value Manager.
 OperationDefinitions findOperationDefinitions()
           
protected  PersDefBase findPersDefObject()
           
 java.util.HashMap getAllProperties(java.util.HashMap map, LocaleContext locale)
           
 ApplicationModule getApplicationModule()
          Gets the parent Application Module that contains this component object.
protected  java.util.Vector getCompListeners()
          Gets the list of component Object listeners.
protected  java.util.ArrayList getCompListenersList()
          Gets the list of component Object listeners.
 java.lang.String getDefFullName()
          Gets the Full Name of the Def Object.
protected  DefinitionManager getDefinitionManager()
           
 java.lang.String getDefName()
          Gets the name of the Def Object.
protected  java.lang.String getFullNameForPersDef()
           
 java.lang.String getHintValue(LocaleContext locale, java.lang.String sHintName)
          Return hint value based on the hint name
 java.lang.String getLabel(LocaleContext locale)
          Retrieves the label to be used in any attribute prompts
 java.lang.String getLabelPlural(LocaleContext locale)
          Retrives the LabelPlural text to be used for this attribute
 java.lang.Class getMessageBundleClass()
           
 java.lang.String getProxyClassName()
          Gets the Proxy class name for the corresponding deployment platform.
protected  java.lang.String getProxyClassName(java.lang.String platform)
          Gets the proxy class name for a deplyoment platform.
 ResourceBundleDef getResourceBundleDef()
           
 ApplicationModuleImpl getRootApplicationModule()
          Gets the root application module implementation.
protected  java.lang.String getStringFromMessageBundle(java.lang.String property, LocaleContext locale, boolean tryNamedProperty)
          internal only for framework use.
 java.lang.String getTooltip(LocaleContext locale)
          Retrives the tooltip text to be used for this attribute
 VariableValueManager getVariableManager()
          Returns this object's current Variable Value Manager.
 boolean hasVariables()
          Returns a flag indicating whether this object has Variables or not.
 boolean isDead()
           
 boolean isPersonalized()
           
 boolean isRegWithPiggyMan()
          Is component registered with Piggy back Manager
 void remove()
          Deletes this component.
protected  java.lang.Object resolvePropertyRaw(java.lang.String property, LocaleContext locale)
           
 void setName(java.lang.String name)
          Name this object.
protected  void setParent(NamedObjectImpl parent)
          Sets this object's parent.
protected  void setProxyClassName(java.lang.String platform, java.lang.String proxyClassName)
          Set the name value pair for internal map
 
Methods inherited from class oracle.jbo.server.NamedObjectImpl
setParent, setPropertiesMap
 
Methods inherited from class oracle.jbo.common.NamedObjectImpl
allocatePropertyMap, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getPropertyMap, getResourcesFromBundle, isPropertyExpression, mergePropertyMap, refreshProperty, removeProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setFullName, setPropertiesMap2, setProperty, setProperty, setPropertyExpression, setPropertyMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.ComponentObject
getFullName, getName
 
Methods inherited from interface oracle.jbo.Properties
getProperties, getProperty, getProperty, refreshProperty
 
Methods inherited from interface oracle.jbo.VariableManagerOwner
getName
 

Constructor Detail

ComponentObjectImpl

public ComponentObjectImpl()
Method Detail

getCompListenersList

protected java.util.ArrayList getCompListenersList()
Gets the list of component Object listeners.

Returns:
Vector for the list of listeners

getCompListeners

protected java.util.Vector getCompListeners()
Gets the list of component Object listeners.

Returns:
Vector for the list of listeners

getRootApplicationModule

public final ApplicationModuleImpl getRootApplicationModule()
Gets the root application module implementation.

Returns:
ApplicationModuleImpl

createRef

public static ComponentObjectImpl createRef(java.lang.String name,
                                            DefObject bo)
Parameters:
name - the reference object name.
bo - the object to be referenced.
Returns:
the reference object created.

getFullNameForPersDef

protected java.lang.String getFullNameForPersDef()
Returns:
fullName that will be used to lookup the pers def object. This is protected for ADFm bean structures so that they can lookup an alternate pers def since their ViewDef name is runtime generated.
For internal use only. Application developers should not use this

getDefinitionManager

protected DefinitionManager getDefinitionManager()

findPersDefObject

protected PersDefBase findPersDefObject()

applyPersonalization

public void applyPersonalization()

isPersonalized

public boolean isPersonalized()

create

protected void create()

getDefName

public java.lang.String getDefName()
Gets the name of the Def Object.

Specified by:
getDefName in interface ComponentObject
Returns:
Name of the Def Object

getDefFullName

public java.lang.String getDefFullName()
Gets the Full Name of the Def Object.

Specified by:
getDefFullName in interface ComponentObject
Returns:
a class name.

remove

public void remove()
Deletes this component.

Specified by:
remove in interface ComponentObject

isDead

public boolean isDead()

getStringFromMessageBundle

protected java.lang.String getStringFromMessageBundle(java.lang.String property,
                                                      LocaleContext locale,
                                                      boolean tryNamedProperty)
Description copied from class: NamedObjectImpl
internal only for framework use.

Overrides:
getStringFromMessageBundle in class NamedObjectImpl

getProxyClassName

public java.lang.String getProxyClassName()
Gets the Proxy class name for the corresponding deployment platform.

Returns:
the String proxy class name

getApplicationModule

public ApplicationModule getApplicationModule()
Gets the parent Application Module that contains this component object. If the object has no parent, it return null. For example, if you call this method on a root AM, it will return null.

Returns:
ApplicationModule or null if the component object has no parent.

getProxyClassName

protected java.lang.String getProxyClassName(java.lang.String platform)
Gets the proxy class name for a deplyoment platform.

Parameters:
platform - deployment platform
Returns:
name of the proxy class

setProxyClassName

protected void setProxyClassName(java.lang.String platform,
                                 java.lang.String proxyClassName)
Set the name value pair for internal map

Parameters:
platform - the name of the platform as a String.
proxyClassName - the name of the proxy class as a String.

isRegWithPiggyMan

public boolean isRegWithPiggyMan()
Is component registered with Piggy back Manager

Returns:
boolean

getLabel

public java.lang.String getLabel(LocaleContext locale)
Description copied from interface: GenericHints
Retrieves the label to be used in any attribute prompts

Specified by:
getLabel in interface GenericHints

getLabelPlural

public java.lang.String getLabelPlural(LocaleContext locale)
Description copied from interface: GenericHints
Retrives the LabelPlural text to be used for this attribute

Specified by:
getLabelPlural in interface GenericHints

getTooltip

public java.lang.String getTooltip(LocaleContext locale)
Description copied from interface: GenericHints
Retrives the tooltip text to be used for this attribute

Specified by:
getTooltip in interface GenericHints

getHintValue

public java.lang.String getHintValue(LocaleContext locale,
                                     java.lang.String sHintName)
Description copied from interface: GenericHints
Return hint value based on the hint name

Specified by:
getHintValue in interface GenericHints

addListener

public void addListener(ComponentObjectListener listener)
Add a listener for the Component Object

Parameters:
listener - a listener for the component object

setName

public void setName(java.lang.String name)
Name this object.

Overrides:
setName in class NamedObjectImpl
Parameters:
name - the name to be given to this object.
For internal use only. Application developers should not use this

setParent

protected void setParent(NamedObjectImpl parent)
Sets this object's parent.

Parameters:
parent - the named object that is to be the parent of this object.

getVariableManager

public VariableValueManager getVariableManager()
Description copied from interface: VariableManagerOwnerBase
Returns this object's current Variable Value Manager. It will return null if Variable Value Manager has been initialized.

When a framework object is first created, its Variable Value Manager may be null. This method does not initialize (create) the Variable Value Manager.

VariableManagerOwnerBase.ensureVariableManager() in contrast, ensures that the Variable Value Manager is initialized (created).

Specified by:
getVariableManager in interface VariableManagerOwnerBase
Returns:
this object's current Variable Value Manager. May return null if one was not yet initialized.

hasVariables

public boolean hasVariables()
Description copied from interface: VariableManagerOwnerBase
Returns a flag indicating whether this object has Variables or not.

Specified by:
hasVariables in interface VariableManagerOwnerBase
Returns:
the flag indicating whether this object has Variables.

ensureVariableManager

public VariableValueManager ensureVariableManager()
Description copied from interface: VariableManagerOwnerBase
Returns this object's Variable Value Manager. If this object current has no Variable Value Manager, it will initialize (create) one.

Specified by:
ensureVariableManager in interface VariableManagerOwnerBase
Returns:
this object's Variable Value Manager. Will create a Variable Value Manager if this object had no Variable Value Manager.

createVariableValueManager

protected VariableValueManager createVariableValueManager(VariableManagerOwnerBase owner,
                                                          VariableManager[] varMgrParents)

resolvePropertyRaw

protected java.lang.Object resolvePropertyRaw(java.lang.String property,
                                              LocaleContext locale)
Overrides:
resolvePropertyRaw in class NamedObjectImpl

getAllProperties

public java.util.HashMap getAllProperties(java.util.HashMap map,
                                          LocaleContext locale)
Overrides:
getAllProperties in class NamedObjectImpl

getMessageBundleClass

public java.lang.Class getMessageBundleClass()
Specified by:
getMessageBundleClass in interface VariableManagerOwnerBase

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()
Specified by:
getResourceBundleDef in interface VariableManagerOwnerBase

findOperationDefinitions

public OperationDefinitions findOperationDefinitions()
Specified by:
findOperationDefinitions in interface OperationContainer

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.1.0)

E17483-02

Copyright © 1997, 2011, Oracle. All rights reserved.