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.
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: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
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
|
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.
|
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
|
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
|
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
|
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.
|
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
|
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 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 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
|
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
|
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
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.
|
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
|
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
Returns | int — Length set for the passed-in property.
Returns zero if length was not set for the property.
|
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.
|
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.
|
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
|
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
|
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
|
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
|
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
|