com.adobe.fiber.valueobjects.AbstractEntityMetadata - Adobe® Flex® 4 Language Reference (Flex 4)

Package	com.adobe.fiber.valueobjects
Class	public class AbstractEntityMetadata
Inheritance	AbstractEntityMetadata EventDispatcher 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : 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
		prototype : 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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
		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.	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 data 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.	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 mapped by a property.	AbstractEntityMetadata
		getProperties():Array Returns the names of all properties for an Entity regardless of whether they are currently available.	AbstractEntityMetadata
		getPropertyLength(propertyName:String):int Returns the length set for the passed-in 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
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		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
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

invalidConstraints

property

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

validationFailureMessages

property

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. Returns 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 — 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 — 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 — Name of 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 — 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.

Returns

Array — Names of all data properties for an Entity

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 — Name of property for which an array of dependant invalid constraints is retrieved

Returns

Array — 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 data property's value changing.

Parameters

propertyName:String — Name of data 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.

Returns

Array — Names of all guarded properties for an Entity

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 — 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 mapped by 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. Returns null if the passed-in assocaition property is not mapped by a property. Returns 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.

Returns

Array — Names of all properties for an Entity

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. Returns zero if length was not set for the property.

Parameters

propertyName:String

Returns

int — Length set for the passed-in property. Returns 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 — 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.

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 — 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 — Name of property 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 — 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 — Desired property

Returns

* — 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 property name that is passed in is not a valid property of the value object. To add bindings to the availability flag for a particular property, use the ispropertyNameAvailable() function. This function exists for every property and supports 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:*` — Value to set property to