Packagecom.esri.baserver.tasks.utilities
Classpublic final class GetMRIGroupsTask
InheritanceGetMRIGroupsTask Inheritance BAServerTask Inheritance BATask Inheritance AbstractTask Inheritance flash.events.EventDispatcher

The Get MRI Groups task gets the list of all available MRI groups.

The Mediamark Research, Inc. (MRI) groups can be used with the Understanding Target Customers task to understand defined target segments.

The result of this task is an array of String items containing names of all available MRI groups.

View the examples

See also

UnderstandingTargetCustomersTask


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAServerTask
 Inheritedconcurrency : String
Value that indicates how to handle multiple calls to the same task.
AbstractTask
 InheriteddisableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from being loaded from the browser's cache.
AbstractTask
 InheritedisFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false).
BAServerTask
  lastResult : Array
[read-only] The last result of executing the Get MRI Groups task.
GetMRIGroupsTask
 InheritedproxyURL : String
The URL to proxy the request through.
AbstractTask
 InheritedrequestTimeout : Number
The request timeout in seconds.
AbstractTask
 InheritedshowBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing.
AbstractTask
 Inheritedtoken : String
Token for accessing a secure task.
AbstractTask
 InheritedtokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires.
BATask
 Inheritedurl : String
URL of the task.
AbstractTask
Public Methods
 MethodDefined By
  
GetMRIGroupsTask(urlOrClient:Object = null)
Creates a new instance of the GetMRIGroupsTask class.
GetMRIGroupsTask
  
createCommand(commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
GetMRIGroupsTask
  
[static] Creates parameters of this task in order to execute it with a generic or batch task.
GetMRIGroupsTask
  
execute(responder:IResponder = null):AsyncToken
Sends a request for executing a Get MRI Groups task to the Business Analyst Server HTTP (REST) Service.
GetMRIGroupsTask
Events
 Event Summary Defined By
 InheritedThe fault event is dispatched when an asynchronous execution of a Community Analyst Task fails.BATask
 InheritedThe taskCompleted event is dispatched when an asynchronous execution of a Community Analyst Task successfully completes.BATask
Public Constants
 ConstantDefined By
  name : String = GetMRIGroups
[static] Task name.
GetMRIGroupsTask
Property Detail
lastResultproperty
lastResult:Array  [read-only]

The last result of executing the Get MRI Groups task. This array contains items of the String type.


Implementation
    public function get lastResult():Array
Constructor Detail
GetMRIGroupsTask()Constructor
public function GetMRIGroupsTask(urlOrClient:Object = null)

Creates a new instance of the GetMRIGroupsTask class.

A new task can be constructed in two ways: as a task sharing a BAServerClient type instance with other tasks (the urlOrClient parameter has the BAServerClient type) or as a standalone task encapsulating its own client.

The base URL to the Business Analyst Server HTTP Service looks as follows:

http://{host}:{port}/ArcGIS/baserver/REST/services/DefaultMap/BAServer

The {host} and {port} parameters in this URL should be substituted with valid Business Analyst Server host name and port, respectively.

Parameters
urlOrClient:Object (default = null) — A variable containing either Business Analyst Server HTTP Service base URL string or an instance of the BAServerClient class.

See also

Method Detail
createCommand()method
public function createCommand(commandName:String = null):BACommand

Creates a new command encapsulating this task and the given parameters.

Parameters

commandName:String (default = null) — Command name.

Returns
BACommand — A new command.
createParameters()method 
public static function createParameters():IBATaskParameters

Creates parameters of this task in order to execute it with a generic or batch task.

Returns
IBATaskParameters — Parameters of this task.

See also

execute()method 
public function execute(responder:IResponder = null):AsyncToken

Sends a request for executing a Get MRI Groups task to the Business Analyst Server HTTP (REST) Service.

A response can be received in two ways—in an optional responder object passed in parameters of this method and/or in listeners of fault and taskCompleted events registered for this task.

The responder is notified first when a response is received and parsed. Its fault method receives a parameter of the FaultEvent type and its result method receives a parameter of the BATaskCompletedEvent type whose result property contains the result object. After that the received event is dispatched to listeners of this task.

If a response is succesfully received and parsed, the result is assigned to the lastResult property of this task.

Parameters

responder:IResponder (default = null) — A responder to call on result or fault.

Returns
AsyncToken — Asynch token associated with the response.
Constant Detail
nameConstant
public static const name:String = GetMRIGroups

Task name.

Examples
ActionScript to execute a Get MRI Groups task:
     
     getMRIGroupsTask.execute(new Responder(resultHandler, faultHandler));