Package | com.esri.drs |
Class | public class ReviewerResultsTask |
Inheritance | ReviewerResultsTask ![]() ![]() |
ReviewerResults allows you to submit or access individual results. It does not fetch aggregations of results like the Dashboard classes. You can submit spatial (or non-spatial) results but you can only fetch non-spatial results.
ReviewerResults also has functions that allow you to retrieve batch validation batch run information and definition query strings that allow you to filter data displayed in the reviewer map service.
Property | Defined By | ||
---|---|---|---|
![]() | createReviewerSessionLastResult : ReviewerSession
ReviewerSession returned from last call to the createReviewerSession function. | DRSBaseTask | |
getBatchRunDetailsLastResult : FeatureSet
FeatureSet containing Batch Validation Run information returned from the last call to the getBatchRunDetails function. | ReviewerResultsTask | ||
getLayerDefinitionLastResult : String
Layer Definition string returned from the last call to the getLayerDefinition function. | ReviewerResultsTask | ||
![]() | getLifecycleStatusStringsLastResult : Array
Array of lifecycle status strings returned from last call to the getLifecycleStatusStrings function. | DRSBaseTask | |
getResultsLastResult : FeatureSet
FeatureSet containing Reviewer workspace results returned from the last call to the getResults function. | ReviewerResultsTask | ||
![]() | getReviewerSessionsLastResult : Array
Array of ReviewerSession object returned from last call to the getReviewerSessions function. | DRSBaseTask | |
updateLifecycleStatusLastResult : FeatureEditResults
Object containing results of updateLifecycleStatus information
returned from the last call to the updateLifecycleStatus function. | ReviewerResultsTask |
Method | Defined By | ||
---|---|---|---|
ReviewerResultsTask(url:String = null) | ReviewerResultsTask | ||
![]() | createReviewerSession(sessionName:String, sessionProperties:SessionProperties, responder:IResponder = null):AsyncToken
Creates a new Reviewer Session. | DRSBaseTask | |
getBatchRunDetails(batchRunIds:Array, responder:IResponder = null):AsyncToken
Fetches batch run information from REVBATCHRUNTABLE and REVCHECKRUNTABLE. | ReviewerResultsTask | ||
getLayerDefinition(filters:ReviewerFilters, responder:IResponder = null):AsyncToken
Utility operation that returns a where clause given a set of input filters. | ReviewerResultsTask | ||
![]() | getLifecycleStatusStrings(responder:IResponder = null):AsyncToken
Retrieves a list of localized lifecycle status strings from the reviewer workspace. | DRSBaseTask | |
getResults(getResultsQueryParameters:GetResultsQueryParameters, filters:ReviewerFilters = null, responder:IResponder = null):AsyncToken
Queries records from REVTABLEMAIN, REVBATCHRUNTABLE and REVCHECKRUNTABLE. | ReviewerResultsTask | ||
![]() | getReviewerSessions(responder:IResponder = null):AsyncToken
Returns an array of sessions in a Reviewer workspace. | DRSBaseTask | |
updateLifecycleStatus(sessionId:uint, lifecycleStatus:uint, technicianName:String, filters:ReviewerFilters, responder:IResponder = null):AsyncToken
Updates lifecycle status of the reviewer geometries. | ReviewerResultsTask | ||
writeFeatureAsResult(reviewerAttributes:ReviewerAttributes, feature:Graphic, responder:IResponder = null):AsyncToken
Writes a feature to the reviewer workspace. | ReviewerResultsTask | ||
writeResult(reviewerAttributes:ReviewerAttributes, geometry:Geometry, responder:IResponder = null):AsyncToken
Writes a geometry and associated reviewer attributes to the Reviewer workspace. | ReviewerResultsTask |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when createReviewerSession operation successfully completes. | DRSBaseTask | ||
Dispatched when there is a problem accessing the Reviewer Map Server. | ReviewerResultsTask | |||
Dispatched when the getBatchRunDetails operation successfully completes. | ReviewerResultsTask | |||
Dispatched when getLayerDefinition operation successfully completes. | ReviewerResultsTask | |||
![]() | Dispatched when getLifecycleStatusStrings operation successfully completes. | DRSBaseTask | ||
Dispatched when getResults operation successfully completes. | ReviewerResultsTask | |||
![]() | Dispatched when getReviewerSessions operation successfully completes. | DRSBaseTask | ||
Dispatched when the updateLifecycleStatus operation successfully completes. | ReviewerResultsTask | |||
Dispatched when writeFeatureAsResult operation completes. | ReviewerResultsTask | |||
Dispatched when writeResult operation completes. | ReviewerResultsTask |
getBatchRunDetailsLastResult | property |
getBatchRunDetailsLastResult:FeatureSet
FeatureSet containing Batch Validation Run information returned from the last call to the getBatchRunDetails function.
This property can be used as the source for data binding.
public function get getBatchRunDetailsLastResult():FeatureSet
public function set getBatchRunDetailsLastResult(value:FeatureSet):void
See also
getLayerDefinitionLastResult | property |
getLayerDefinitionLastResult:String
Layer Definition string returned from the last call to the getLayerDefinition function.
This property can be used as the source for data binding.
public function get getLayerDefinitionLastResult():String
public function set getLayerDefinitionLastResult(value:String):void
See also
getResultsLastResult | property |
getResultsLastResult:FeatureSet
FeatureSet containing Reviewer workspace results returned from the last call to the getResults function.
This property can be used as the source for data binding.
public function get getResultsLastResult():FeatureSet
public function set getResultsLastResult(value:FeatureSet):void
See also
updateLifecycleStatusLastResult | property |
public var updateLifecycleStatusLastResult:FeatureEditResults
Object containing results of updateLifecycleStatus information returned from the last call to the updateLifecycleStatus function.
See also
ReviewerResultsTask | () | Constructor |
public function ReviewerResultsTask(url:String = null)
Parameters
url:String (default = null ) — The DataReviewerServer Server Object Extension (SOE) URL.
|
var url = "http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/"; var reviewerResultsTask = new ReviewerResultsTask(url);
getBatchRunDetails | () | method |
public function getBatchRunDetails(batchRunIds:Array, responder:IResponder = null):AsyncToken
Fetches batch run information from REVBATCHRUNTABLE and REVCHECKRUNTABLE. On completion the getBatchRunDetailsComplete event is fired and the optional responder is called. The result returned is an instance of FeatureSet that does not contain geometry. The featureset contains the following fields (and associated values):
Parameters
batchRunIds:Array — Array of batchRunIds used to get batch run details. Find batch run IDs by checking the batchRunId property of a job's execution details.
| |
responder:IResponder (default = null ) — The responder to call on result or fault.
|
AsyncToken |
import com.esri.ags.FeatureSet; import com.esri.drs.DataReviewerTaskEvent; import com.esri.drs.ReviewerResultsTask; 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 reviewerResultsTask:ReviewerResultsTask = new ReviewerResultsTask(url); // Array of batch run ids. Batch run ids can be found in job execution details. var ids:Array = ["130AB9DB-25F4-4122-94E4-C9A54725E3F7","0E953706-01F2-49FD-8B31-CF0F6BFE9F7E"]; reviewerResultsTask.getBatchRunDetails(ids,new AsyncResponder(resultHandler,faultHandler)); } private function resultHandler(result:FeatureSet, token:* = null):void { for each (var row:* in result.attributes) { for (var key:String in row) { trace(key + " " + row[key]); } } } 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); }
getLayerDefinition | () | method |
public function getLayerDefinition(filters:ReviewerFilters, responder:IResponder = null):AsyncToken
Utility operation that returns a where clause given a set of input filters. Use this where clause as the layer definition of the reviewer map service. This restricts the display of features in the Dynamic Layer to those that satisfy the criteria defined in the input filters. On completion the getLayerDefinitionComplete event is fired and the optional responder is called.
Parameters
filters:ReviewerFilters — Instance of ReviewerFilters to be converted into a Map Server Layer Definition where clause.
| |
responder:IResponder (default = null ) — The responder to call on result or fault.
|
AsyncToken |
import com.esri.drs.DataReviewerTaskEvent; import com.esri.drs.ReviewerFilters; import com.esri.drs.ReviewerResultsTask; import mx.events.FlexEvent; import mx.rpc.AsyncResponder; import mx.rpc.Fault; protected function application1_initializeHandler(event:FlexEvent):void { // Create a ReviewerResultsTask var url:String = "http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer"; var resultsTask:ReviewerResultsTask = new ReviewerResultsTask(url); // Create a ReviewerFilters and add an attribute filter to it var filters:ReviewerFilters = new ReviewerFilters(); filters.addAttributeFilter("SEVERITY",1); // Request a layer definition resultsTask.getLayerDefinition(filters, new AsyncResponder(responseHandler, faultHandler)); } private function responseHandler(layerDefinition:String, token:*):void { // print out the layer definition - use this // in the layerDefinitions property of ArcGISDynamicMapServiceLayer trace(layerDefinition); } private function faultHandler(event:Fault, token:*):void { trace(event.faultDetail); }
getResults | () | method |
public function getResults(getResultsQueryParameters:GetResultsQueryParameters, filters:ReviewerFilters = null, responder:IResponder = null):AsyncToken
Queries records from REVTABLEMAIN, REVBATCHRUNTABLE and REVCHECKRUNTABLE. On completion the getResultsComplete event is fired and the optional responder is called. Returns a non-spatial FeatureSet containing Reviewer workspace results. Supports all filter types in its filters parameter.
Parameters
getResultsQueryParameters:GetResultsQueryParameters — Defines the size, scope and sorting of the FeatureSet returned through the event.
| |
filters:ReviewerFilters (default = null ) — ReviewerFilters used to query reviewer results.
| |
responder:IResponder (default = null ) — The responder to call on result or fault.
|
AsyncToken |
See also
<?xml version="1.0" encoding="utf-8"?> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx" minWidth="955" minHeight="600" xmlns:drs="com.esri.drs.*" initialize="application1_initializeHandler(event)"> <fx:Declarations> <drs:ReviewerResultsTask id="resultTask" url="http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer" getResultsComplete="resultTask_getResultsCompleteHandler(event)" fault="resultTask_faultHandler(event)" showBusyCursor="true" disableClientCaching="true"/> <drs:GetResultsQueryParameters id="queryParams" pageSize="10" pageNumber="0" returnFields="['SessionId','Severity','CheckTitle']"/> </fx:Declarations> <fx:Script> <![CDATA[ import com.esri.drs.DataReviewerTaskEvent; import com.esri.drs.ReviewerFilters; import com.esri.drs.ReviewerResultsTask; import com.esri.ags.FeatureSet; import mx.collections.ArrayList; import mx.events.FlexEvent; import mx.rpc.AsyncResponder; import mx.rpc.Fault; import mx.rpc.events.FaultEvent; [Bindable] private var _resultList:ArrayList = new ArrayList(); // Fetch results when the app initiates protected function application1_initializeHandler(event:FlexEvent):void { resultTask.getResults(queryParams); } // Handles getResultsComplete protected function resultTask_getResultsCompleteHandler(event:DataReviewerTaskEvent):void { var result:FeatureSet = event.result as FeatureSet; // Add the contents of the feature set to the arraylist _resultList = new ArrayList(result.attributes); } protected function resultTask_faultHandler(event:FaultEvent):void { errorMsg.text=event.fault.faultString; } // Demonstrates simple paging functionality protected function nextBtn_clickHandler(event:MouseEvent):void { errorMsg.text=""; // Get the current page number from the GetResultsQueryParameters instance var pageNum:uint = queryParams.pageNumber; // Increment the page number, reset the page number property and fetch again pageNum+=1; queryParams.pageNumber = pageNum; resultTask.getResults(queryParams); } ]]> </fx:Script> <s:Scroller id="groupGrid" width="100%"> <s:VGroup paddingLeft="20" paddingTop="20"> <s:DataGrid id="grid" dataProvider="{_resultList}" horizontalScrollPolicy="auto" verticalScrollPolicy="auto"> <s:columns> <s:ArrayList> <s:GridColumn width="80" dataField="sessionId" headerText="SessionID"/> <s:GridColumn width="80" dataField="severity" headerText="Severity"/> <s:GridColumn width="200" dataField="checktitle" headerText="Check Title"/> </s:ArrayList> </s:columns> </s:DataGrid> <s:Button id="nextBtn" label="Next Page" click="nextBtn_clickHandler(event)"/> <s:Label id="errorMsg" fontSize="15" text="" color="Red"/> </s:VGroup> </s:Scroller> </s:Application>
updateLifecycleStatus | () | method |
public function updateLifecycleStatus(sessionId:uint, lifecycleStatus:uint, technicianName:String, filters:ReviewerFilters, responder:IResponder = null):AsyncToken
Updates lifecycle status of the reviewer geometries. On completion the updateLifecycleStatusComplete event is fired and the optional responder is called. Event result is a FeatureEditResults object that contains the object id, boolean success and an error object if the update fails.
Parameters
sessionId:uint — session in which the lifecycle status of reviewer geometries have to be updated.
| |
lifecycleStatus:uint — lifecycle status to which the reviewer result(s) will get updated.
| |
technicianName:String — name of the technician updating the lifecycle status.
| |
filters:ReviewerFilters — ReviewerFilter used to narrow down reviewer geometries. Similar to a where clause.
| |
responder:IResponder (default = null ) — The responder to call on result or fault.
|
AsyncToken |
writeFeatureAsResult | () | method |
public function writeFeatureAsResult(reviewerAttributes:ReviewerAttributes, feature:Graphic, responder:IResponder = null):AsyncToken
Writes a feature to the reviewer workspace. The feature includes geometry and attributes. Attributes are written to matching custom (user-defined) fields in REVTABLEMAIN. Attribute values are discarded if there are no matching fields between the feature object and REVTABLEMAIN. This operation also writes Reviewer attributes to the Reviewer workspace. Attributes can include the following fields:
Parameters
reviewerAttributes:ReviewerAttributes — Class used to encapsulate all fields to be written to the Reviewer workspace.
| |
feature:Graphic — Feature to write to the Reviewer workspace.
| |
responder:IResponder (default = null ) — The responder to call on result or fault.
|
AsyncToken |
See also
writeResult | () | method |
public function writeResult(reviewerAttributes:ReviewerAttributes, geometry:Geometry, responder:IResponder = null):AsyncToken
Writes a geometry and associated reviewer attributes to the Reviewer workspace. On completion the writeResultComplete event is fired and the optional responder is called. Event result is a boolean value that indicates if the write operation succeeded (true) or not (false).
Parameters
reviewerAttributes:ReviewerAttributes — Class used to encapsulate all fields to be written to the Reviewer workspace.
| |
geometry:Geometry — Point, polyline or polygon to write to the Reviewer workspace.
| |
responder:IResponder (default = null ) — The responder to call on result or fault.
|
AsyncToken |
fault | Event |
mx.rpc.events.FaultEvent
Dispatched when there is a problem accessing the Reviewer Map Server.
getBatchRunDetailsComplete | Event |
com.esri.drs.DataReviewerTaskEvent
com.esri.drs.DataReviewerTaskEvent.GET_BATCH_RUN_DETAILS_COMPLETE
Dispatched when the getBatchRunDetails operation successfully completes. The event result object is a FeatureSet containing the batch run details.
getLayerDefinitionComplete | Event |
com.esri.drs.DataReviewerTaskEvent
com.esri.drs.DataReviewerTaskEvent.GET_LAYER_DEFINITION_COMPLETE
Dispatched when getLayerDefinition operation successfully completes. The event result string is a string with the Map Server Layer Definition.
getResultsComplete | Event |
com.esri.drs.DataReviewerTaskEvent
com.esri.drs.DataReviewerTaskEvent.GET_RESULTS_COMPLETE
Dispatched when getResults operation successfully completes. The event result object is a FeatureSet containing Reviewer workspace results.
updateLifecycleStatusComplete | Event |
com.esri.drs.DataReviewerTaskEvent
com.esri.drs.DataReviewerTaskEvent.UPDATE_LIFECYCLE__STATUS_COMPLETE
Dispatched when the updateLifecycleStatus operation successfully completes. The event result object is a FeatureEditResults that indicates if the update lifecycle status succeeded, objectId and a error if the update failed.
writeFeatureAsResultComplete | Event |
com.esri.drs.DataReviewerTaskEvent
com.esri.drs.DataReviewerTaskEvent.WRITE_FEATURE_AS_RESULT_COMPLETE
Dispatched when writeFeatureAsResult operation completes. The event result is a boolean that indicates if the write request succeeded.
writeResultComplete | Event |
com.esri.drs.DataReviewerTaskEvent
com.esri.drs.DataReviewerTaskEvent.WRITE_RESULT_COMPLETE
Dispatched when writeResult operation completes. The event result is a boolean that indicates if the write request succeeded.