| Package | com.esri.drs |
| Class | public class DashboardTask |
| Inheritance | DashboardTask DRSBaseTask com.esri.ags.tasks.BaseTask |
| Property | Defined By | ||
|---|---|---|---|
![]() | createReviewerSessionLastResult : ReviewerSession
ReviewerSession returned from last call to the createReviewerSession function. | DRSBaseTask | |
| getDashboardFieldNamesLastResult : Array
Array of field names returned from last call to the getDashboardFieldNames function. | DashboardTask | ||
| getDashboardResultsLastResult : DashboardResult
A DashboardResult object instance returned from the last call to the getDashboardResults function. | DashboardTask | ||
![]() | getLifecycleStatusStringsLastResult : Array
Array of lifecycle status strings returned from last call to the getLifecycleStatusStrings function. | DRSBaseTask | |
![]() | getReviewerSessionsLastResult : Array
Array of ReviewerSession object returned from last call to the getReviewerSessions function. | DRSBaseTask | |
| Method | Defined By | ||
|---|---|---|---|
DashboardTask(url:String = null)
Constructor
| DashboardTask | ||
![]() | createReviewerSession(sessionName:String, sessionProperties:SessionProperties, responder:IResponder = null):AsyncToken
Creates a new Reviewer Session. | DRSBaseTask | |
getDashboardFieldNames(responder:IResponder = null):AsyncToken
Requests available Dashboard field names. | DashboardTask | ||
getDashboardResults(fieldName:String, filters:ReviewerFilters = null, responder:IResponder = null):AsyncToken
Requests dashboard results by fieldName. | DashboardTask | ||
![]() | getLifecycleStatusStrings(responder:IResponder = null):AsyncToken
Retrieves a list of localized lifecycle status strings from the reviewer workspace. | DRSBaseTask | |
![]() | getReviewerSessions(responder:IResponder = null):AsyncToken
Returns an array of sessions in a Reviewer workspace. | DRSBaseTask | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
![]() | Dispatched when createReviewerSession operation successfully completes. | DRSBaseTask | ||
| Dispatched when there is a problem accessing the Reviewer Map Server. | DashboardTask | |||
| Dispatched when the getDashboardFieldNames operation successfully completes. | DashboardTask | |||
| Dispatched when the getDashboardResults operation successfully completes. | DashboardTask | |||
![]() | Dispatched when getLifecycleStatusStrings operation successfully completes. | DRSBaseTask | ||
![]() | Dispatched when getReviewerSessions operation successfully completes. | DRSBaseTask | ||
| getDashboardFieldNamesLastResult | property |
getDashboardFieldNamesLastResult:ArrayArray of field names returned from last call to the getDashboardFieldNames function.
This property can be used as the source for data binding.
public function get getDashboardFieldNamesLastResult():Array public function set getDashboardFieldNamesLastResult(value:Array):voidSee also
| getDashboardResultsLastResult | property |
getDashboardResultsLastResult:DashboardResultA DashboardResult object instance returned from the last call to the getDashboardResults function.
This property can be used as the source for data binding.
public function get getDashboardResultsLastResult():DashboardResult public function set getDashboardResultsLastResult(value:DashboardResult):voidSee also
| DashboardTask | () | Constructor |
public function DashboardTask(url:String = null)Constructor
Parametersurl:String (default = null) — DataReviewerServer Server Object Extension (SOE) URL
|
var dashUrl:String = "http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer";
var task:DashboardTask = new DashboardTask(dashUrl);
| getDashboardFieldNames | () | method |
public function getDashboardFieldNames(responder:IResponder = null):AsyncTokenRequests available Dashboard field names. On completion the getDashboardFieldNamesComplete event is fired and the optional responder is called.
Parameters
responder:IResponder (default = null) — The responder to call on result or fault.
|
AsyncToken |
| getDashboardResults | () | method |
public function getDashboardResults(fieldName:String, filters:ReviewerFilters = null, responder:IResponder = null):AsyncTokenRequests dashboard results by fieldName. fieldName can be any of the following:
Parameters
fieldName:String — Field name for dashboard results. Use the getDashboardFieldNames function to get field names to use in this parameter.
| |
filters:ReviewerFilters (default = null) — filters used to narrow down dashboard results. Similar to a where clause.
| |
responder:IResponder (default = null) — The responder to call on result or fault.
|
AsyncToken |
See also
import com.esri.drs.DashboardResult;
import com.esri.drs.DashboardTask;
import com.esri.drs.DataReviewerTaskEvent;
import mx.events.FlexEvent;
import mx.rpc.AsyncResponder;
import mx.rpc.Fault;
import mx.rpc.events.FaultEvent;
protected function application1_initializeHandler(event:FlexEvent):void
{
var url:String = "http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer";
var dashboardTask:DashboardTask = new DashboardTask(url);
dashboardTask.getDashboardResults("SEVERITY", null, new AsyncResponder(resultHandler, faultHandler));
}
private function resultHandler(result:DashboardResult, token:* = null):void
{
for each (var item:Object in result.fieldValues)
{
trace("Severity " + item + " " + result.getCount(item));
}
}
private function faultHandler(fault:Fault, token:* = null):void
{
var msg:String = fault.faultString;
if (fault.content != null && fault.content as Array != null)
msg = fault.content[1].message;
trace("Error: " + msg);
}
| fault | Event |
mx.rpc.events.FaultEventDispatched when there is a problem accessing the Reviewer Map Server.
| getDashboardFieldNamesComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.GET_DASHBOARD_FIELDNAMES_COMPLETEDispatched when the getDashboardFieldNames operation successfully completes. The event result contains an array of field names as strings.
| getDashboardResultsComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.GET_DASHBOARD_RESULTS_COMPLETEDispatched when the getDashboardResults operation successfully completes. The event result contains an instance of a DashboardResult object.