- All Implemented Interfaces:
Serializable
,Comparable<ArcadeProfile>
,Constable
The Arcade profile specifies the context under which a script should be executed. This allows the script writer to program against a set of known profile variables and functionality restrictions that are appropriate for their use case. This includes the set of expected return types.
It is erroneous to try to use restricted functionality for instance the use of FeatureSets while working in the labeling profile. Often the restrictions are applied due to performance considerations.
This API does not check that the required profile variables are present for evaluation within a
certain profile, nor does it check that the return type is the expected type. The ArcadeEvaluationResult.castTo(ArcadeExpressionReturnType)
method converts the type of the evaluation result using Arcade casting rules.
- Since:
- 100.14.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionAlias profile.Attribute Rule Calculation profile.Attribute Rule Constraint profile.Attribute Rule Validation profile.Form Constraint profile.Dashboard Data profile.Dashboard Formatting profile.Dictionary Renderer profile.Feature Z profile.Field Calculation profile.Field Mapping profile.Form Calculation profile.Geoanalytics profile.Geotrigger Notification profile.Labeling profile.Layout profile.Location Update Constraint profile.Measure Visualization profile.Popup profile.Popup Element profile.Quick Capture profile.Usage of any optional feature is blocked.Task profile.All optional functionality is allowed.Velocity profile.Visualization profile. -
Method Summary
Modifier and TypeMethodDescriptionstatic ArcadeProfile
Returns the enum constant of this class with the specified name.static ArcadeProfile[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
RESTRICTED
Usage of any optional feature is blocked. Prefer this as your default.- Since:
- 100.14.0
-
UNRESTRICTED
All optional functionality is allowed. The default profile due to compatibility reasons, preferRESTRICTED
as default.- Since:
- 100.14.0
-
ALIAS
Alias profile.Alias profile functionality restrictions apply, only Alias profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
ATTRIBUTE_RULE_CALCULATION
Attribute Rule Calculation profile.Attribute Rule Calculation profile functionality restrictions apply, only Attribute Rule Calculation profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
ATTRIBUTE_RULE_CONSTRAINT
Attribute Rule Constraint profile.Attribute Rule Constraint profile functionality restrictions apply, only Attribute Rule Constraint profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
ATTRIBUTE_RULE_VALIDATION
Attribute Rule Validation profile.Attribute Rule profile functionality restrictions apply, only Attribute Rule profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
CONSTRAINT
Form Constraint profile.Form Constraint profile functionality restrictions apply, only Form Constraint profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
DASHBOARD_FORMATTING
Dashboard Formatting profile.Dashboard Formatting profile functionality restrictions apply, only Dashboard Formatting profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
DASHBOARD_DATA
Dashboard Data profile.Dashboard Data profile functionality restrictions apply, only Dashboard Data profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
DICTIONARY_RENDERER
Dictionary Renderer profile.Dictionary Renderer profile functionality restrictions apply, only Dictionary Renderer profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
FEATURE_Z
Feature Z profile.Feature Z profile functionality restrictions apply, only Feature Z profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
FIELD_CALCULATION
Field Calculation profile.Field Calculation profile functionality restrictions apply, only Field Calculation profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
FIELD_MAPPING
Field Mapping profile.Field Mapping profile functionality restrictions apply, only Field Mapping profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
GEOANALYTICS
Geoanalytics profile.Geoanalytics profile functionality restrictions apply, only Geoanalytics profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
LABELING
Labeling profile.Labeling profile functionality restrictions apply, only Labeling profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
LAYOUT
Layout profile.Layout profile functionality restrictions apply, only Layout profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
MEASURE_VISUALIZATION
Measure Visualization profile.Measure Visualization profile functionality restrictions apply, only Measure Visualization profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
POPUP
Popup profile.Popup functionality profile restrictions apply, only Popup profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
VELOCITY
Velocity profile.Velocity profile functionality restrictions apply, only Velocity profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
VISUALIZATION
Visualization profile.Visualization profile functionality restrictions apply, only Visualization profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
GEOTRIGGER_NOTIFICATION
Geotrigger Notification profile.Geotrigger Notification profile functionality restrictions apply, only Geotrigger Notification profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
FORM_CALCULATION
Form Calculation profile.Form Calculation profile functionality restrictions apply, only Form Calculation profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
TASK
Task profile.Task profile functionality restrictions apply, only Task profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
POPUP_ELEMENT
Popup Element profile.Popup Element profile functionality restrictions apply, only Popup Element profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
LOCATION_UPDATE_CONSTRAINT
Location Update Constraint profile.Location Update Constraint profile functionality restrictions apply, only Location Update Constraint profile variables should be made available. See Arcade profile documentation.
- Since:
- 100.14.0
-
QUICK_CAPTURE
Quick Capture profile.Quick Capture functionality restrictions apply, only Quick Capture variables should be made available. See Arcade profile documentation.
- Since:
- 200.0.0
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-