Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.data 
ManagedQuery 
Packagemx.data
Classpublic class ManagedQuery
InheritanceManagedQuery Inheritance ManagedOperation Inheritance Object

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

Use an instance of this class to define a query which is managed by the DataManagement system. A managed query places the items returned under data management.



Public Properties
 PropertyDefined By
  addItemToCollectionOperation : String
These addItemToCollectionOperation and removeItemFromCollectionOperation are optional operations which let you define a function to be invoked as an item is added to or removed from a collection.
ManagedQuery
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedconvertResults : Boolean = true
Turns on/off conversion of result element types.
ManagedOperation
  countOperation : String
Name of an operation on the service taking the same parameters as this operation which returns the number of items in the query.
ManagedQuery
 InheriteddataManager : RPCDataManager
Each ManagedOperation should be a child of an RPCDataManager tag.
ManagedOperation
 Inheritedignore : Boolean = false
It may be useful in some cases to ignore a particular managed operation.
ManagedOperation
 Inheritedname : String
Name of the operation in the service which this is managing.
ManagedOperation
 Inheritedoperation : AbstractOperation
Stores the service's operation which we are using for this managed operation.
ManagedOperation
  pageSize : int
Page size for this query when paging is enabled.
ManagedQuery
  pagingEnabled : Boolean
Set this to true to enable paging.
ManagedQuery
 Inheritedparameters : String
A usually optional metadata value which stores the comma separated list of parameter names for this operation.
ManagedOperation
  positionalPagingParameters : Boolean = false
When paging is enabled, your operation on the server must take a start and count parameters to define the subset of the items to return.
ManagedQuery
  propertySpecifier : String
A string of the form "a,b,c" which lists the property names of the managed item returned by this query.
ManagedQuery
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  removeItemFromCollectionOperation : String
These addItemToCollectionOperation and removeItemFromCollectionOperation are optional operations which let you define a function to be invoked as an item is added to or removed from a collection.
ManagedQuery
 InheritedresultElementType : Class
For operations which return a multi-valued response, this specifies the type of the elements of the Array or ArrayCollection.
ManagedOperation
 InheritedresultType : Class
The class of the return type for this operation.
ManagedOperation
 Inheritedtype : String
Represents the type of the managed operation.
ManagedOperation
Public Methods
 MethodDefined By
  
ManagedQuery(nameParam:String = null, typeParam:String = "query")
Builds a ManagedQuery.
ManagedQuery
 Inherited
Disables data management for this operation.
ManagedOperation
 Inherited
Enables data management for this operation if it has been disabled previously.
ManagedOperation
 Inherited
Indicates whether an object has a specified property defined.
Object
  
[override] Initializes the managed operation throwing errors for any configuration problems that are encountered along the way.
ManagedQuery
 Inherited
Invokes the operation on the real service without any management.
ManagedOperation
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

addItemToCollectionOperation

property
public var addItemToCollectionOperation:String

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

These addItemToCollectionOperation and removeItemFromCollectionOperation are optional operations which let you define a function to be invoked as an item is added to or removed from a collection. In many cases, the membership of items in the query is determined implicitly - i.e. by the property values so the server does not need to handle these operations. In those cases, they are ignored. Use these methods in case you are explicitly managing an association table which relates the item to a particular collection.

countOperation

property 
public var countOperation:String

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

Name of an operation on the service taking the same parameters as this operation which returns the number of items in the query. Use this if you enable paging to get the accurate collection size. If you don't define a count operation, the system uses a dynamic sizing mode which fetches the items in the collection one page at a time leaving an empty slot at the end. If you do not access that empty slot, the next page is not fetched. When you do access that slot, the next page is fetched and the collection size is increased until there are no more remaining items in the query.

pageSize

property 
pageSize:int

Page size for this query when paging is enabled.



Implementation
    public function get pageSize():int
    public function set pageSize(value:int):void

pagingEnabled

property 
public var pagingEnabled:Boolean

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

Set this to true to enable paging. When paging is enabled, your operation on the server must take a start and count parameters to define the subset of the items to return. You do not provide these to the service when you call the operation - they are added automatically as the system will fetch pages from your server on-demand - i.e. in response to getItemAt calls. Those calls take an optional prefetch parameter which lets you control the number of items fetched on a given call.

positionalPagingParameters

property 
public var positionalPagingParameters:Boolean = false

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

When paging is enabled, your operation on the server must take a start and count parameters to define the subset of the items to return. You do not provide these to the service when you call the operation - they are added automatically as the system will fetch pages from your server on-demand - i.e. in response to getItemAt calls. Those calls take an optional prefetch parameter which lets you control the number of items fetched on a given call. By default the start and count parameters must be called "startIndex" and "numItems" and may appear anywhere in the signature of your operation. Setting this flag to true will lift the naming restriction on these two parameters, but will require that they appear as the last two parameters to the operation - the second to last parameter will be interpreted as the start parameter and the last as the count parameter.

propertySpecifier

property 
propertySpecifier:String

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

A string of the form "a,b,c" which lists the property names of the managed item returned by this query. If unset, the query should return all properties of the object.



Implementation
    public function get propertySpecifier():String
    public function set propertySpecifier(value:String):void

removeItemFromCollectionOperation

property 
public var removeItemFromCollectionOperation:String

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

These addItemToCollectionOperation and removeItemFromCollectionOperation are optional operations which let you define a function to be invoked as an item is added to or removed from a collection. In many cases, the membership of items in the query is determined implicitly - i.e. by the property values so the server does not need to handle these operations. In those cases, they are ignored. Use these methods in case you are explicitly managing an association table which relates the item to a particular collection. When an item is removed from a collection, if you want to delete that item, you do not need to use this operation. Instead, set the property deleteItemOnRemoveFromFill and the server's deleteItem operation is called automatically when the item is removed from the collection. .

Constructor Detail

ManagedQuery

()Constructor
public function ManagedQuery(nameParam:String = null, typeParam:String = "query")

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

Builds a ManagedQuery. The nameParameter specifies the name of the service's operation which this ManagedQuery is based off of. It is a required parameter but is made optional here so this class can be used in MXML.

Parameters
nameParam:String (default = null) — Name of the operation in the service which this is managing.
 
typeParam:String (default = "query") — The type of the managed query operation. Values are: 'query', or 'findItem'.
Method Detail

initialize

()method
override public function initialize():void

Initializes the managed operation throwing errors for any configuration problems that are encountered along the way.