index

Package ab_custom_search_header_str

This package contains the error messages and error message functions for for the Custom Search Header API (ab_custom_search_header).

Message NameError Message
INVALID_ACTIVE_INDActive Indicator for the ab_custom_search_header API is not valid.
Valid values for the Active Indicator are A and I.
  • A indicates that the associated search should be displayed on the menu page.
  • I indicates that the search should not be displayed.
INVALID_INCLUDE_TYPEInclude Type for the ab_custom_search_header API is not valid.
Valid values for the Include Type are B, C, and P.
  • B indicates that the search should include both Individuals and Organizations.
  • C indicates that the search should include only Organizations.
  • P indicates that the search should include only Individuals.
INVALID_PIDMUnique identifier (AOBDOSR_PIDM) for the ab_custom_search_header API is not valid.
The Internal Identification Number is missing or does not exist in the database.
INVALID_PROSPECT_ONLY_INDProspect Only Indicator for the ab_custom_search_header API is not valid.
Valid values for the Prospect Only Indicator are Y and N. Y indicates that the associated search should include only Prospects. N indicates that the search should not be limited to only Prospects.
INVALID_RECORDS_PER_PAGERecords Per Page for the ab_custom_search_header API is not valid.
Records Per Page must be a numeric value between 01 and 99. This number is used to determine the number of records displayed on the Search Results page.
INVALID_SRCH_NAMESearch Name for the ab_custom_search_header API is not valid.
The Search Name does not exist on the Advancement Officer Search Options Preference Header Table (AOBDOSR).
INVALID_USER_IDUser ID (AOBDOSR_USER_ID) for the ab_custom_search_header API is not valid.
The User ID supplied does not exist within the Banner system.<
MISSING_ACTIVE_INDActive Indicator is missing. This field is required by the ab_custom_search_header API.
Active Indicator is required. Valid values for the Active Indicator are A and I.
  • A indicates that the associated search should be displayed on the menu page.
  • I indicates that the search should not be displayed.
MISSING_INCLUDE_TYPEInclude Type is missing. This field is required by the ab_custom_search_header API.
The Include Type is required. Valid values for the Include Type are B, C, and P.
  • B indicates that the search should include both Individuals and Organizations.
  • C indicates that the search should include only Organizations.
  • P indicates that the search should include only Individuals.
MISSING_PIDMUnique identifier (AOBDOSR_PIDM) is missing. This field is required by the ab_custom_search_header API.
An Internal Identification Number must be supplied.
MISSING_PROSPECT_ONLY_INDProspect Only Indicator is missing. This field is required by the ab_custom_search_header API.
The Prospect Only Indicator is required. Valid values for the Prospect Only Indicator are Y and N.
  • Y indicates that the search should include only Prospects.
  • N indicates that the search should not be limited to only Prospects.
MISSING_RECORDS_PER_PAGERecords Per Page is missing. This field is required by the ab_custom_search_header API.
Records Per Page is required. Records Per Page must be a numeric value between 01 and 99.
This number is used to determine the number of records displayed on the Search Results page. Selecting the Next button at the bottom of the Search Results page will cause the next set of records to be displayed.
MISSING_SRCH_NAMESearch Name is missing. This field is required by the ab_custom_search_header API.
A Search Name must be supplied when creating a new Custom Search.
MISSING_SRCH_TITLESearch Title is missing. This field is required by the ab_custom_search_header API.
A Search Title must be supplied when creating a new Custom Search.
MISSING_USER_IDUser ID (AOBDOSR_USER_ID) is missing. This field is required by the ab_custom_search_header API.
A User ID must be supplied and exist within the Banner system.
PK_NOT_FOUNDCannot find record using primary or unique key for the ab_custom_search_header API.
The Advancement Officer Search Options Preference Header Table record could not be found using the Internal Identification Number and Search Name supplied.
P_DELETE_FAILEDCannot delete CUSTOM_SEARCH_HEADER( ab_custom_search_header) because the record does not exist.
A record does not exist for the Internal Identification Number and Search Name supplied.
RECORD_EXISTSab_custom_search_header API cannot create CUSTOM_SEARCH_HEADER (ab_custom_search_header) because the record already exists.
A record already exists for the Internal Identification Number and Search Name supplied.
AORDOSR_EXISTSCannot delete Custom Search Header(ab_custom_search_header) because Custom Search Detail records exist.
At least one detail search record exists for the Search Name supplied.


Program units
f_get_error   Returns the error message corresponding to p_errorname.

Variables
error_tab   Global PL/SQL table that holds the error messages.


error_tab

error_tab gb_common_strings.errmsg_tab_type;

Global PL/SQL table that holds the error messages.


f_get_error

Function f_get_error(p_errorname VARCHAR2)
  RETURN gb_common_strings.err_type

Returns the error message corresponding to p_errorname.

Parameters
p_errorname   Name associated with the error message.