InfoGuide.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/>.
 */
/*
 * Created on 21/Mar/2003
 *
 */
package org.fenixedu.academic.dto;

import java.util.Date;
import java.util.List;

import org.fenixedu.academic.domain.Guide;
import org.fenixedu.academic.domain.masterDegree.GuideRequester;
import org.fenixedu.academic.domain.transactions.PaymentType;

/**
 * @author Nuno Nunes (nmsn@rnl.ist.utl.pt) Joana Mota (jccm@rnl.ist.utl.pt)
 */
public class InfoGuide extends InfoObject {

    private Integer number;

    private Integer year;

    private Double total;

    private String remarks;

    private InfoPerson infoPerson;

    private List<InfoGuideEntry> infoGuideEntries;

    private GuideRequester guideRequester;

    private InfoExecutionDegree infoExecutionDegree;

    private PaymentType paymentType;

    private Date creationDate;

    private Integer version;

    private List infoGuideSituations;

    private InfoGuideSituation infoGuideSituation;

    private Date paymentDate;

    private List infoReimbursementGuides;

    public InfoGuide() {
    }

    public InfoGuide(Integer number, Integer year, Double total, String remarks, InfoPerson infoPerson,
            GuideRequester guideRequester, InfoExecutionDegree infoExecutionDegree, PaymentType paymentType, Date creationDate,
            Integer version) {
        this.number = number;
        this.year = year;
        this.total = total;
        this.remarks = remarks;
        this.infoPerson = infoPerson;
        this.guideRequester = guideRequester;
        this.infoExecutionDegree = infoExecutionDegree;
        this.paymentType = paymentType;
        this.creationDate = creationDate;
        this.version = version;
    }

    @Override
    public boolean equals(Object obj) {
        boolean resultado = false;
        if (obj instanceof InfoGuide) {
            InfoGuide guide = (InfoGuide) obj;

            resultado = getNumber().equals(guide.getNumber()) && getYear().equals(guide.getYear());
        }

        return resultado;
    }

    @Override
    public String toString() {
        String result = "[INFO_GUIDE";
        result += ", number=" + number;
        result += ", year=" + year;
        result += ", person=" + infoPerson;
        result += ", total=" + total;
        result += ", remarks=" + remarks;
        result += ", infoGuideEntries=" + infoGuideEntries;
        result += ", guideRequester=" + guideRequester;
        result += ", infoExecutionDegree=" + infoExecutionDegree;
        result += ", paymentType=" + paymentType;
        result += ", creationDate=" + creationDate;
        result += ", version=" + version;
        result += ", infoGuideSituation=" + infoGuideSituation;
        result += ", payment Date=" + paymentDate;
        result += "]";
        return result;
    }

    /**
     * @return
     */
    public GuideRequester getGuideRequester() {
        return guideRequester;
    }

    /**
     * @return
     */
    public InfoExecutionDegree getInfoExecutionDegree() {
        return infoExecutionDegree;
    }

    /**
     * @return
     */
    public List<InfoGuideEntry> getInfoGuideEntries() {
        return infoGuideEntries;
    }

    /**
     * @return
     */
    public InfoPerson getInfoPerson() {
        return infoPerson;
    }

    /**
     * @return
     */
    public Integer getNumber() {
        return number;
    }

    /**
     * @return
     */
    public String getRemarks() {
        return remarks;
    }

    /**
     * @return
     */
    public Double getTotal() {
        return total;
    }

    /**
     * @return
     */
    public Integer getYear() {
        return year;
    }

    /**
     * @param requester
     */
    public void setGuideRequester(GuideRequester requester) {
        guideRequester = requester;
    }

    /**
     * @param degree
     */
    public void setInfoExecutionDegree(InfoExecutionDegree degree) {
        infoExecutionDegree = degree;
    }

    /**
     * @param list
     */
    public void setInfoGuideEntries(List list) {
        infoGuideEntries = list;
    }

    /**
     * @param person
     */
    public void setInfoPerson(InfoPerson person) {
        infoPerson = person;
    }

    /**
     * @param integer
     */
    public void setNumber(Integer integer) {
        number = integer;
    }

    /**
     * @param string
     */
    public void setRemarks(String string) {
        remarks = string;
    }

    /**
     * @param double1
     */
    public void setTotal(Double double1) {
        total = double1;
    }

    /**
     * @param integer
     */
    public void setYear(Integer integer) {
        year = integer;
    }

    /**
     * @return
     */
    public PaymentType getPaymentType() {
        return paymentType;
    }

    /**
     * @param type
     */
    public void setPaymentType(PaymentType type) {
        paymentType = type;
    }

    /**
     * @return
     */
    public Date getCreationDate() {
        return creationDate;
    }

    /**
     * @return
     */
    public Integer getVersion() {
        return version;
    }

    /**
     * @param date
     */
    public void setCreationDate(Date date) {
        creationDate = date;
    }

    /**
     * @param integer
     */
    public void setVersion(Integer integer) {
        version = integer;
    }

    /**
     * @return
     */
    public List getInfoGuideSituations() {
        return infoGuideSituations;
    }

    /**
     * @param list
     */
    public void setInfoGuideSituations(List list) {
        infoGuideSituations = list;
    }

    /**
     * @return
     */
    public InfoGuideSituation getInfoGuideSituation() {
        return infoGuideSituation;
    }

    /**
     * @param situation
     */
    public void setInfoGuideSituation(InfoGuideSituation situation) {
        infoGuideSituation = situation;
    }

    /**
     * @return
     */
    public Date getPaymentDate() {
        return paymentDate;
    }

    /**
     * @param date
     */
    public void setPaymentDate(Date date) {
        paymentDate = date;
    }

    /**
     * @return Returns the reimbursementGuides.
     */
    public List getInfoReimbursementGuides() {
        return infoReimbursementGuides;
    }

    /**
     * @param reimbursementGuides
     *            The reimbursementGuides to set.
     */
    public void setInfoReimbursementGuides(List reimbursementGuides) {
        this.infoReimbursementGuides = reimbursementGuides;
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.fenixedu.academic.dto.InfoObject#copyFromDomain
     * (Dominio.DomainObject)
     */
    public void copyFromDomain(Guide guide) {
        super.copyFromDomain(guide);
        if (guide != null) {
            setCreationDate(guide.getCreationDate());
            setNumber(guide.getNumber());
            setPaymentDate(guide.getPaymentDate());
            setPaymentType(guide.getPaymentType());
            setRemarks(guide.getRemarks());
            setTotal(guide.getTotal());
            setVersion(guide.getVersion());
            setYear(guide.getYear());
            setGuideRequester(guide.getGuideRequester());
        }
    }

    public static InfoGuide newInfoFromDomain(Guide guide) {
        InfoGuide infoGuide = null;
        if (guide != null) {
            infoGuide = new InfoGuide();
            infoGuide.copyFromDomain(guide);
        }
        return infoGuide;
    }

}