PhdProgramContextPeriod.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.Comparator;

import org.fenixedu.academic.domain.exceptions.DomainException;
import org.fenixedu.academic.domain.phd.exceptions.PhdDomainOperationException;
import org.joda.time.DateTime;
import org.joda.time.Interval;

import pt.ist.fenixframework.Atomic;

public class PhdProgramContextPeriod extends PhdProgramContextPeriod_Base {

    public static final Comparator<PhdProgramContextPeriod> COMPARATOR_BY_BEGIN_DATE = new Comparator<PhdProgramContextPeriod>() {

        @Override
        public int compare(PhdProgramContextPeriod o1, PhdProgramContextPeriod o2) {
            return o1.getBeginDate().compareTo(o2.getBeginDate());
        }

    };

    protected PhdProgramContextPeriod() {
        super();
        setRootDomainObject(getRootDomainObject());
    }

    protected PhdProgramContextPeriod(PhdProgram phdProgram, DateTime beginPeriod, DateTime endPeriod) {
        super();
        init(phdProgram, beginPeriod, endPeriod);
    }

    protected void init(PhdProgram phdProgram, DateTime beginPeriod, DateTime endPeriod) {
        checkParameters(phdProgram, beginPeriod, endPeriod);

        setPhdProgram(phdProgram);
        setBeginDate(beginPeriod);
        setEndDate(endPeriod);
    }

    protected void checkParameters(PhdProgram phdProgram, DateTime beginPeriod, DateTime endPeriod) {
        if (phdProgram == null) {
            throw new DomainException("phd.PhdProgramContextPeriod.phdProgram.cannot.be.null");
        }

        if (beginPeriod == null) {
            throw new DomainException("phd.PhdProgramContextPeriod.beginPeriod.cannot.be.null");
        }

        if (endPeriod != null && !endPeriod.isAfter(beginPeriod)) {
            throw new PhdDomainOperationException(
                    "error.org.fenixedu.academic.domain.phd.PhdProgramContextPeriod.endPeriod.is.after.of.beginPeriod");
        }

        checkOverlaps(phdProgram, beginPeriod, endPeriod);
    }

    private void checkOverlaps(PhdProgram phdProgram, DateTime beginPeriod, DateTime endPeriod) {
        for (PhdProgramContextPeriod period : phdProgram.getPhdProgramContextPeriodsSet()) {
            if (period == this) {
                continue;
            }

            if (period.overlaps(beginPeriod, endPeriod)) {
                throw new PhdDomainOperationException(
                        "error.org.fenixedu.academic.domain.phd.PhdProgramContextPeriod.period.is.overlaping.another");
            }
        }
    }

    private boolean overlaps(DateTime beginPeriod, DateTime endPeriod) {
        return getInterval().overlaps(new Interval(beginPeriod, endPeriod));
    }

    public boolean contains(DateTime dateTime) {
        return getInterval().contains(dateTime);
    }

    public Interval getInterval() {
        return new Interval(getBeginDate(), getEndDate());
    }

    @Atomic
    public void edit(DateTime beginDate, DateTime endDate) {
        checkParameters(getPhdProgram(), beginDate, endDate);
    }

    @Atomic
    public void closePeriod(DateTime endPeriod) {
        if (endPeriod == null) {
            throw new DomainException("error.org.fenixedu.academic.domain.phd.PhdProgramContextPeriod.endPeriod.cannot.be.null");
        }

        setEndDate(endPeriod);
    }

    @Atomic
    public static PhdProgramContextPeriod create(final PhdProgram phdProgram, DateTime beginPeriod, DateTime endPeriod) {
        return new PhdProgramContextPeriod(phdProgram, beginPeriod, endPeriod);
    }

    @Atomic
    public static PhdProgramContextPeriod create(PhdProgramContextPeriodBean bean) {
        return create(bean.getPhdProgram(), bean.getBeginDateAtMidnight(), bean.getEndDateBeforeMidnight());
    }

    @Atomic
    public void deletePeriod() {
        delete();
    }

    private void delete() {
        setPhdProgram(null);
        setRootDomainObject(null);

        deleteDomainObject();
    }

}