1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.documentapi;
/**
* The <i>synchronous</i> result of submitting an asynchronous operation.
* A result is either a success or not. If it is not a success, it will contain an explanation of why.
* Document repositories may return subclasses which contain more information.
*
* @author bratseth
*/
public class Result {
/** Null if this is a success, set to the error occurring if this is a failure */
private Error error = null;
/** The id of this operation */
private long requestId;
private ResultType type = ResultType.SUCCESS;
/**
* Creates a successful result
*
* @param requestId the ID of the request
*/
public Result(long requestId) {
this.requestId = requestId;
}
/**
* Creates a unsuccessful result
*
* @param type the type of failure
* @param error the error to encapsulate in this Result
* @see com.yahoo.documentapi.Result.ResultType
*/
public Result(ResultType type, Error error) {
this.type = type;
this.error = error;
}
/**
* Returns whether this operation is a success.
* If it is a success, the operation is accepted and one or more responses are guaranteed
* to arrive within this sessions timeout limit.
* If this is not a success, this operation has no further consequences.
*
* @return true if success
*/
public boolean isSuccess() { return type == ResultType.SUCCESS; }
/**
* Returns the error causes by this. If this was not a success, this method always returns an error
* If this was a success, this method returns null.
*
* @return the Error, or null
*/
public Error getError() { return error; }
/**
* Returns the id of this operation. The asynchronous response to this operation
* will contain the same id to allow clients who desire to, to match operations to responses.
*
* @return the if of this operation
*/
public long getRequestId() { return requestId; }
/**
* Returns the type of result.
*
* @return the type of result, typically if this is an error or a success, and what kind of error.
* @see com.yahoo.documentapi.Result.ResultType
*/
public ResultType type() { return type;}
/** The types that a Result can have. */
public enum ResultType {
/** The request was successful, no error information is attached. */
SUCCESS,
/** The request failed, but may be successful if retried at a later time. */
TRANSIENT_ERROR,
/** The request failed, and retrying is pointless. */
FATAL_ERROR,
/** Condition specified in operation not met error */
CONDITION_NOT_MET_ERROR
}
}
|
