/*
 * Copyright (c) 2015, Turn Inc. All Rights Reserved.
 * Use of this source code is governed by a BSD-style license that can be found
 * in the LICENSE file.
 */

package com.turn.sorcerer.status;

/**
 * Audience reporting service status enumerations
 *
 * @author tshiou
 */
public enum Status {

	PENDING("PENDING"),
	IN_PROGRESS("RUNNING"),
	SUCCESS("SUCCESS"),
	ERROR("ERROR"),
	;

	String string;

	private Status(String string) {
		this.string = string;
	}

	public String getString() {
		return string;
	}
}

@@ -205,191 +205,1953 @@
 %0A * 
-Audience reporting servic
+Sorcerer state status enumerations%0A *%0A * %3Cp%3E%0A * Sorcerer pipelines and tasks use these enumerations to keep track of the%0A * state of the object.%0A * %3C/p%3E%0A *%0A * %3Cp%3E%0A * Pipelines have a very simple state diagram, either they are scheduled and%0A * therefore considered in-progress, or they have successfully completed.%0A * %3C/p%3E%0A *%0A * %3Cp%3E%0A * Tasks have mor
 e stat
-us enumerations%0A *%0A * @author tshiou%0A */%0Apublic enum Status %7B%0A%0A%09PENDING(%22PENDING%22),%0A%09IN_PROGRESS(%22RUNNING%22),%0A%09SUCCESS(%22SUCCESS%22),%0A%09ERROR(%22ERROR%22),%0A%09;%0A%0A%09
+es to their state diagram. They start in a pending state%0A * before being scheduled into a running state. Then depending on the result%0A * of execution they can end up in a successful state or error state.%0A * %3C/p%3E%0A *%0A * @author tshiou%0A */%0Apublic enum Status %7B%0A%0A%09/**%0A%09 * Represents a task that is a part of a scheduled pipeline but is not yet%0A%09 * eligible for execution, or more specifically the previous tasks in the%0A%09 * workflow have not completed or one of%0A%09 * %7B@link com.turn.sorcerer.task.Task#getDependencies(int)%7D is returning%0A%09 * false%0A%09 */%0A%09PENDING(%22PENDING%22),%0A%0A%09/**%0A%09 * Represents either:%0A%09 *%0A%09 * %3Cli%3EA task that is in-progress, or more specifically%0A%09 * %7B@link com.turn.sorcerer.task.Task#exec%7D method is running%0A%09 * %3C/li%3E%0A%09 *%0A%09 * %3Cli%3E%0A%09 * A pipeline whose initial task has been launched but the pipeline is not%0A%09 * complete, or more specifically all of its memeber tasks have not%0A%09 * completed successfully.%0A%09 * %3C/li%3E%0A%09 */%0A%09IN_PROGRESS(%22RUNNING%22),%0A%0A%09/**%0A%09 * Represents either:%0A%09 *%0A%09 * %3Cli%3E%0A%09 * A successfully completed task, or more specifically%0A%09 * %7B@link com.turn.sorcerer.task.Task#exec%7D has completed with no%0A%09 * exceptions%0A%09 * %3C/li%3E%0A%09 *%0A%09 * %3Cli%3E%0A%09 * A successfully completed pipeline, or more specifically a pipeline%0A%09 * with all member tasks successfully completed.%0A%09 * %3C/li%3E%0A%09 */%0A%09SUCCESS(%22SUCCESS%22),%0A%0A%09/**%0A%09 * Represents a task with a previous iteration run that resulted in an%0A%09 * error state, or more specifically%0A%09 * %7B@link com.turn.sorcerer.task.Task#exec%7D was executed with an exception%0A%09 * thrown%0A%09 */%0A%09ERROR(%22ERROR%22),%0A%09;%0A%0A%09// String representation of status%0A%09private 
 Stri
@@ -2223,16 +2223,70 @@
 ng;%0A%09%7D%0A%0A
+%09/**%0A%09 * Returns string representation of state.%0A%09 */%0A
 %09public 

Update javadocs for Status enum