package JCRErrorList;
########################################################################
# Filename: JCRErrorList.pm
#
# Description:
# This class maintains the list of all the possible errors that can be
# encountered in the application. It has mapping for Error Code to
# Error Message and Error Name.
#
#########################################################################
# $Id: JCRErrorList.pm,v 1.2 2006/08/01 16:23:38 pfoley Exp $
# $Name: JCR_4_5_BETA_5 $

use strict;
use base qq(ErrorList);
use ISIBench;
use Log::Log4perl qw(get_logger);

=head1 NAME

JCRErrorList - JCR Specific Error Codes / Error Strings / Display Messages

=head2 METHODS

=over 4

=cut

sub _app_data($) {
  ISIBench::start();
  my $logger = get_logger("JCRErrorList");
  my ($self) = shift;

  my $errors = {
    # Custom JCR Session Error Codes
    '1008' => {
                'DISPLAY_ERROR' => 'Session Error',
                'LOGGING_ERROR' => 'Session ID not defined for this session',
                'ERROR_NAME'    => 'SESSION_SID_NOT_DEFINED',
              },
    '1009' => {
                'DISPLAY_ERROR' => 'Session Error',
                'LOGGING_ERROR' => 'Client API to validate session failed',
                'ERROR_NAME'    => 'ISIDVALID_FAILED',
              },
    '1010' => {
                'DISPLAY_ERROR' => 'Session Error',
                'LOGGING_ERROR' => 'Insufficient params to edition validate method',
                'ERROR_NAME'    => 'EDITION_VALIDATE_PARAM_MISSING',
              },
    '1011' => {
                'DISPLAY_ERROR' => 'Session Error',
                'LOGGING_ERROR' => 'Could not get editions for given session',
                'ERROR_NAME'    => 'GET_EDITION_FAILED',
              },
    '1012' => {
                'DISPLAY_ERROR' => 'Requested year is out of subscription',
                'LOGGING_ERROR' => 'Requested year is out of subscription',
                'ERROR_NAME'    => 'INVALID_YEAR_SUBSCRIPTION',
              },
    '1013' => {
                'DISPLAY_ERROR' => 'Requested edition is out of subscription',
                'LOGGING_ERROR' => 'Requested edition is out of subscription',
                'ERROR_NAME'    => 'INVALID_EDITION_SUBSCRIPTION',
              },
    '1014' => {
                'DISPLAY_ERROR' => 'Session Error',
                'LOGGING_ERROR' => 'ESTI client API to get editions failed',
                'ERROR_NAME'    => 'ESTI_GET_EDITION_FAILED',
              },
    '1015' => {
                'DISPLAY_ERROR' => 'Subscription Error',
                'LOGGING_ERROR' => 'Subscription Error',
                'ERROR_NAME'    => 'SUBSCRIPTION_ERROR',
              },
    '1018' => {
                'DISPLAY_ERROR' => 'Session Expired',
                'LOGGING_ERROR' => 'Session Expired',
                'ERROR_NAME'    => 'EXPIRED',
              },
    '1019' => {
                'DISPLAY_ERROR' => 'Invalid Session',
                'LOGGING_ERROR' => 'Session not active',
                'ERROR_NAME'    => 'SESSION_NOT_ACTIVE',
              },
    '1020' => {
                'DISPLAY_ERROR' => 'Busy',
                'LOGGING_ERROR' => 'Busy',
                'ERROR_NAME'    => 'BUSY',
              },

    #### Graph.pm Errors
    '1701'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Failed to create Graphs internal object (mixed).',
                          'ERROR_NAME'    => 'GRAPH_MIXED_OBJECT_FAILED',
                        },
    '1702'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Failed to create Graphs internal object (Data).',
                          'ERROR_NAME'    => 'GRAPH_DATA_OBJECT_FAILED',
                        },
    '1703'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Failed to create Graph Object.',
                          'ERROR_NAME'    => 'GRAPH_OBJECT_FAILED',
                        },
    '1704'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Insufficient input params for Graphs add() method.',
                          'ERROR_NAME'    => 'MISSING_GRAPH_ADD_PARAMS',
                        },
    '1705'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Could not set the properties for the Graph.',
                          'ERROR_NAME'    => 'SET_GRAPH_PROPERTIES_FAILED',
                        },
    '1706'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Could not plot the Graph.',
                          'ERROR_NAME'    => 'GRAPH_PLOT_FAILED',
                        },
    '1722'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Failed to create Cache Object for loading the Graph.',
                          'ERROR_NAME'    => 'CACHE_OBJ_FAILED_FOR_GRAPH_LOAD',
                        },

    '1723'      =>      {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Failed to load the graph from Cache Object.',
                          'ERROR_NAME'    => 'CACHE_LOAD_FAILED_FOR_GRAPH',
                        },

    '1724'      => {
                          'DISPLAY_ERROR' => 'Application Library Module Error',
                          'LOGGING_ERROR' => 'Failed to create Cache Object for Saving the Graph.',
                          'ERROR_NAME'    => 'CACHE_OBJ_FAILED_FOR_GRAPH_SAVE',
                        },

    # Category (Category.pm) Errors
    '3001' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve category hash from DB',
                'ERROR_NAME'    => 'GET_CATEGORY_HASH_FAILED',
              },

    '3002' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not get category subject from DB',
                'ERROR_NAME'    => 'GET_CATEGORY_BY_SUBJECT_FAILED',
              },

    '3003' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve category object',
                'ERROR_NAME'    => 'GET_CATEGORY_OBJECT_FAILED',
              },

    '3004' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve subject category selection hash from database',
                'ERROR_NAME'    => 'GET_CATEGORY_SELECTION_FAILED',
              },

    '3005' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Subject Category Selection Count',
                'ERROR_NAME'    => 'GET_CATE_SELECTION_COUNT_FAILED',
              },

    '3006' => {
                'DISPLAY_ERROR' => 'No matching subject categories were found.',
                'LOGGING_ERROR' => 'No matching subject categories were found.',
                'ERROR_NAME'    => 'SEARCH_CATEGORY_FAILED',
              },

    '3007' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve subject category data for requested subject',
                'ERROR_NAME'    => 'CATEGORY_DATA_RETV_ERROR',
              },

    '3008' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve current publication frequency for requested subject',
                'ERROR_NAME'    => 'CATEGORY_PUB_FREQ_ERROR',
              },

    '3009' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve publication frequency for all subject categories',
                'ERROR_NAME'    => 'ALL_CATEGORY_PUB_FREQ_ERROR',
              },

    '3010' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Undefined mode for Subject Category Cites',
                'ERROR_NAME'    => 'UNDEFINED_CATEGORY_CITES_MODE',
              },

    '3011' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve subject category cites (cited/citing) for requested subject',
                'ERROR_NAME'    => 'CATEGORY_CITES_RETV_ERROR',
              },

    '3012' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Undefined mode for Subject Category CITE Cites',
                'ERROR_NAME'    => 'UNDEFINED_CAT_CITE_CITES_MODE',
              },

    '3013' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Subject Category CITE cites (cited/citing) for requested subject',
                'ERROR_NAME'    => 'CATEGORY_CITE_CITES_RETV_ERROR',
              },

    '3014' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Undefined mode for Subject Category CITE Cites Count',
                'ERROR_NAME'    => 'UNDEFIN_CAT_CITE_CITES_CNT_MODE',
              },

    '3015' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Subject Category CITE cites Count for requested subject',
                'ERROR_NAME'    => 'CATEGORY_CITE_CITES_CNT_RETV_ERR',
              },

    '3016' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Subject Category Relatedness info for requested subject',
                'ERROR_NAME'    => 'CATEGORY_RELATED_RETV_ERROR',
              },

    '3017' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Subject Category Journal Count for requested subject',
                'ERROR_NAME'    => 'CATEGORY_NUM_JOURNALS_RETV_ERROR',
              },

    # Marked List Errors
    '3101' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not create Marked List object',
                'ERROR_NAME'    => 'MARKED_LIST_OBJECT_FAILED',
              },

    '3102' => {
                'DISPLAY_ERROR' => 'Not all of the journals were added to the Marked List. The Marked List can contain 500 journals.  From the Marked List, click the "Clear Marked List" button to clear the list.',
                'LOGGING_ERROR' => 'Not all of the journals were added to the Marked List. The Marked List can contain 500 journals.  From the Marked List, click the "Clear Marked List" button to clear the list.',
                'ERROR_NAME'    => 'MARKED_LIST_MAX_SUMMARY',
              },

    '3103' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve marked records from database',
                'ERROR_NAME'    => 'MARKED_LIST_GET_FAILED',
              },

    '3104' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not add to Marked List',
                'ERROR_NAME'    => 'MARKED_LIST_ADD_FAILED',
              },

    '3105' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not remove from Marked List',
                'ERROR_NAME'    => 'MARKED_LIST_REMOVE_FAILED',
              },

    '3106' => {
                'DISPLAY_ERROR' => 'This journal could not be added to the Marked List. The Marked List can contain 500 journals. From the Marked List, click the "Clear Marked List" button to clear the list.',
                'LOGGING_ERROR' => 'This journal could not be added to the Marked List. The Marked List can contain 500 journals. From the Marked List, click the "Clear Marked List" button to clear the list.',
                'ERROR_NAME'    => 'MARKED_LIST_MAX_RECORD',
              },

    # Journal (Journal.pm) Errors
    '3201' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not create Journal Object',
                'ERROR_NAME'    => 'JOURNAL_OBJECT_FAILED',
              },

    '3202' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not get J20 from DB',
                'ERROR_NAME'    => 'GET_J20_FAILED',
              },

    '3203' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve Journal Title from DB',
                'ERROR_NAME'    => 'GET_JOURNAL_TITLE_FAILED',
              },

    '3204' => {
                'DISPLAY_ERROR' => 'Invalid Search Query String',
                'LOGGING_ERROR' => 'Invalid Search Query String',
                'ERROR_NAME'    => 'EMPTY_SEARCH_QUERY',
              },

    '3205' => {
                'DISPLAY_ERROR' => 'At least one character must precede the truncation character (*).',
                'LOGGING_ERROR' => 'At least one character must precede the truncation character (*).',
                'ERROR_NAME'    => 'SEARCH_QUERY_TRUNCATION_ERROR',
              },

    '3206' => {
                'DISPLAY_ERROR' => 'No matching journals were found.',
                'LOGGING_ERROR' => 'No matching journals were found.',
                'ERROR_NAME'    => 'SEARCH_JOURNAL_FAILED',
              },

    '3207' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve current impact for requested journal',
                'ERROR_NAME'    => 'JOURNAL_CURRENT_IMPACT_ERROR',
              },

    '3208' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve current impact for all journals',
                'ERROR_NAME'    => 'ALL_JOURNAL_CURR_IMPACT_ERROR',
              },

    '3209' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve journal data for requested journals',
                'ERROR_NAME'    => 'JOURNAL_DATA_RETV_ERROR',
              },

    '3210' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve languages for requested journal',
                'ERROR_NAME'    => 'JOURNAL_LANGUAGE_RETV_ERROR',
              },

    '3211' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve subject categories for requested journal',
                'ERROR_NAME'    => 'JOURNAL_CATEGORIES_RETV_ERROR',
              },

    '3212' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Undefined mode for Journal Cites',
                'ERROR_NAME'    => 'UNDEFINED_JOURNAL_CITES_MODE',
              },

    '3213' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve journal cites (cited/citing) for requested journal',
                'ERROR_NAME'    => 'JOURNAL_CITES_RETV_ERROR',
              },

    '3214' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Undefined mode for Journal CITE Cites',
                'ERROR_NAME'    => 'UNDEFINED_JOUR_CITE_CITES_MODE',
              },

    '3215' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve journal CITE cites (cited/citing) for requested journal',
                'ERROR_NAME'    => 'JOURNAL_CITE_CITES_RETV_ERROR',
              },

    '3216' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Undefined mode for Journal CITE Cites Count',
                'ERROR_NAME'    => 'UNDEFIN_JOUR_CITE_CITES_CNT_MODE',
              },

    '3217' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve journal CITE cites Count for requested journal',
                'ERROR_NAME'    => 'JOURNAL_CITE_CITES_CNT_RETV_ERR',
              },

    '3218' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Journal Selection Count',
                'ERROR_NAME'    => 'GET_JOUR_SELECTION_COUNT_FAILED',
              },

    '3219' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve journal selection hash from database',
                'ERROR_NAME'    => 'GET_JOURNAL_SELECTION_FAILED',
              },

    '3220' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve full journal titles hash from database',
                'ERROR_NAME'    => 'GET_FULL_JOURNAL_TITLES_FAILED',
              },

    '3221' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve journal title changes hash from database',
                'ERROR_NAME'    => 'GET_JOURNAL_TITLE_CHANGES_FAILED',
              },

    '3222' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve j20 list from database',
                'ERROR_NAME'    => 'GET_J20_SELECTION_FAILED',
              },

    '3223' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Could not retrieve j20 list form database',
                'ERROR_NAME'    => 'J20_SEARCH_FAILED',
              },

    '3224' => {
                'DISPLAY_ERROR' => 'The ISSN number does not exist in your subscribed JCR editions.',
                'LOGGING_ERROR' => 'The ISSN number does not exist in your subscribed JCR editions.',
                'ERROR_NAME'    => 'ISSN_NOT_IN_SUBSCRIPTION',
              },

    '3225' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Journal Relatedness info for requested journal',
                'ERROR_NAME'    => 'JOURNAL_RELATED_RETV_ERROR',
              },

    # Publisher (Publisher.pm) Errors
    '3301' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to create Publisher Object',
                'ERROR_NAME'    => 'PUBLISHER_OBJECT_FAILED',
              },

    '3302' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Publisher Names for requested Publisher IDs',
                'ERROR_NAME'    => 'GET_PUBLISHERS_FAILED',
              },

    '3303' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve Publisher Record for requested Publisher ID',
                'ERROR_NAME'    => 'GET_PUBLISHER_INFO_FAILED',
              },

    # Country (Country.pm) Errors
    '3401' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to create Country Object',
                'ERROR_NAME'    => 'COUNTRY_OBJECT_FAILED',
              },

    '3402' => {
                'DISPLAY_ERROR' => 'Application Library Module Error',
                'LOGGING_ERROR' => 'Failed to retrieve countries name from the database',
                'ERROR_NAME'    => 'GET_COUNTRIES_FAILED',
              },
  };
}
1;