Package com.esri.arcgisruntime.utilitynetworks

Class UtilityNamedTraceConfiguration

java.lang.Object

com.esri.arcgisruntime.utilitynetworks.UtilityNamedTraceConfiguration

public class UtilityNamedTraceConfiguration
extends Object

A set of predefined trace options that can be used by UtilityTraceParameters to simplify configuring and running a trace operation.

Named trace configurations are created in the utility network and allow clients to perform trace analytics without needing to understand the data model. Applications can simply allow the user to choose from a set of named trace configurations that provide tracing capabilities. The set can be configured for different workflows, and a single application can be used by multiple customers and even across multiple problem domains.

Since:

100.11.0

See Also:

ArcGISMap.getNamedTraceConfigurationsFromUtilityNetworkAsync(UtilityNetwork), UtilityNetwork.queryNamedTraceConfigurationsAsync(UtilityNamedTraceConfigurationQueryParameters)

Method Summary

Modifier and Type	Method	Description
String	getCreator()	Gets the creator of the named trace configuration.
UtilityTraceConfiguration	getDefaultTraceConfiguration()	Gets a copy of the UtilityTraceConfiguration for this UtilityNamedTraceConfiguration, if one is defined.
String	getDescription()	Gets the description of the named trace configuration.
UUID	getGlobalId()	Gets the global ID of the named trace configuration.
UtilityMinimumStartingLocations	getMinimumStartingLocations()	Gets the minimum number of starting locations required for this trace type (e.g.
String	getName()	Gets the name of the named trace configuration.
List<UtilityTraceResult.Type>	getResultTypes()	Gets the result types returned by this named trace configuration.
List<String>	getTags()	Gets the user tags of the named trace configuration.
UtilityTraceConfiguration	getTraceConfiguration()	Deprecated. 100.12.0.
UtilityTraceType	getTraceType()	Gets the UtilityTraceType used by the named trace configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCreator

public String getCreator()

Gets the creator of the named trace configuration.

The creator will be the active portal user when the named trace configuration was created.

Returns:

the creator of the named trace configuration

Since:

100.11.0

getDescription

public String getDescription()

Gets the description of the named trace configuration.

Returns:

the description of the named trace configuration

Since:

100.11.0

getGlobalId

public UUID getGlobalId()

Gets the global ID of the named trace configuration.

Returns:

the global ID of the named trace configuration

Since:

100.11.0

getMinimumStartingLocations

public UtilityMinimumStartingLocations getMinimumStartingLocations()

Gets the minimum number of starting locations required for this trace type (e.g. shortest path trace requires 2).

Returns:

the minimum number of starting locations required for this trace type (e.g. shortest path trace requires 2).

Since:

100.11.0

See Also:

UtilityMinimumStartingLocations

getName

public String getName()

Gets the name of the named trace configuration.

Returns:

the name of the named trace configuration

Since:

100.11.0

getResultTypes

public List<UtilityTraceResult.Type> getResultTypes()

Gets the result types returned by this named trace configuration.

Returns:

an immutable list of result types returned by this named trace configuration

Since:

100.11.0

See Also:

UtilityTraceResult.Type

getTags

public List<String> getTags()

Gets the user tags of the named trace configuration.

Returns:

an immutable list of user tags of the named trace configuration

Since:

100.11.0

getTraceConfiguration

@Deprecated
public UtilityTraceConfiguration getTraceConfiguration()

Deprecated.

100.12.0. Use getDefaultTraceConfiguration() method instead to return a copy of the UtilityTraceConfiguration defined for this UtilityNamedTraceConfiguration.

Gets the UtilityTraceConfiguration of the UtilityNamedTraceConfiguration.

This UtilityTraceConfiguration defines the UtilityNamedTraceConfiguration and cannot be modified. Any change on this object will be discarded.

Returns:

the UtilityTraceConfiguration of the UtilityNamedTraceConfiguration

Since:

100.11.0

getDefaultTraceConfiguration

public UtilityTraceConfiguration getDefaultTraceConfiguration()

Gets a copy of the UtilityTraceConfiguration for this UtilityNamedTraceConfiguration, if one is defined.

Returns:

a copy of the UtilityTraceConfiguration defined for this UtilityNamedTraceConfiguration

Since:

100.12.0

getTraceType

public UtilityTraceType getTraceType()

Gets the UtilityTraceType used by the named trace configuration.

Returns:

the UtilityTraceType used by the named trace configuration

Since:

100.11.0

See Also:

UtilityTraceType