// $HeadURL$
// $Id$
//
// Copyright © 2006, 2010, 2011, 2012 by the President and Fellows of Harvard College.
// 
// Screensaver is an open-source project developed by the ICCB-L and NSRB labs
// at Harvard Medical School. This software is distributed under the terms of
// the GNU General Public License.

package edu.harvard.med.screensaver.model.users;

import edu.harvard.med.screensaver.model.VocabularyTerm;
import edu.harvard.med.screensaver.model.VocabularyUserType;

/**
 * The affiliation category vocabulary.
 * 
 * @author <a mailto="john_sullivan@hms.harvard.edu">John Sullivan</a>
 * @author <a mailto="andrew_tolopko@hms.harvard.edu">Andrew Tolopko</a>
 */
public enum AffiliationCategory implements VocabularyTerm
{

  // the vocabulary
  
  HMS("HMS"),
  HMS_AFFILIATED_HOSPITAL("HMS Affiliated Hospital"),
  HSPH("HSPH"),
  BROAD_ICG("Broad/ICG"),
  HARVARD_FAS("Harvard FAS"),
  OTHER("Other")
  ;

 
  // static inner class

  /**
   * A Hibernate <code>UserType</code> to map the {@link AffiliationCategory} vocabulary.
   */
  public static class UserType extends VocabularyUserType<AffiliationCategory>
  {
    public UserType()
    {
      super(AffiliationCategory.values());
    }
  }


  // private instance field and constructor

  private String _value;

  /**
   * Constructs a <code>AffiliationCategory</code> vocabulary term.
   * @param value The value of the term.
   */
  private AffiliationCategory(String value)
  {
    _value = value;
  }


  // public instance methods

  /**
   * Get the value of the vocabulary term.
   * @return the value of the vocabulary term
   */
  public String getValue()
  {
    return _value;
  }

  /* (non-Javadoc)
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString()
  {
    return getValue();
  }
}