PhdIndividualProgramDocumentType.java

/**
 * Copyright © 2002 Instituto Superior Técnico
 *
 * This file is part of FenixEdu Academic.
 *
 * FenixEdu Academic is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FenixEdu Academic 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with FenixEdu Academic.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.fenixedu.academic.domain.phd;

import java.util.Collection;
import java.util.HashSet;
import java.util.Locale;

import org.fenixedu.academic.util.Bundle;
import org.fenixedu.bennu.core.i18n.BundleUtil;
import org.fenixedu.commons.i18n.I18N;

public enum PhdIndividualProgramDocumentType {

    CANDIDACY_FORM,

    REGISTRATION_FORM,

    CANDIDACY_REVIEW(true, false),

    STUDY_PLAN(true, false),

    CV,

    DEGREE_FINALIZATION_CERTIFICATE(false),

    HABILITATION_CERTIFICATE_DOCUMENT(false),

    DISSERTATION_OR_FINAL_WORK_DOCUMENT(false),

    ID_DOCUMENT,

    SOCIAL_SECURITY,

    RECOMMENDATION_LETTER(false, false),

    HEALTH_BULLETIN,

    GUIDER_ACCEPTANCE_LETTER(true, false),

    ASSISTENT_GUIDER_ACCEPTANCE_LETTER(true, false),

    MOTIVATION_LETTER,

    RESEARCH_PLAN,

    CANDIDACY_RATIFICATION(true, false),

    PUBLIC_PRESENTATION_SEMINAR_COMISSION(true, false),

    PUBLIC_PRESENTATION_SEMINAR_REPORT(true, false),

    PROVISIONAL_THESIS(true, false),

    FINAL_THESIS(true, false),

    FINAL_THESIS_RATIFICATION_DOCUMENT(true, false),

    THESIS_REQUIREMENT,

    THESIS_ABSTRACT(true, false),

    JURY_ELEMENTS(true, false),

    JURY_PRESIDENT_ELEMENT(true, false),

    JURY_REPORT_FEEDBACK(true, false),

    CANDIDACY_FEEDBACK_DOCUMENT(true, false),

    JURY_MEETING_MINUTES(true, false),

    CONCLUSION_DOCUMENT(true, false),

    OTHER(false, false),

    FEEDBACK_REPORT(false, false, true),

    GUIDANCE_OTHER(false, false, true),

    PAYMENT_DOCUMENT(true, false, false),

    TOEFL_LINGUISTICS_CERTIFICATE(true, false, true),

    GRE_LINGUISTICS_CERTIFICATE(true, false, true),

    JURY_PRESIDENT_DECLARATION(true, false, false),

    MAXIMUM_GRADE_GUIDER_PROPOSAL(true, false, false);

    private boolean isVersioned;

    private boolean isAutomaticallyVisibleToStudent;

    private boolean isForGuidance;

    private PhdIndividualProgramDocumentType() {
        this(true, true, false);
    }

    private PhdIndividualProgramDocumentType(boolean isVersioned) {
        this(isVersioned, true, false);
    }

    private PhdIndividualProgramDocumentType(boolean isVersioned, boolean isAutomaticallyVisibleToStudent) {
        this(isVersioned, isAutomaticallyVisibleToStudent, false);
    }

    private PhdIndividualProgramDocumentType(boolean isVersioned, boolean isAutomaticallyVisibleToStudent, boolean isForGuidance) {
        this.isVersioned = isVersioned;
        this.isAutomaticallyVisibleToStudent = isAutomaticallyVisibleToStudent;
        this.isForGuidance = isForGuidance;
    }

    public String getLocalizedName() {
        return getLocalizedName(I18N.getLocale());
    }

    public String getLocalizedName(final Locale locale) {
        return BundleUtil.getString(Bundle.PHD, locale, getQualifiedName());
    }

    public String getQualifiedName() {
        return PhdIndividualProgramDocumentType.class.getSimpleName() + "." + name();
    }

    public boolean isVersioned() {
        return isVersioned;
    }

    static public Collection<PhdIndividualProgramDocumentType> getDocumentTypesVisibleToStudent() {
        final Collection<PhdIndividualProgramDocumentType> result = new HashSet<PhdIndividualProgramDocumentType>();

        for (final PhdIndividualProgramDocumentType document : values()) {
            if (document.isAutomaticallyVisibleToStudent) {
                result.add(document);
            }
        }

        return result;
    }

    public boolean isForGuidance() {
        return isForGuidance;
    }

}