ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.ep.ux.content.services.search.lccontent 

IQueryService  - AS3 ADEP Content

Packagecom.adobe.ep.ux.content.services.search.lccontent
Interfacepublic interface IQueryService

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Query Service Interface for doing Adobe Digital Enterprise Platform Experience Services - Content Repository specific searches.



Public Methods
 MethodDefined By
  
fillAdvanced(itemCollection:ListCollectionView, searchFilters:IList, dataService:DataService, searchParameters:SearchParameters, baseEntityName:String, assetDescList:IList, sortFields:IList = null):mx.rpc:AsyncToken
Populates the itemCollection by calling the backend Dataservice.fill() method.
IQueryService
  
Retrieves the type name of the QueryService.
IQueryService
  
Releases any item within the specified collection from management by this service.
IQueryService
  
Resets the current state of QueryService implementation object.
IQueryService
Method Detail

fillAdvanced

()method
public function fillAdvanced(itemCollection:ListCollectionView, searchFilters:IList, dataService:DataService, searchParameters:SearchParameters, baseEntityName:String, assetDescList:IList, sortFields:IList = null):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Populates the itemCollection by calling the backend Dataservice.fill() method. The parameters of the fill method are prepared by prepareQueryParams(). DataService instance should already have authenticated channelSet in case authentication is required at back end Data Server.

Parameters

itemCollection:ListCollectionView — Specifies the collection in which search results are populated.
 
searchFilters:IList — Specifies the list of search filter based on which search query is fired.
 
dataService:DataService — Specifies the Data Service instance on which fill is called.
 
searchParameters:SearchParameters — Specifies the various parameters on which search is performed.
 
baseEntityName:String — Specifies the name of the base asset on which search is performed.
 
assetDescList:IList — Specifies the Asset Descriptors list which contains the list of assets on which search is performed.
 
sortFields:IList (default = null) — Specifies the list of SortField on which sorting is to be done in the search result.

Returns
mx.rpc:AsyncToken — AsyncToken The asynchronous token to attach result and fault handler to handle the results of the call.

getQueryTypeName

()method 
public function getQueryTypeName():String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Retrieves the type name of the QueryService. For example, LCQuery.

Returns
String — A string constant that indicates the type of search.

releaseSearchResults

()method 
public function releaseSearchResults(resultsListView:ListCollectionView, dataService:DataService):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Releases any item within the specified collection from management by this service.

Parameters

resultsListView:ListCollectionView — Specifies the managed search results collection which has to be released.
 
dataService:DataService — Specifies the Data Service instance on which collection is released.

reset

()method 
public function reset():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Resets the current state of QueryService implementation object. The QueryService object has state in terms of parameters prepared by the prepareQueryParams() method.