/**
 * Copyright © 2001, 2002 The JA-SIG Collaborative.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the JA-SIG Collaborative
 *    (http://www.jasig.org/)."
 *
 * THIS SOFTWARE IS PROVIDED BY THE JA-SIG COLLABORATIVE "AS IS" AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE JA-SIG COLLABORATIVE OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

package org.jasig.portal;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jasig.portal.utils.IPortalDocument;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * Describes institutions listed by applicants in applications to graduate school.
 * @author rtwigg@uccs.edu
 */
public class UserInstitution {
  private static final Log log = LogFactory.getLog(UserInstitution.class);
 
  private String ID;
  private String userName;
  private String institutionName;
  private String major;
  private String degree;
  private String GPA;
  private String transcriptStatus; 

  /**
   * Constructs a user institution.
   */
  public UserInstitution() {
    this.ID="";
    this.userName = "";
    this.institutionName = "";
    this.major="";
    this.degree="";
    this.GPA="";
    this.transcriptStatus=""; 
  }

  /**
   * Constructs a user institution .
   * @param the userName
   * @param institutionName the institution name
   */
  public UserInstitution(String userName, String institutionName) {
    this.ID="";
    this.userName = userName;
    this.institutionName = institutionName;
    this.major="";
    this.degree="";
    this.GPA="";
    this.transcriptStatus=""; 
  }

  public UserInstitution(String institutionName) {
    this.ID="";
    this.userName = "";
    this.institutionName = institutionName;
    this.major="";
    this.degree="";
    this.GPA="";
    this.transcriptStatus=""; 
  }

  // Accessor methods
  public String getID() { 
    return ID; 
  }

  public String getUserName() { 
    return userName; 
  }

  public String getInstitutionName() { 
    return institutionName; 
  }

  public String getMajor() { 
    return major; 
  }

  public String getDegree() { 
    return degree; 
  }

  public String getGPA() { 
    return GPA; 
  }

  public String getTranscriptStatus() { 
    return transcriptStatus; 
  }

  // Modifier methods
  public void setID(String ID) { 
    this.ID = ID; 
  }

  public void setInstitutionName(String institutionName) { 
    this.institutionName = institutionName; 
  }

  public void setMajor(String major) { 
    this.major=major; 
  }

  public void setDegree(String degree) { 
    this.degree = degree; 
  }

  public void setGPA(String GPA) { 
    this.GPA=GPA; 
  }

  public void setTranscriptStatus(String transcriptStatus) { 
    this.transcriptStatus=transcriptStatus; 
  }

  /**
   * Return an xml representation of this user institution
   */
  public Element getDocument(Document doc) {
    Element userInstitutionE = doc.createElement("userInstitution");
    userInstitutionE.setAttribute("ID", ID + "");
    userInstitutionE.setAttribute("userName", userName + "");
    userInstitutionE.setAttribute("institutionName", institutionName + "");
    userInstitutionE.setAttribute("major", major + "");
    userInstitutionE.setAttribute("degree", degree + "");
    userInstitutionE.setAttribute("GPA", GPA + "");
    userInstitutionE.setAttribute("transcriptStatus", transcriptStatus + "");
    return userInstitutionE;
  }

}