src/main/java/com/p4square/ccbapi/model/CCBAPIResponse.java


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

package com.p4square.ccbapi.model;

import com.p4square.ccbapi.model.CCBErrorResponse;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import java.util.List;

/**
 * Base class for all responses from the CCB API.
 */
public abstract class CCBAPIResponse {

    @XmlElementWrapper(name="errors", nillable=true)
    @XmlElement(name="error")
    private List<CCBErrorResponse> errorResponses;

    /**
     * Return the error message if present.
     *
     * @return A {@link CCBErrorResponse} if an error occurred. Null if the request was successful.
     */
    public List<CCBErrorResponse> getErrors() {
        return errorResponses;
    }

    /**
     * Set the error response.
     *
     * @param errors The list of {@link CCBErrorResponse}s to set.
     */
    public void setErrors(final List<CCBErrorResponse> errors) {
        this.errorResponses = errors;
    }
}