| Package | com.esri.bacore.client |
| Class | public class BATaskParameters |
| Inheritance | BATaskParameters  Object |
| Implements | IBATaskParameters, IBADatasetParameters |
| Subclasses | AnalysisParameters, StandardReportParameters, SummaryReportParameters |
This class provides a technique for composing output types in the OutputType URL variable.
The outputTypes property of this class specifies what output types are requested
in the parameters of a task. If no output type is specified, the default values for output types
will be selected while composing the URL variable. The mechanism of selection default output types
is implemented within the setDefaultOutputTypes method. This method can be
overriden in inheriting classes and required output types can be set in them. For example,
in the SummaryReportParameters class, the overriden method tests if report options
are specified and sets the getReport output type if true.
All Community Analyst Task producing a complex output are devided into 3 categories depending on reports produced:
See also
| Property | Defined By | ||
|---|---|---|---|
| activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
| outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
| resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | ||
| Method | Defined By | ||
|---|---|---|---|
BATaskParameters(taskName:String, outputTypes:OutputTypes = null)
Creates a new instance of the BATaskParameters class. | BATaskParameters | ||
toURLVariables():URLVariables
Converts task parameters to URL variables. | BATaskParameters | ||
| Method | Defined By | ||
|---|---|---|---|
setDefaultOutputTypes(outputTypes:OutputTypes):void
Sets default output types. | BATaskParameters | ||
| activeDatasetID | property |
activeDatasetID:StringActive dataset ID.
public function get activeDatasetID():String public function set activeDatasetID(value:String):void| outputTypes | property |
outputTypes:OutputTypesTask output types.
The output types instance specifies operations that will execute in the single Web services request. The getFeatureClass operation returns the serialized geometry and attributes of the output feature class in the response. The getReport operation specifies creation of report(s) and returns links to reports in the response. The getMapImage operation specifies creation of an image depicting the output feature class and returns a link to the image in the response.
public function get outputTypes():OutputTypes public function set outputTypes(value:OutputTypes):void| resultType | property |
resultType:BAResultType [read-only] Type of the result returned by the task associated with these parameters. The base implementation returns BAResultType.TASK_RESULT_OUTPUT.
public function get resultType():BAResultType| taskName | property |
taskName:String [read-only] Name of a Community Analyst Task associated with these parameters.
public function get taskName():String| BATaskParameters | () | Constructor |
public function BATaskParameters(taskName:String, outputTypes:OutputTypes = null)Creates a new instance of the BATaskParameters class.
ParameterstaskName:String — Name of a Community Analyst Task associated with these parameters.
| |
outputTypes:OutputTypes (default = null) |
| setDefaultOutputTypes | () | method |
protected function setDefaultOutputTypes(outputTypes:OutputTypes):voidSets default output types.
This method is intended for overriding in subclasses.
It specifies output types which should be selected in the case
when all properties of the outputTypes object are false.
The base method does nothing.
Parameters
outputTypes:OutputTypes — Output types to specify default values in.
|
| toURLVariables | () | method |
public function toURLVariables():URLVariables
Converts task parameters to URL variables.
This method is intended for overriding in subclasses.
The base method creates an instance of URLVariables class
and composes the OutputType variable in it.
URLVariables — URL variables
|