aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/protocols/ovsdb/rfc/src/main/java/org/onosproject/ovsdb/rfc/message/OperationResult.java
blob: 99807355d06cd9dc45788652ab7c85abeb14e115 (plain)
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.ovsdb.rfc.message;

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.List;

import org.onosproject.ovsdb.rfc.notation.Row;
import org.onosproject.ovsdb.rfc.notation.UUID;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

/**
 * All results of ovs table operations. refer to RFC7047 5.2.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public final class OperationResult {
    private int count;
    private UUID uuid;
    private List<Row> rows;
    private String error;
    private String details;

    /**
     * Constructs a OperationResult object. When JsonNode is converted into
     * OperationResult, need this constructor and also need setter method.
     */
    public OperationResult() {
    }

    /**
     * Constructs a OperationResult object.
     * @param rows List of Row entity
     */
    public OperationResult(List<Row> rows) {
        checkNotNull(rows, "rows cannot be null");
        this.rows = rows;
    }

    /**
     * Constructs a OperationResult object.
     * @param count the count node of result
     * @param uuid UUID entity
     * @param rows List of Row entity
     * @param error error message
     * @param details details of error message
     */
    public OperationResult(int count, UUID uuid, List<Row> rows, String error,
                           String details) {
        checkNotNull(uuid, "uuid cannot be null");
        checkNotNull(rows, "rows cannot be null");
        checkNotNull(error, "error cannot be null");
        checkNotNull(details, "details cannot be null");
        this.count = count;
        this.uuid = uuid;
        this.rows = rows;
        this.error = error;
        this.details = details;
    }

    /**
     * Return count.
     * @return count
     */
    public int getCount() {
        return count;
    }

    /**
     * Set count value.
     * @param count the Operation message of count
     */
    public void setCount(int count) {
        this.count = count;
    }

    /**
     * Return uuid.
     * @return uuid
     */
    public UUID getUuid() {
        return uuid;
    }

    /**
     * Set uuid value.
     * @param uuid the Operation message of uuid
     */
    public void setUuid(UUID uuid) {
        checkNotNull(uuid, "uuid cannot be null");
        this.uuid = uuid;
    }

    /**
     * Return rows.
     * @return List of Row
     */
    public List<Row> getRows() {
        return rows;
    }

    /**
     * Set rows value.
     * @param rows the Operation message of rows
     */
    public void setRows(List<Row> rows) {
        checkNotNull(rows, "rows cannot be null");
        this.rows = rows;
    }

    /**
     * Return error.
     * @return error
     */
    public String getError() {
        return error;
    }

    /**
     * Set error value.
     * @param error the Operation message of error
     */
    public void setError(String error) {
        checkNotNull(error, "error cannot be null");
        this.error = error;
    }

    /**
     * Return details.
     * @return details
     */
    public String getDetails() {
        return details;
    }

    /**
     * Set details value.
     * @param details the Operation message of details
     */
    public void setDetails(String details) {
        checkNotNull(details, "details cannot be null");
        this.details = details;
    }
}