org.zanata.rest.dto.ProcessStatus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zanata-common-api Show documentation
Zanata API definitions
There is a newer version: 4.6.2
/*
 * Copyright 2010, Red Hat, Inc. and individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution for a full
 * listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This software is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this software; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
 * site: http://www.fsf.org.
 */
package org.zanata.rest.dto;

import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlEnumValue;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import com.webcohesion.enunciate.metadata.DocumentationExample;
import com.webcohesion.enunciate.metadata.Label;
import org.codehaus.jackson.annotate.JsonProperty;

/**
 * Generic type to represent the status of a process.
 *
 * @author Carlos Munoz [email protected]
 */
@XmlRootElement(name = "processStatus")
@XmlType(name = "processStatusType")
@Label("Process Status")
public class ProcessStatus {
    @XmlEnum
    @Label("Process Status Code")
    public enum ProcessStatusCode {
        /** The process has not been accepted by the server */
        @XmlEnumValue("NotAccepted")
        NotAccepted,

        /** The process has been accepted but is not yet running */
        @XmlEnumValue("Waiting")
        Waiting,

        /** The process is being executed */
        @XmlEnumValue("Running")
        Running,

        /** The process has finished normally */
        @XmlEnumValue("Finished")
        Finished,

        /** The process has finshed with a failure */
        @XmlEnumValue("Failed")
        Failed,

        /** The process has been cancelled */
        @XmlEnumValue("Cancelled")
        Cancelled
    }

    private String url;

    private int percentageComplete;

    private List messages;

    private ProcessStatusCode statusCode;

    @XmlElement(required = true)
    @DocumentationExample("http://zanata.example.com")
    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    @XmlElement(required = true)
    @DocumentationExample("55")
    public int getPercentageComplete() {
        return percentageComplete;
    }

    public void setPercentageComplete(int percentageComplete) {
        this.percentageComplete = percentageComplete;
    }

    @XmlElement(name = "message")
    @XmlElementWrapper(name = "messages", required = true)
    @JsonProperty("messages")
    @DocumentationExample(value = "A warning message",
            value2 = "A second warning message")
    public List getMessages() {
        if (messages == null) {
            messages = new ArrayList();
        }
        return messages;
    }

    public void setMessages(List messages) {
        this.messages = messages;
    }

    public ProcessStatus addMessage(String message) {
        getMessages().add(message);
        return this;
    }

    @XmlElement
    public ProcessStatusCode getStatusCode() {
        return statusCode;
    }

    public void setStatusCode(ProcessStatusCode statusCode) {
        this.statusCode = statusCode;
    }
}