org.somda.sdc.biceps.model.message.InvocationState Maven / Gradle / Ivy

Go to download

package org.somda.sdc.biceps.model.message;

import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;
import jakarta.xml.bind.annotation.XmlType;


/**
 * Transaction state of an invoked operation.
 * 
 * Java class for InvocationState.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "InvocationState", namespace = "http://standards.ieee.org/downloads/11073/11073-10207-2017/message")
@XmlEnum
public enum InvocationState {


    /**
     * Wait = Waiting. The operation has been queued and waits for execution.
     * 
     */
    @XmlEnumValue("Wait")
    WAIT("Wait"),

    /**
     * Start = Started. The execution of the operation has been started.
     * 
     */
    @XmlEnumValue("Start")
    START("Start"),

    /**
     * Cnclld = Cancelled. The execution has been cancelled by the SERVICE PROVIDER.
     * 
     */
    @XmlEnumValue("Cnclld")
    CNCLLD("Cnclld"),

    /**
     * CnclldMan = Cancelled Manually. The execution has been cancelled by the operator.
     * 
     */
    @XmlEnumValue("CnclldMan")
    CNCLLD_MAN("CnclldMan"),

    /**
     * Fin = Finished. The execution has been finished.
     * 
     */
    @XmlEnumValue("Fin")
    FIN("Fin"),

    /**
     * FinMod = Finished with modification. As the requested target value could not be reached, the next best value has been chosen and used as target value.
     * 
     */
    @XmlEnumValue("FinMod")
    FIN_MOD("FinMod"),

    /**
     * The execution has been failed.
     * 
     */
    @XmlEnumValue("Fail")
    FAIL("Fail");
    private final String value;

    InvocationState(String v) {
        value = v;
    }

    /**
     * Gets the value associated to the enum constant.
     * 
     * @return
     *     The value linked to the enum.
     */
    public String value() {
        return value;
    }

    /**
     * Gets the enum associated to the value passed as parameter.
     * 
     * @param v
     *     The value to get the enum from.
     * @return
     *     The enum which corresponds to the value, if it exists.
     * @throws IllegalArgumentException
     *     If no value matches in the enum declaration.
     */
    public static InvocationState fromValue(String v) {
        for (InvocationState c: InvocationState.values()) {
            if (c.value.equals(v)) {
                return c;
            }
        }
        throw new IllegalArgumentException(v);
    }

}