package org.msh.etbm.web.api;

import com.fasterxml.jackson.annotation.JsonInclude;
import org.msh.etbm.commons.entities.ServiceResult;

import java.util.List;

/**
 * Standard result structure for API requests. Not a rule, but used by many API functions to indicate the
 * result of a request
 * <p>
 * Created by rmemoria on 27/10/15.
 */
public class StandardResult {
    /**
     * Indicate if the request was succeeded (true) or failed (false)
     */
    private boolean success;

    /**
     * The specific result to be sent back (serialized) to the client
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private Object result;

    /**
     * The list of error messages, in case validation fails
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private List<Message> errors;


    public StandardResult() {
        super();
    }

    public StandardResult(ServiceResult res) {
        this.success = true;
        this.result = res.getId();
    }

    public StandardResult(Object res, List<Message> errors, boolean success) {
        this.result = res;
        this.errors = errors;
        this.success = success;
    }

    public boolean isSuccess() {
        return success;
    }

    public void setSuccess(boolean success) {
        this.success = success;
    }

    public Object getResult() {
        return result;
    }

    public void setResult(Object result) {
        this.result = result;
    }

    public List<Message> getErrors() {
        return errors;
    }

    public void setErrors(List<Message> errors) {
        this.errors = errors;
    }

    public static StandardResult createSuccessResult() {
        return new StandardResult(null, null, true);
    }
}