Packageorg.springextensions.actionscript.ioc.factory.support
Interfacepublic interface IObjectDefinitionRegistry
SubinterfacesIXMLObjectFactory
ImplementorsDefaultListableObjectFactory

Defines the interface for an object definition registry. This interface contains add methods needed to work with object definitions.

Authors: Christophe Herreman, Erik Westra
Version: $Revision: 21 $, $Date: 2008-11-01 22:58:42 +0100 (za, 01 nov 2008) $, $Author: dmurat $
Since: 0.1



Public Properties
 PropertyDefined by
  allowObjectDefinitionOverriding : Boolean
Whether to allow re-registration of a different definition with the same name
IObjectDefinitionRegistry
Public Methods
 MethodDefined by
  
containsObjectDefinition(objectName:String):Boolean
Determines if an object definition with the given name exists
IObjectDefinitionRegistry
  
Returns the object definition registered with the given name.
IObjectDefinitionRegistry
  
registerObjectDefinition(objectName:String, obectDefinition:IObjectDefinition):void
Will register the given objectDefinition with the given name.
IObjectDefinitionRegistry
  
removeObjectDefinition(objectName:String):void
Removes the definition with the given name from the registry
IObjectDefinitionRegistry
Property detail
allowObjectDefinitionOverridingproperty
allowObjectDefinitionOverriding:Boolean  [read-write]

Whether to allow re-registration of a different definition with the same name

The default value is true.

Implementation
    public function get allowObjectDefinitionOverriding():Boolean
    public function set allowObjectDefinitionOverriding(value:Boolean):void
Method detail
containsObjectDefinition()method
public function containsObjectDefinition(objectName:String):Boolean

Determines if an object definition with the given name exists

Parameters
objectName:String — The name/id of the object definition

Returns
Boolean
getObjectDefinition()method 
public function getObjectDefinition(objectName:String):IObjectDefinition

Returns the object definition registered with the given name. If the object definition does not exist undefined will be returned.

Parameters
objectName:String — The name/id of the definition to retrieve

Returns
IObjectDefinition — The registered object definition, or undefined if the definition has not been registered.
registerObjectDefinition()method 
public function registerObjectDefinition(objectName:String, obectDefinition:IObjectDefinition):void

Will register the given objectDefinition with the given name. If the allowObjectDefinitionOverriding has been set to true, this method will remove the existing object.

Parameters
objectName:String — The name under which the object definition should be stored
 
obectDefinition:IObjectDefinition — The object definition that should be stored
removeObjectDefinition()method 
public function removeObjectDefinition(objectName:String):void

Removes the definition with the given name from the registry

Parameters
objectName:String — The name/id of the definition to remove