Package com.ultikits.ultitools.utils

Enum Class UltiCloudRequests.Outcome

java.lang.Object

java.lang.Enum<UltiCloudRequests.Outcome>

com.ultikits.ultitools.utils.UltiCloudRequests.Outcome

All Implemented Interfaces:

Serializable, Comparable<UltiCloudRequests.Outcome>, java.lang.constant.Constable

Enclosing class:

UltiCloudRequests

public static enum UltiCloudRequests.Outcome
extends Enum<UltiCloudRequests.Outcome>

What happened to a request.

Since:

6.3.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IO_ERROR	The exchange could not complete (connection, timeout or read failure).
NOT_CONNECTED	This server holds no valid UltiCloud session (never logged in, logged out, or the credential expired); no request was made.
OK	An HTTP exchange completed; read UltiCloudRequests.Result.getStatusCode() (any 2xx-5xx, including 3xx).
PATH_NOT_ALLOWED	The method and path are not on the allow-list; no request was made.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Outcome()

Method Summary

Modifier and Type	Method	Description
static UltiCloudRequests.Outcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UltiCloudRequests.Outcome[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final UltiCloudRequests.Outcome OK

An HTTP exchange completed; read UltiCloudRequests.Result.getStatusCode() (any 2xx-5xx, including 3xx).

NOT_CONNECTED

public static final UltiCloudRequests.Outcome NOT_CONNECTED

This server holds no valid UltiCloud session (never logged in, logged out, or the credential expired); no request was made.

PATH_NOT_ALLOWED

public static final UltiCloudRequests.Outcome PATH_NOT_ALLOWED

The method and path are not on the allow-list; no request was made.

IO_ERROR

public static final UltiCloudRequests.Outcome IO_ERROR

The exchange could not complete (connection, timeout or read failure).

Constructor Details

Outcome

private Outcome()

Method Details

values

public static UltiCloudRequests.Outcome[] 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

public static UltiCloudRequests.Outcome valueOf(String name)

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 name

NullPointerException - if the argument is null