/**
* 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.List;
import org.fenixedu.academic.domain.Person;
import org.fenixedu.academic.domain.candidacy.CancelledCandidacySituation;
import org.fenixedu.academic.domain.candidacy.CandidacySituation;
import org.fenixedu.academic.domain.candidacy.NotAdmittedCandidacySituation;
import org.fenixedu.academic.domain.candidacy.RegisteredCandidacySituation;
import org.fenixedu.academic.domain.exceptions.DomainException;
import org.fenixedu.academic.domain.phd.candidacy.PHDProgramCandidacy;
import org.fenixedu.academic.domain.phd.exceptions.PhdDomainOperationException;
import org.fenixedu.academic.domain.student.Student;
import org.fenixedu.academic.ui.struts.action.phd.PhdProcessStateBean;
import org.joda.time.DateTime;
public class PhdProgramProcessState extends PhdProgramProcessState_Base {
private PhdProgramProcessState() {
super();
}
public PhdProgramProcessState(final PhdIndividualProgramProcess process, final PhdIndividualProgramProcessState type,
final Person person, final String remarks, final DateTime stateDate) {
this();
init(process, type, person, remarks, stateDate);
updateSituationOnPHDCandidacy();
}
public void updateSituationOnPHDCandidacy() {
final PhdIndividualProgramProcess process = getProcess();
if (this.getStateDate() == null) {
throw new DomainException("state.date.null");
}
PHDProgramCandidacy candidacy = process.getCandidacyProcess().getCandidacy();
CandidacySituation situation = null;
switch (this.getType()) {
case WORK_DEVELOPMENT:
situation = new RegisteredCandidacySituation(candidacy);
break;
case NOT_ADMITTED:
situation = new NotAdmittedCandidacySituation(candidacy);
break;
case CANCELLED:
situation = new CancelledCandidacySituation(candidacy);
break;
default:
}
if (situation != null) {
situation.setSituationDate(this.getStateDate());
}
}
@Override
public void editStateDate(PhdProcessStateBean bean) {
super.editStateDate(bean);
getProcess().getStudent().updateStudentRole();
}
protected void init(final Person person, final String remarks, DateTime stateDate) {
throw new RuntimeException("invoke other init");
}
private void init(PhdIndividualProgramProcess process, PhdIndividualProgramProcessState type, Person person, String remarks,
final DateTime stateDate) {
check(process, type);
setProcess(process);
super.init(person, remarks, stateDate, type);
setType(type);
if (process.getStudent() != null) {
process.getStudent().updateStudentRole();
}
}
private void check(PhdIndividualProgramProcess process, PhdIndividualProgramProcessState type) {
String[] args = {};
if (process == null) {
throw new DomainException("error.PhdProgramProcessState.invalid.process", args);
}
String[] args1 = {};
if (type == null) {
throw new DomainException("error.PhdProgramProcessState.invalid.type", args1);
}
checkType(process, type);
}
private void checkType(final PhdIndividualProgramProcess process, final PhdIndividualProgramProcessState type) {
final PhdIndividualProgramProcessState currentType = process.getActiveState();
if (currentType != null && currentType.equals(type)) {
throw new PhdDomainOperationException("error.PhdProgramProcessState.equals.previous.state", type.getLocalizedName());
}
}
@Override
protected void disconnect() {
setProcess(null);
super.disconnect();
}
public boolean isFlunked() {
return PhdIndividualProgramProcessState.FLUNKED.equals(getType());
}
public boolean isSuspended() {
return PhdIndividualProgramProcessState.SUSPENDED.equals(getType());
}
public boolean isCanceled() {
return PhdIndividualProgramProcessState.CANCELLED.equals(getType());
}
public boolean isConcluded() {
return PhdIndividualProgramProcessState.CONCLUDED.equals(getType());
}
public boolean isTransfered() {
return PhdIndividualProgramProcessState.TRANSFERRED.equals(getType());
}
public boolean isNotAdmited() {
return PhdIndividualProgramProcessState.NOT_ADMITTED.equals(getType());
}
public boolean isCandidacy() {
return PhdIndividualProgramProcessState.CANDIDACY.equals(getType());
}
@Override
public void delete() {
Student student = getProcess().getStudent();
setProcess(null);
super.delete();
if (student != null) {
student.updateStudentRole();
}
}
@Override
public boolean isLast() {
return getProcess().getMostRecentState() == this;
}
public static PhdProgramProcessState createWithInferredStateDate(final PhdIndividualProgramProcess process,
final PhdIndividualProgramProcessState type, final Person person, final String remarks) {
DateTime stateDate = null;
PhdProgramProcessState mostRecentState = process.getMostRecentState();
switch (type) {
case CANDIDACY:
if (process.getCandidacyProcess().getCandidacyDate() == null) {
throw new PhdDomainOperationException("error.phd.PhdProgramProcessState.candidacyDate.required");
}
stateDate = process.getCandidacyProcess().getCandidacyDate().toDateTimeAtStartOfDay();
break;
case WORK_DEVELOPMENT:
if (process.getMostRecentStateByType(PhdIndividualProgramProcessState.WORK_DEVELOPMENT) != null) {
stateDate = mostRecentState.getStateDate().plusMinutes(1);
break;
}
if (process.getWhenStartedStudies() == null) {
throw new PhdDomainOperationException("error.phd.PhdProgramProcessState.whenStartedStudies.required");
}
stateDate = process.getWhenStartedStudies().toDateTimeAtStartOfDay();
break;
case THESIS_DISCUSSION:
if (process.getMostRecentStateByType(PhdIndividualProgramProcessState.THESIS_DISCUSSION) != null) {
stateDate = mostRecentState.getStateDate().plusMinutes(1);
break;
}
if (process.getThesisProcess().getWhenThesisDiscussionRequired() == null) {
throw new PhdDomainOperationException("error.phd.PhdProgramProcessState.whenThesisDiscussionRequired.required");
}
stateDate = process.getThesisProcess().getWhenThesisDiscussionRequired().toDateTimeAtStartOfDay();
break;
case TRANSFERRED:
stateDate = mostRecentState.getStateDate().plusMinutes(1);
break;
case CONCLUDED:
if (process.getLastConclusionProcess() == null) {
throw new PhdDomainOperationException("error.phd.PhdProgramProcessState.conclusionProcess.required");
}
stateDate = process.getLastConclusionProcess().getConclusionDate().toDateTimeAtStartOfDay();
break;
case CANCELLED:
case FLUNKED:
case NOT_ADMITTED:
case SUSPENDED:
stateDate = mostRecentState.getStateDate().plusMinutes(1);
break;
default:
throw new DomainException("Cant handle this");
}
return createWithGivenStateDate(process, type, person, remarks, stateDate);
}
public static PhdProgramProcessState createWithGivenStateDate(final PhdIndividualProgramProcess process,
final PhdIndividualProgramProcessState type, final Person person, final String remarks, final DateTime stateDate) {
List<PhdIndividualProgramProcessState> stateList = PhdIndividualProgramProcessState.getPossibleNextStates(process);
if (!stateList.contains(type)) {
String expectedStateDescription = buildExpectedStatesDescription(stateList);
throw new PhdDomainOperationException("error.phd.PhdIndividualProgramProcess.invalid.next.state",
type.getLocalizedName(), expectedStateDescription);
}
return new PhdProgramProcessState(process, type, person, remarks, stateDate);
}
}