index

Package ab_custom_search_header_rules

This package provides support subprograms for the Custom Search Header API (ab_custom_search_header).


Program units
p_register_entity   Registers the attribute value pairs to the message cache for delete operations.
p_register_entity   Registers the attribute/value pairs to the message cache for create and update operations.
p_validate   Validates all data in the record.


p_register_entity

Procedure p_register_entity(p_operation_type     NUMBER,
                            p_internal_record_id gb_common.internal_record_id_type)

Registers the attribute value pairs to the message cache for delete operations.
This signature uses the ROWID only for delete operations.

Parameters
p_operation_type   Type of DML operation: create, update, delete. NUMBER Required
p_internal_record_id   Database ROWID VARCHAR2(18) required


p_register_entity

Procedure p_register_entity(p_operation_type     NUMBER,
                            p_pidm               aobdosr.aobdosr_pidm%TYPE,
                            p_srch_name          aobdosr.aobdosr_srch_name%TYPE,
                            p_srch_title         aobdosr.aobdosr_srch_title%TYPE,
                            p_active_ind         aobdosr.aobdosr_active_ind%TYPE,
                            p_prospect_only_ind  aobdosr.aobdosr_prospect_only_ind%TYPE,
                            p_include_type       aobdosr.aobdosr_include_type%TYPE,
                            p_records_per_page   aobdosr.aobdosr_records_per_page%TYPE,
                            p_user_id            aobdosr.aobdosr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                            p_data_origin        aobdosr.aobdosr_data_origin%TYPE,
                            p_internal_record_id gb_common.internal_record_id_type)

Registers the attribute/value pairs to the message cache for create and update operations.
 
This signature registers all parameters.

Parameters
p_operation_type   Type of DML operation: create ,update, delete. NUMBER Required
p_pidm   Unique identifier (PIDM) of the Advancement Officer defining the search criteria. NUMBER(8) Required Key
p_srch_name   Name for the set of personalized search criteria. VARCHAR2(30) Required Key
p_srch_title   Title to be displayed on the search page for the set of personalized search criteria. VARCHAR2(60) Required
p_active_ind   Indicator for whether the search should appear on the menu of Personalized Searches. Active = checked. VARCHAR2(1) Required
p_prospect_only_ind   Indicator for whether the search should include only Prospects. Include only Prospects = checked. VARCHAR2(1) Required
p_include_type   Types of constituents to include on the Search Results page. I=Advancement Individuals, O=Advancement Organizations, B=Both. VARCHAR2(1) Required
p_records_per_page   Number of Constituent records to display per page on the Search Results page. NUMBER(2) Required
p_user_id   User ID of the person who created or last updated the row. VARCHAR2(30) Required
p_data_origin   Source system that generated the data. VARCHAR2(30)
p_internal_record_id   Database ROWID VARCHAR2(18) required


p_validate

Procedure p_validate(p_pidm              aobdosr.aobdosr_pidm%TYPE,
                     p_srch_name         aobdosr.aobdosr_srch_name%TYPE,
                     p_srch_title        aobdosr.aobdosr_srch_title%TYPE,
                     p_active_ind        aobdosr.aobdosr_active_ind%TYPE,
                     p_prospect_only_ind aobdosr.aobdosr_prospect_only_ind%TYPE,
                     p_include_type      aobdosr.aobdosr_include_type%TYPE,
                     p_records_per_page  aobdosr.aobdosr_records_per_page%TYPE,
                     p_user_id           aobdosr.aobdosr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                     p_data_origin       aobdosr.aobdosr_data_origin%TYPE DEFAULT NULL)

Validates all data in the record.

Parameters
p_pidm   Unique identifier (PIDM) of the Advancement Officer defining the search criteria. NUMBER(8) Required Key
p_srch_name   Name for the set of personalized search criteria. VARCHAR2(30) Required Key
p_srch_title   Title to be displayed on the search page for the set of personalized search criteria. VARCHAR2(60) Required
p_active_ind   Indicator for whether the search should appear on the menu of Personalized Searches. Active = checked. VARCHAR2(1) Required
p_prospect_only_ind   Indicator for whether the search should include only Prospects. Include only Prospects = checked. VARCHAR2(1) Required
p_include_type   Types of constituents to include on the Search Results page. I=Advancement Individuals, O=Advancement Organizations, B=Both. VARCHAR2(1) Required
p_records_per_page   Number of Constituent records to display per page on the Search Results page. NUMBER(2) Required
p_user_id   User ID of the person who created or last updated the row. VARCHAR2(30) Required
p_data_origin   Source system that generated the data. VARCHAR2(30)