Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.tasks.utilitynetworks

Class UtilityNetworkValidationJob

java.lang.Object

com.esri.arcgisruntime.concurrent.Job

com.esri.arcgisruntime.tasks.utilitynetworks.UtilityNetworkValidationJob

All Implemented Interfaces:

JsonSerializable, RemoteResource

public final class UtilityNetworkValidationJob
extends Job

A Job to run the validate network topology operation on a utility network.

Since:

200.3.0

See Also:

• UtilityNetwork.validateNetworkTopology(Envelope)

Property Summary

Properties

Type	Property	Description
ReadOnlyObjectProperty<UtilityValidationResult>	result	The result of a validate network topology job that has succeeded, null otherwise.

Nested Class Summary

Nested classes/interfaces inherited from class com.esri.arcgisruntime.concurrent.Job

Job.Message, Job.MessageSeverity, Job.MessageSource, Job.Status

Field Summary

Fields inherited from class com.esri.arcgisruntime.concurrent.Job

mCredential, mRequestConfiguration

Method Summary

Modifier and Type	Method	Description
UtilityValidationResult	getResult()	Gets the value of the result property.
ReadOnlyObjectProperty<UtilityValidationResult>	resultProperty()	The result of a validate network topology job that has succeeded, null otherwise.

Methods inherited from class com.esri.arcgisruntime.concurrent.Job

addJobDoneListener, addJobMessageAddedListener, addProgressChangedListener, addStatusChangedListener, cancelAsync, fromJson, getCredential, getError, getMessages, getProgress, getRequestConfiguration, getServerJobId, getStatus, getUnknownJson, getUnsupportedJson, getUri, pause, removeJobDoneListener, removeJobMessageAddedListener, removeProgressChangedListener, removeStatusChangedListener, setCredential, setRequestConfiguration, start, toJson

Methods inherited from class java.lang.Object

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

Property Details

result

public ReadOnlyObjectProperty<UtilityValidationResult> resultProperty

The result of a validate network topology job that has succeeded, null otherwise.

If the job is in progress then a null result is returned until the job successfully completes.

If the job fails to complete successfully, Job.getError() will return an ArcGISRuntimeException indicating one of these error types:

• Invalid call, which indicates one of the following:
  • validate network topology is not supported, check UtilityNetworkCapabilities.supportsValidateNetworkTopologyProperty().
  • network topology is not enabled.
  • pending edits exist.
  • another session is running validate in the default version.
  • a geodatabase transaction is already started.
• Timeout
  • Set if the server timed out due to the size of the network.
• Geodatabase is closed
  • Set if a validate operation is called on a closed geodatabase.

Since:

200.3.0

See Also:

• getResult()
• resultProperty()

Method Details

resultProperty

public ReadOnlyObjectProperty<UtilityValidationResult> resultProperty()

The result of a validate network topology job that has succeeded, null otherwise.

If the job is in progress then a null result is returned until the job successfully completes.

If the job fails to complete successfully, Job.getError() will return an ArcGISRuntimeException indicating one of these error types:

• Invalid call, which indicates one of the following:
  • validate network topology is not supported, check UtilityNetworkCapabilities.supportsValidateNetworkTopologyProperty().
  • network topology is not enabled.
  • pending edits exist.
  • another session is running validate in the default version.
  • a geodatabase transaction is already started.
• Timeout
  • Set if the server timed out due to the size of the network.
• Geodatabase is closed
  • Set if a validate operation is called on a closed geodatabase.

Returns:

the result property

Since:

200.3.0

See Also:

• getResult()

getResult

public UtilityValidationResult getResult()

Gets the value of the result property.

Specified by:

getResult in class Job

Property description:

The result of a validate network topology job that has succeeded, null otherwise.

If the job is in progress then a null result is returned until the job successfully completes.

If the job fails to complete successfully, Job.getError() will return an ArcGISRuntimeException indicating one of these error types:

• Invalid call, which indicates one of the following:
  • validate network topology is not supported, check UtilityNetworkCapabilities.supportsValidateNetworkTopologyProperty().
  • network topology is not enabled.
  • pending edits exist.
  • another session is running validate in the default version.
  • a geodatabase transaction is already started.
• Timeout
  • Set if the server timed out due to the size of the network.
• Geodatabase is closed
  • Set if a validate operation is called on a closed geodatabase.

Returns:

the value of the result property

Since:

200.3.0

See Also:

• resultProperty()