Source : Constants.java

CS22120 Group Project - project source listings

Questions and comments on this file can be directed to this classes author: Paul Smith


package cs221.groupk.common;

/**
 * This class is a system wide repositary of constant values.
 *
 * <P><I>Code spell-checked - Chris Milner - 5th December 2000.</I><P>
 *
 * @author <A HREF="mailto:[email protected]">Paul Smith</A>
 */
public interface Constants
{
  /**
   * VALIDATION_SUCCESFULL_ALL is a return value of Userset.ValidateUser
   * (Stirng, String), specifiying that the current user has been validated
   * for full system access.
   */
  public static final int VALIDATION_SUCCESFULL_ALL = 1;

  /**
   * VALIDATION_SUCCESFULL_STATIONS is a return value of Userset.ValidateUser
   * (Stirng, String), specifiying that the current user has been validated
   * for the either Station.
   */
  public static final int VALIDATION_SUCCESFULL_STATIONS = 2;

  /**
   * VALIDATION_SUCCESFULL_BOTTOM_STATION is a return value of Userset.ValidateUser
   * (Stirng, String), specifiying that the current user has been validated
   * for the Bottom Station (only).
   */
  public static final int VALIDATION_SUCCESFULL_BOTTOM_STATION = 3;

  /**
   * VALIDATION_SUCCESFULL_TOP_STATION is a return value of Userset.ValidateUser
   * (String, String), specifying that the current user has been validated
   * for the Top Station (only).
   */
  public static final int VALIDATION_SUCCESFULL_TOP_STATION = 4;

  /**
   * VALIDATION_UNSPECIFIED_FAIL is a return value of Userset.ValidateUser
   * (String, String), specifying that an error has occoured validating.
   */
  public static final int VALIDATION_UNSPECIFIED_FAIL = -4;

  /**
   * VALIDATION_FAIL_NOT_AUTHORISED is a return value of Userset.ValidateUser
   * (String, String), specifying that the username provided is not allowed
   * access to the current station.
   */
  public static final int VALIDATION_FAIL_NOT_AUTHORISED = -3;

  /**
   * VALIDATION_FAIL_NO_SUCH_USER is a return value of Userset.ValidateUser
   * (Stirng, String), specifying that the username provided was not found
   */
  public static final int VALIDATION_FAIL_NO_SUCH_USER = -2;

  /**
   * VALIDATION_FAIL_INVALID_PASSWORD is a return value of Userset.ValidateUser
   * (Stirng, String), specifying that the password given is invalid with
   * repsect to the valid username provided.
   */
  public static final int VALIDATION_FAIL_INVALID_PASSWORD = -1;

  /**
   * UNDEFINED is a station ID, used prior to initilisation of the station ID.
   */
  public static final int UNDEFINED = -1;

  /**
   * TOP_STATION is a station ID.
   */
  public static final int TOP_STATION = 1;

  /**
   * BOTTOM_STATION is a station ID.
   */
  public static final int BOTTOM_STATION = 2;

  /**
   * ADMIN_CONSOLE is a station ID.
   */
  public static final int ADMIN_CONSOLE = 3;

  /**
   * ACCESS_LEVEL_NOT_VALIDATED is a flag used to indicate that the current
   * user has not provided a satificatory password to the system yet.
   */
  public static final int ACCESS_LEVEL_NOT_VALIDATED = -1;

  /**
   * ACCESS_LEVEL_TOP_STATION is a flag used to indicate that the current
   * user has access to the top station.
   */
  public static final int ACCESS_LEVEL_TOP_STATION = 2;

  /**
   * ACCESS_LEVEL_BOTTOM_STATION is a flag used to indicate that the current
   * user has access to the bottom station.
   */
  public static final int ACCESS_LEVEL_BOTTOM_STATION = 3;

  /**
   * ACCESS_LEVEL_NOT_VALIDATED is a flag used to indicate that the current
   * user has access to the both stations.
   */
  public static final int ACCESS_LEVEL_ALL_STATIONS = 4;

  /**
   * ACCESS_LEVEL_ADMIN is a flag used to indicate that the current
   * user has admin status, thus full access to both stations and admin.
   */
  public static final int ACCESS_LEVEL_ADMIN = 1;

  /**
   * OPERATION_FAILED default fail code.
   */
  public static final int OPERATION_FAILED = -1;

  /**
   * OPERATION_SUCESS default success code.
   */
  public static final int OPERATION_SUCESS = 0;
  
  /**
   * DISK_WRITE_OPERATION_SUCESS success code for performing a write to Diskette.
   */
  public static final int DISK_WRITE_OPERATION_SUCESS = 0;

  public static final int TICKET_TYPE_SINGLE_ADULT = 1;

  public static final int TICKET_TYPE_SINGLE_CHILD = 2;

  public static final int TICKET_TYPE_RETURN_ADULT = 3;

  public static final int TICKET_TYPE_RETURN_CHILD = 4;

  public static final int TICKET_TYPE_SINGLE_FAMILY4 = 5;

  public static final int TICKET_TYPE_SINGLE_FAMILY8 = 6;

  public static final int TICKET_TYPE_RETURN_FAMILY4 = 5;

  public static final int TICKET_TYPE_RETURN_FAMILY8 = 6;

  public static final int USER_NOT_FOUND = -1;

  public static final int ERROR_LOCATING_USER = -2;

}


Up one level.

Page automatically generated on: 28/12/00 at: 7:58:12 PM.