org.continuity.api.entities.report.OrderReport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of continuity.api Show documentation
Library of continuITy defining exchange entities
The newest version!
package org.continuity.api.entities.report;

import java.util.Set;

import org.continuity.api.entities.links.LinkExchangeModel;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

@JsonPropertyOrder({ "order-id", "number", "max", "testing-context", "successful", "error", "created-artifacts", "internal-artifacts" })
public class OrderReport {

	@JsonProperty("order-id")
	private String orderId;

	private int number;

	private int max;

	@JsonProperty("testing-context")
	@JsonInclude(Include.NON_EMPTY)
	private Set testingContext;

	@JsonProperty("created-artifacts")
	private LinkExchangeModel createdArtifacts;

	@JsonProperty("internal-artifacts")
	private LinkExchangeModel internalArtifacts;

	private boolean successful;

	@JsonInclude(Include.NON_NULL)
	private String error;

	public OrderReport() {
	}

	public OrderReport(String orderId, Set testingContext, LinkExchangeModel internalArtifacts, boolean successful, String error) {
		this.orderId = orderId;
		this.testingContext = testingContext;
		this.internalArtifacts = internalArtifacts;
		this.successful = successful;
		this.error = error;
	}

	public static OrderReport asSuccessful(String orderId, Set testingContext, LinkExchangeModel internalArtifacts) {
		return new OrderReport(orderId, testingContext, internalArtifacts, true, null);
	}

	public static OrderReport asError(String orderId, LinkExchangeModel internalArtifacts, String error) {
		return new OrderReport(orderId, null, internalArtifacts, false, error);
	}

	public String getOrderId() {
		return orderId;
	}

	public void setOrderId(String orderId) {
		this.orderId = orderId;
	}

	public Set getTestingContext() {
		return testingContext;
	}

	public void setTestingContext(Set testingContext) {
		this.testingContext = testingContext;
	}

	public LinkExchangeModel getCreatedArtifacts() {
		return createdArtifacts;
	}

	public void setCreatedArtifacts(LinkExchangeModel createdArtifacts) {
		this.createdArtifacts = createdArtifacts;
	}

	public LinkExchangeModel getInternalArtifacts() {
		return internalArtifacts;
	}

	public void setInternalArtifacts(LinkExchangeModel internalArtifacts) {
		this.internalArtifacts = internalArtifacts;
	}

	public boolean isSuccessful() {
		return successful;
	}

	public void setSuccessful(boolean successful) {
		this.successful = successful;
	}

	public String getError() {
		return error;
	}

	public void setError(String error) {
		this.error = error;
	}

	/**
	 * Returns the report number within the order (e.g., 1 of 5)
	 *
	 * @see #getMax()
	 */
	public int getNumber() {
		return number;
	}

	public void setNumber(int number) {
		this.number = number;
	}

	public int getMax() {
		return max;
	}

	/**
	 * Returns the number of reports to be returned for one order.
	 *
	 * @see #getNumber()
	 */
	public void setMax(int max) {
		this.max = max;
	}

}