package geniusweb.progress;

import java.util.Date;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeInfo.As;

import geniusweb.deadline.Deadline;

/**
 * Progress is similar to {@link Deadline} but contains absolute values. It
 * always contains a hard termination moment at which the party should be
 * killed. This is used to free up the run server. The protocol should always
 * check its own clock, as parties may be ignoring or cheating with the
 * deadline.
 * <p>
 * immutable.
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = As.WRAPPER_OBJECT)
@JsonSubTypes({ @JsonSubTypes.Type(value = ProgressTime.class),
		@JsonSubTypes.Type(value = ProgressRounds.class) })
@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE, isGetterVisibility = Visibility.NONE)
public interface Progress {
	/**
	 * @param currentTimeMs the current time in ms since 1970 as from
	 *                      {@link System#currentTimeMillis()}.
	 * @return the current time as a fraction of the total amount of time/rounds
	 *         available. So at start this returns 0, and when (and after) the
	 *         deadline is reached this returns 1. Notice that when the progress
	 *         is about the number of rounds, the party may also want to keep an
	 *         eye on {@link #getTerminationTime()}.
	 */
	Double get(Long currentTimeMs);

	/**
	 * 
	 * @return the unix time (UTC, ms since 1970) at which the party will be
	 *         terminated. At this time the server can remove the party and free
	 *         up its resources. Notice that server and party implementations
	 *         are free to ignore this, the protocol should always check on
	 *         whether a party is out of time.
	 */
	Date getTerminationTime();

	/**
	 * @param currentTimeMs the current time in ms since 1970 as from
	 *                      {@link System#currentTimeMillis()}.
	 * @return true iff the progress has passed the deadline.
	 */
	boolean isPastDeadline(Long currentTimeMs);
}