addAssociation

Adds an association between the provided feature and the FeatureForm.feature that this element is part of. This method can be used to create an association of any type. Default values will be used for any properties of the association such as UtilityAssociation.isContainmentVisible, UtilityAssociation.fractionAlongEdge.

UtilityAssociationsFormElement.fetchAssociationsFilterResults should be called after a successful addition to refresh the list of filter results.

Return

A Result that returns an UtilityAssociationResult. An IllegalArgumentException may be set on the returned Result if the filter definition does not support adding an association with the specified feature.

Since

300.0.0

Parameters

feature

The ArcGISFeature on the other side of the association.

filter

The UtilityAssociationsFilter that the association will be part of.

See also


suspend fun addAssociation(feature: ArcGISFeature, filter: UtilityAssociationsFilter, isContainmentVisible: Boolean): Result<UtilityAssociationResult>

Adds an association between the provided feature and the FeatureForm.feature that this element is part of, along with the UtilityAssociation.isContainmentVisible value. This method is typically used when creating an UtilityAssociationType.Containment association.

UtilityAssociationsFormElement.fetchAssociationsFilterResults should be called after a successful addition to refresh the list of filter results.

Return

A Result that returns an UtilityAssociationResult. An IllegalArgumentException may be set on the returned Result if the filter definition does not support adding an association with the specified feature.

Since

300.0.0

Parameters

feature

The ArcGISFeature on the other side of the association.

filter

The UtilityAssociationsFilter that the association will be part of.

isContainmentVisible

Indicates whether the content in the containment association is visible.

See also


suspend fun addAssociation(feature: ArcGISFeature, featureTerminal: UtilityTerminal?, filter: UtilityAssociationsFilter, currentFeatureTerminal: UtilityTerminal?): Result<UtilityAssociationResult>

Adds an association between the provided feature and the FeatureForm.feature that this element is part of, along with the UtilityTerminal values. This method is typically used when creating an UtilityAssociationType.Connectivity association between two junction features in the UtilityNetwork.

UtilityAssociationsFormElement.fetchAssociationsFilterResults should be called after a successful addition to refresh the list of filter results.

Return

A Result that returns an UtilityAssociationResult. An IllegalArgumentException may be set on the returned Result, when:

  • The filter definition does not support adding an association with the specified feature.

  • The provided UtilityTerminal values are not a valid selection.

Since

300.0.0

Parameters

feature

The ArcGISFeature on the other side of the association.

featureTerminal

The UtilityTerminal of the feature being associated.

filter

The UtilityAssociationsFilter that the association will be part of.

currentFeatureTerminal

The UtilityTerminal of the feature currently being edited in the FeatureForm.

See also


suspend fun addAssociation(feature: ArcGISFeature, filter: UtilityAssociationsFilter, fractionAlongEdge: Double, terminal: UtilityTerminal? = null): Result<UtilityAssociationResult>

Adds an association between the provided feature and the FeatureForm.feature that this element is part of, along with the fractionAlongEdge and terminal value, if provided. This method is typically used when creating an UtilityAssociationType.Connectivity association between a junction and an edge and the junction feature may have an associated UtilityTerminal value.

UtilityAssociationsFormElement.fetchAssociationsFilterResults should be called after a successful addition to refresh the list of filter results.

Return

A Result that returns an UtilityAssociationResult. An IllegalArgumentException may be set on the returned Result, when:

  • The filter definition does not support adding an association with the specified feature.

  • The provided UtilityTerminal value is not a valid selection.

Since

300.0.0

Parameters

feature

The ArcGISFeature on the other side of the association.

filter

The UtilityAssociationsFilter that the association will be part of.

fractionAlongEdge

Represents how far the junction is located along an edge in the utility network feature.

terminal

The optional UtilityTerminal of the junction.

See also