Packagecom.esri.bacore.domain
Interfacepublic interface IStudyArea extends flash.utils.IExternalizable, flash.events.IEventDispatcher
Implementors StudyArea

Since : Business Analyst API for Flex 2.2.

The IStudyArea interface provides base properties of a study area.

An implementation of the IStudyArea interface is usually an "abstract" class. Non-abstract implementations should implement concrete interfaces derived from this interface.

An implementation of the IStudyArea interface must dispatch propertyChange event after one of its properties is changed.

See also

com.esri.bacore.domain.IGeographyStudyArea
com.esri.bacore.domain.ILocationStudyArea
com.esri.bacore.domain.IPolygonStudyArea


Public Properties
 PropertyDefined By
  description : String
Study area description.
IStudyArea
  featureSet : FeatureSet
Feature set associated with this study area.
IStudyArea
  id : String
Study area ID.
IStudyArea
  name : String
Study area name.
IStudyArea
  type : StudyAreaType
[read-only] Type of the study area.
IStudyArea
Events
 Event Summary Defined By
  The propertyChange event is dispatched when a property of the study area is changed.IStudyArea
Property Detail
descriptionproperty
description:String

Study area description.


Implementation
    public function get description():String
    public function set description(value:String):void
featureSetproperty 
featureSet:FeatureSet

Feature set associated with this study area.

The feature set is required for a polygon study area. For a geography study area, a feature set is optional. In the case of a location study area, a feature set is required when such study area is used in report components.


Implementation
    public function get featureSet():FeatureSet
    public function set featureSet(value:FeatureSet):void
idproperty 
id:String

Study area ID.

This is usually a unique ID identifying a study area. The unique ID value should be assigned to a study area while creating but it could be later changed.


Implementation
    public function get id():String
    public function set id(value:String):void
nameproperty 
name:String

Study area name.


Implementation
    public function get name():String
    public function set name(value:String):void
typeproperty 
type:StudyAreaType  [read-only]

Since : Business Analyst API for Flex 3.0.

Type of the study area.


Implementation
    public function get type():StudyAreaType
Event Detail
propertyChange Event
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = mx.events.PropertyChangeEvent.PROPERTY_CHANGE

Since : Business Analyst API for Flex 3.0.

The propertyChange event is dispatched when a property of the study area is changed.