Packagecom.adobe.fiber.valueobjects
Classpublic class AbstractEntityMetadata
InheritanceAbstractEntityMetadata Inheritance EventDispatcher Inheritance Object
Implements IModelType, IModelInstance

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

This class defines default, error throwing implementations of all of the functions declared in IModelType and IModelInstance. In addition, all generated extensions of this class will expose the following generated, per entity property API's: 
      function get property-nameStyle():IStyle

Bindable getter for the property's com.adobe.fiber.styles.IStyle instance. Return null for properties that do not have an associated style.

      function get isproperty-nameAvailable():Boolean

bindable getter for the property's available state with respect to variants. Always returns true for properties that are not inside a variant.

      function invalidateDependentproperty-name():void

Per property functions that cause all derived properties that depend on this property to be recalculated. PropertyChanged events will be fired once the calculation of each such derived property completes. Note that these functions are only generated for data properties that have dependent derived properties.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  invalidConstraints : Array
[read-only] Returns an array of currently invalid constraints or an empty array if the value object is currently valid
AbstractEntityMetadata
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  validationFailureMessages : Array
[read-only] Returns an array of localized error messages corresponding to the current set of failed constraints and validations of the value object.
AbstractEntityMetadata
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
getAssociationProperties():Array
Returns the names of all association properties.
AbstractEntityMetadata
  
getAvailableProperties():IPropertyIterator
Returns the names of all available properties of this instance as determined by variants.
AbstractEntityMetadata
  
getCollectionBase(propertyName:String):String
Gets the base type of a collection property
AbstractEntityMetadata
  
getCollectionProperties():Array
Returns the names of all collection properties.
AbstractEntityMetadata
  
getDataProperties():Array
Returns the names of all data properties for an Entity; regardless of whether they are currently available or not.
AbstractEntityMetadata
  
getDependantInvalidConstraints(propertyName:String):Array
Returns an array of currently invalid constraints whose values may change as a result of propertyName changing.
AbstractEntityMetadata
  
getDependants(propertyName:String):Array
Gets all derived properties whose values may change as a result of this date property's value changing
AbstractEntityMetadata
  
getDependedOnServices():Array
Gets the names of all services that derived properties of this entity depend on for their calculations
AbstractEntityMetadata
  
getEntityName():String
Gets the Entity's name for a given value object.
AbstractEntityMetadata
  
getGuardedProperties():Array
Returns the names of all guarded properties for an Entity; regardless of whether they are currently available or not.
AbstractEntityMetadata
  
getIdentityMap():Object
Returns a map of identity property names to their current values
AbstractEntityMetadata
  
getMappedByProperty(associationProperty:String):String
Returns the mappedBy property for the passed-in association property; returns null if the passed-in assocaition property is not mappedBy a property; returns null of the passed-in property is not an association property;
AbstractEntityMetadata
  
getProperties():Array
Returns the names of all properties for an Entity; regardless of whether they are currently available or not.
AbstractEntityMetadata
  
getPropertyLength(propertyName:String):int
Returns the length set for the passed-in property; return zero if length was not set for the property.
AbstractEntityMetadata
  
getPropertyValidationFailureMessages(propertyName:String):Array
Returns an array of localized error messages corresponding to the current set of failed validations for the given property.
AbstractEntityMetadata
  
getRequiredProperties():Array
Returns the names of all required properties.
AbstractEntityMetadata
  
getStyle(propertyName:String):IStyle
Returns style object for property.
AbstractEntityMetadata
  
getUnguardedProperties():Array
Returns the names of all unguarded properties for an Entity.
AbstractEntityMetadata
  
getValue(propertyName:String):*
Gets the value of a property
AbstractEntityMetadata
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
  
isAvailable(propertyName:String):Boolean
Determines if a property is available as is determined by variants.
AbstractEntityMetadata
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
setValue(propertyName:String, value:*):void
Sets the value of a property.
AbstractEntityMetadata
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail
invalidConstraintsproperty
invalidConstraints:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns an array of currently invalid constraints or an empty array if the value object is currently valid



Implementation
    public function get invalidConstraints():Array
validationFailureMessagesproperty 
validationFailureMessages:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns an array of localized error messages corresponding to the current set of failed constraints and validations of the value object. Return an empty array if the value object is currently valid.



Implementation
    public function get validationFailureMessages():Array
Method Detail
getAssociationProperties()method
public function getAssociationProperties():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all association properties.

