/**
 * Copyright © 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;

/**
 * Interface defining how the portal reads and writes applicants
 * @author Rebecca Twigg, rtwigg@uccs.edu
 */
public interface IApplicantStore {

  /**
   * Gets an applicant.
   * @param userName a user Name
   * @returns applicant with institutions 
   * @throws java.lang.Exception
   */
  public Applicant getApplicant(String userName) throws Exception;


  /**
   * Gets all applicants.
   * @returns an array of applicants with institutions 
   * @throws java.lang.Exception
   */
  public Applicant[] getApplicants() throws Exception; 


  /**
   * Returns a new applicant.
   * @returns a new applicant
   * @throws java.lang.Exception
   */
  public Applicant newApplicant(String firstName, String lastName) throws Exception;


  /*
   * Returns a unique user name from first and last names.
   * @param firstName an applicant's first name
   * @param lastName an applicant's last name
   * @returns a unique user name
   */ 
  public String newUserName(String firstName, String lastName) throws Exception;


  /**
   * Persists applicants.
   * @param applicant the applicant
   * @throws java.lang.Exception
   */
  public void putApplicant(Applicant applicant) throws Exception;

  /**
   * Updates UP_PERSON_DIR for grad committee members with candidate-ready notification message.
   * @param userName the graduate committee member
   * @param msg the notification message
   * @throws java.lang.Exception
   */

  public void updatePersonMsg(String userName, String msg) throws Exception; 

//  /**
//   * Permanently deletes an applicant from the store.
//   * @param applicant the applicant to be removed
//   * @throws java.lang.Exception
//   */
//  public void deleteApplicant(Applicant applicant) throws Exception;

}