AmendmentState.java

package org.sigmah.shared.dto.referential;

/*
 * #%L
 * Sigmah
 * %%
 * Copyright (C) 2010 - 2016 URD
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #L%
 */


import org.sigmah.shared.command.result.Result;

/**
 * State of an amendment.
 */
public enum AmendmentState implements Result {

	DRAFT(AmendmentAction.LOCK),
	LOCKED(AmendmentAction.UNLOCK, AmendmentAction.REJECT, AmendmentAction.VALIDATE),
	ACTIVE(AmendmentAction.CREATE),
	REJECTED,
	ARCHIVED,
	PROJECT_ENDED;

	private final AmendmentAction[] actions;

	private AmendmentState(AmendmentAction... actions) {
		this.actions = actions;
	}

	/**
	 * Retrieves the list of actions that are available when an amendment is in a given state.
	 * 
	 * @return An array containing the possible actions.
	 */
	public AmendmentAction[] getActions() {
		return actions;
	}
}