Package net.openosrs.api.dispatch

Class SubmissionResult

java.lang.Object

net.openosrs.api.dispatch.SubmissionResult

public final class SubmissionResult
extends java.lang.Object

Immutable outcome of one submission attempt, never proof of server completion.

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Cancels only this submission; it cannot undo input already delivered.
java.util.concurrent.CompletionStage<java.lang.Boolean>	getDelivery()	Never block the client or UI thread waiting for this stage.
java.lang.String	getReason()
SubmissionStatus	getStatus()
boolean	isSubmitted()
static SubmissionResult	queued(java.util.concurrent.CompletableFuture<java.lang.Boolean> delivery, java.lang.Runnable cancellation)	Accepted asynchronous work.
static SubmissionResult	rejected(SubmissionStatus status, java.lang.String reason)
void	requireSubmitted()
static SubmissionResult	submitted()

Methods inherited from class java.lang.Object

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

Method Detail

queued

public static SubmissionResult queued(java.util.concurrent.CompletableFuture<java.lang.Boolean> delivery,
                                      java.lang.Runnable cancellation)

Accepted asynchronous work. True completion means native delivery, not server success.

getDelivery

public java.util.concurrent.CompletionStage<java.lang.Boolean> getDelivery()

Never block the client or UI thread waiting for this stage.

cancel

public boolean cancel()

Cancels only this submission; it cannot undo input already delivered.

submitted

public static SubmissionResult submitted()

rejected

public static SubmissionResult rejected(SubmissionStatus status,
                                        java.lang.String reason)

getStatus

public SubmissionStatus getStatus()

getReason

public java.lang.String getReason()

isSubmitted

public boolean isSubmitted()

requireSubmitted

public void requireSubmitted()