Returns
Array — the names of all association properties
getAvailableProperties()method 
public function getAvailableProperties():IPropertyIterator

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all available properties of this instance as determined by variants.

Returns
IPropertyIterator — the names of all available properties of this instance as determined by variants.
getCollectionBase()method 
public function getCollectionBase(propertyName:String):String

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Gets the base type of a collection property

Parameters

propertyName:String — desired property

Returns
String — fully qualified name of the collection's base class
getCollectionProperties()method 
public function getCollectionProperties():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all collection properties.

Returns
Array — the names of all collection properties
getDataProperties()method 
public function getDataProperties():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all data properties for an Entity; regardless of whether they are currently available or not.

Returns
Array — the names of all data properties for an Entity; regardless of whether they are currently available or not.
getDependantInvalidConstraints()method 
public function getDependantInvalidConstraints(propertyName:String):Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns an array of currently invalid constraints whose values may change as a result of propertyName changing. If there are no such properties, an empty array is returned.

Parameters

propertyName:String — for which an array of dependant, invalid constraints is retrieved

Returns
Array — an array of currently invalid constraints whose values may change as a result of propertyName changing. If there are no such properties, an empty array is returned.
getDependants()method 
public function getDependants(propertyName:String):Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Gets all derived properties whose values may change as a result of this date property's value changing

Parameters

propertyName:String — name of date property to get dependants of

Returns
Array — all derived properties depending on this data propery
getDependedOnServices()method 
public function getDependedOnServices():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Gets the names of all services that derived properties of this entity depend on for their calculations

Returns
Array
getEntityName()method 
public function getEntityName():String

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Gets the Entity's name for a given value object.

Returns
String
getGuardedProperties()method 
public function getGuardedProperties():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all guarded properties for an Entity; regardless of whether they are currently available or not.

Returns
Array — the names of all guarded properties for an Entity; regardless of whether they are currently available or not.
getIdentityMap()method 
public function getIdentityMap():Object

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns a map of identity property names to their current values

Returns
Object — a map of identity property names to their current values
getMappedByProperty()method 
public function getMappedByProperty(associationProperty:String):String

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the mappedBy property for the passed-in association property; returns null if the passed-in assocaition property is not mappedBy a property; returns null of the passed-in property is not an association property;

Parameters

associationProperty:String

Returns
String — the mappedBy property for the passed-in association property; return null if the passed-in assocaition property is not mappedBy a property; return null of the passed-in property is not an association property;
getProperties()method 
public function getProperties():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all properties for an Entity; regardless of whether they are currently available or not.

Returns
Array — the names of all properties for an Entity; regardless of whether they are currently available or not.
getPropertyLength()method 
public function getPropertyLength(propertyName:String):int

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the length set for the passed-in property; return zero if length was not set for the property.

Parameters

propertyName:String

Returns
int — the length set for the passed-in property; return zero if length was not set for the property.
getPropertyValidationFailureMessages()method 
public function getPropertyValidationFailureMessages(propertyName:String):Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns an array of localized error messages corresponding to the current set of failed validations for the given property. Returns an empty array if the property currently has no failing validations.

Parameters

propertyName:String — name of property of interest.

Returns
Array — an array of localized error messages corresponding to the current set of failed validations for the given property. Return an empty array if the property currently has no failing validations.
getRequiredProperties()method 
public function getRequiredProperties():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all required properties.

Returns
Array — the names of all required properties
getStyle()method 
public function getStyle(propertyName:String):IStyle

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns style object for property.

Parameters

propertyName:String — for which associated style is retrieved.

Returns
IStyle — style object for property.
getUnguardedProperties()method 
public function getUnguardedProperties():Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the names of all unguarded properties for an Entity.

Returns
Array — the names of all unguarded properties for an Entity.
getValue()method 
public function getValue(propertyName:String):*

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Gets the value of a property

Parameters

propertyName:String — the desired property

Returns
* — the current value of propertyName for this instance
isAvailable()method 
public function isAvailable(propertyName:String):Boolean

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Determines if a property is available as is determined by variants. An error is thrown if the passed in property name is not a valid property of the value object. If you'd like to add bindings to the availability flag for a particular property, use the ispropertyNameAvailable() function - such a function will exist for every property and will support binding.

Parameters

propertyName:String — property to check for availability

Returns
Boolean — true if this property is currently available as is determined by variants
setValue()method 
public function setValue(propertyName:String, value:*):void

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the value of a property. To clear a value, set it to undefined.

Parameters

propertyName:String — property to set
 
value:* — to set property to




© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00