DefaultFlexibleElementType.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.client.i18n.I18N;
import org.sigmah.shared.command.result.Result;

import com.google.gwt.core.client.GWT;

/**
 * All possible types of default flexible element.
 * 
 * @author tmi
 * @author Denis Colliot (dcolliot@ideia.fr)
 */
public enum DefaultFlexibleElementType implements Result, LogicalElementType {

	CODE,
	TITLE,
	BUDGET,
	BUDGET_RATIO,
	START_DATE,
	END_DATE,
	COUNTRY,
	OWNER,
	MANAGER,
	ORG_UNIT;

	/**
	 * Returns the given {@code flexibleElementType} corresponding name.
	 * This method should be executed from client-side. If executed from server-side, it returns the enum constant name.
	 * 
	 * @param flexibleElementType
	 *          The flexibleElement type.
	 * @return the given {@code flexibleElementType} corresponding name, or {@code null}.
	 */
	public static String getName(final DefaultFlexibleElementType flexibleElementType) {

		if (flexibleElementType == null) {
			return null;
		}

		if (!GWT.isClient()) {
			return flexibleElementType.name();
		}

		switch (flexibleElementType) {
			case CODE:
				return I18N.CONSTANTS.projectName();

			case TITLE:
				return I18N.CONSTANTS.projectFullName();

			case BUDGET:
				return I18N.CONSTANTS.projectBudget();

			case BUDGET_RATIO:
				return I18N.CONSTANTS.projectBudgetRatio();

			case START_DATE:
				return I18N.CONSTANTS.projectStartDate();

			case END_DATE:
				return I18N.CONSTANTS.projectEndDate();

			case COUNTRY:
				return I18N.CONSTANTS.projectCountry();

			case OWNER:
				return I18N.CONSTANTS.projectOwner();

			case MANAGER:
				return I18N.CONSTANTS.projectManager();

			case ORG_UNIT:
				return I18N.CONSTANTS.orgunit();

			default:
				return flexibleElementType.name();
		}
	}

    /**
     * {@inheritDoc}
     */
    @Override
    public ElementTypeEnum toElementTypeEnum() {
        return ElementTypeEnum.DEFAULT;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public TextAreaType toTextAreaType() {
        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public DefaultFlexibleElementType toDefaultFlexibleElementType() {
        return this;
    }

  @Override
  public DefaultContactFlexibleElementType toDefaultContactFlexibleElementType() {
    return null;
  }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getDescription() {
        return I18N.CONSTANTS.flexibleElementDefault() + " (" + getName(this) + ')';
    }
    
}