| Package | mx.data |
| Class | public class PropertySpecifier |
| Inheritance | PropertySpecifier  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 | |
| excludes : Array [read-only]
Get a list of properties to exclude, or null if no properties are excluded. | PropertySpecifier | ||
| extraProperties : Array
A list of additional properties to include. | PropertySpecifier | ||
| includeMode : int
The mode of this PropertySpecifier, determining what properties should be included. | PropertySpecifier | ||
| includeSpecifierString : String [read-only]
Returns the value for DSincludeSpec. | PropertySpecifier | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | PropertySpecifier | ||
Get an array of names of excluded properties for the object. | PropertySpecifier | ||
Get an array of names of included properties for this destination. | PropertySpecifier | ||
Obtain the specifier for an associated destination. | PropertySpecifier | ||
|
Indicates whether an object has a specified property defined. | Object | |
Check if the given property should be included based on this specifier. | PropertySpecifier | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
Returns the string representation of the specified object. | PropertySpecifier | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ALL : PropertySpecifier [static]
Reusable instance of a PropertySpecifier to include all properties of an item. | PropertySpecifier | ||
| DEFAULT : PropertySpecifier [static]
Reusable instance of a default PropertySpecifier. | PropertySpecifier | ||
| EMPTY : PropertySpecifier [static]
Reusable instance of a PropertySpecifier to include no properties. | PropertySpecifier | ||
| INCLUDE_ALL : int = 1 [static]
Special value for a PropertySpecifier mode to include all properties of an item. | PropertySpecifier | ||
| INCLUDE_DEFAULT : int = 0 [static]
Special value for a PropertySpecifier mode to include properties based on the default configuration. | PropertySpecifier | ||
| INCLUDE_DEFAULT_PLUS_LIST : int = 2 [static]
Special value for a PropertySpecifier mode to include properties based on the default configuration,
as well as additional properties specified in a list. | PropertySpecifier | ||
| INCLUDE_LIST : int = 3 [static]
Special value for a PropertySpecifier mode to include only properties specified in a list. | PropertySpecifier | ||
Property Detail
excludes | property |
excludes:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Get a list of properties to exclude, or null if no properties are excluded.
Implementation
public function get excludes():ArrayextraProperties | property |
extraProperties:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A list of additional properties to include.
Implementation
public function get extraProperties():Array public function set extraProperties(value:Array):voidincludeMode | property |
includeMode:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The mode of this PropertySpecifier, determining what properties should be included.
Implementation
public function get includeMode():int public function set includeMode(value:int):voidincludeSpecifierString | property |
Constructor Detail
PropertySpecifier | () | Constructor |
public function PropertySpecifier(dest:ConcreteDataService, mode:int, extra:Array)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parametersdest:ConcreteDataService — destination for which this property specifier should apply.
| |
mode:int — mode of property specifier. Must be one of these values:
0 (INCLUDE_DEFAULT)
1 (INCLUDE_ALL)
2 (INCLUDE_DEFAULT_PLUS_LIST)
3 (INCLUDE_LIST)
| |
extra:Array — array of additional property names to include in mode 2 and 3.
|
Method Detail
getExcluded | () | method |
public function getExcluded(item:Object):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Get an array of names of excluded properties for the object.
Parameters
item:Object — the item instance.
|
Array — an array of excluded property names or null if no properties should be excluded.
|
getIncluded | () | method |
public function getIncluded(destination:String):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Get an array of names of included properties for this destination.
Parameters
destination:String — the destination name.
|
Array — an array of included property names.
|
getSubSpecifier | () | method |
public function getSubSpecifier(item:Object, propName:String):PropertySpecifier| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Obtain the specifier for an associated destination.
Parameters
item:Object — item instance.
| |
propName:String — property name for the association.
|
PropertySpecifier — the PropertySpecifier instance to use when fetching data for the association.
|
includeProperty | () | method |
public function includeProperty(propName:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Check if the given property should be included based on this specifier.
Parameters
propName:String — name of property.
|
Boolean — true if property should be included in the result.
|
toString | () | method |
public function toString():String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the string representation of the specified object.
Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, a subclass of Object implements function toString():String instead of using an override of the base class.
String — A string representation of the object.
|
Constant Detail
ALL | Constant |
public static const ALL:PropertySpecifier| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Reusable instance of a PropertySpecifier to include all properties of an item.
DEFAULT | Constant |
public static const DEFAULT:PropertySpecifier| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Reusable instance of a default PropertySpecifier.
EMPTY | Constant |
public static const EMPTY:PropertySpecifier| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Reusable instance of a PropertySpecifier to include no properties.
INCLUDE_ALL | Constant |
public static const INCLUDE_ALL:int = 1| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Special value for a PropertySpecifier mode to include all properties of an item.
INCLUDE_DEFAULT | Constant |
public static const INCLUDE_DEFAULT:int = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Special value for a PropertySpecifier mode to include properties based on the default configuration.
INCLUDE_DEFAULT_PLUS_LIST | Constant |
public static const INCLUDE_DEFAULT_PLUS_LIST:int = 2| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Special value for a PropertySpecifier mode to include properties based on the default configuration, as well as additional properties specified in a list.
INCLUDE_LIST | Constant |
public static const INCLUDE_LIST:int = 3| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Special value for a PropertySpecifier mode to include only properties specified in a list.
Mon Nov 28 2011, 06:48 AM -08:00