Package ab_custom_search

Package ab_custom_search_header

This package provides the Common Business interface for the Custom Search Header API (ab_custom_search_header).

The Custom Search functionality of Banner Advancement Self-Service allows Advancement Officers to define search pages containing only the search criteria they find useful.
These search pages are created using a predefined set of search criteria.

A new Advancement Officer Search Options Preference Header record (AOBDOSR) is defined using the Custom Search Header API (ab_custom_search_header).

Elements contained in the Advancement Officer Search Options Preference Header record (AOBDOSR) are:

Internal Identification Number - the unique identifier (PIDM) of the Advancement Officer who created the search.
Search Name - 30-character name for the search.
Search Title - 60-character title of the search.
Active Indicator - 'A' indicates that the search is active and should be displayed on the Advancement Officer Search page. 'I' indicates that the search is not active and should not be displayed on the Advancement Officer Search page.
Prospect Only Indicator - 'Y' indicates that the search should return only Prospect records. 'N' indicates that the search should return all types of Constituent records.
Include Type - 'P' indicates that the search should return only Individual records. 'C' indicates that the search should return only Organization records. 'B' indicates that the search should return both Individuals and Organizations.
Records Per Page - Numeric value from 01 to 99. Used to determine the number of records displayed on the Search Results page.
User ID - User ID of the person who created or last updated the row.
Activity Date - Date on which the row was created or last updated.
Data Origin - Source system that generated the data.

Program units

f_api_version	Returns the API version number.
f_exists	Checks if a record exists.
f_isequal	Compares two records for equality.
f_query_all	Selects all records for the entity.
f_query_one	Selects one record using the key.
f_query_by_rowid	Selects one record using the ROWID.
f_query_one_lock	Selects one record and locks it.
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

custom_search_header_rec	Business Entity record type
custom_search_header_ref	Entity cursor variable type
custom_search_header_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(20) := 'CUSTOM_SEARCH_HEADER';

Business Entity Name

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'AOBDOSR';

Base table name

custom_search_header_rec

TYPE custom_search_header_rec IS RECORD (
  r_pidm                    aobdosr.aobdosr_pidm%TYPE,
  r_srch_name               aobdosr.aobdosr_srch_name%TYPE,
  r_srch_title              aobdosr.aobdosr_srch_title%TYPE,
  r_active_ind              aobdosr.aobdosr_active_ind%TYPE,
  r_prospect_only_ind          aobdosr.aobdosr_prospect_only_ind%TYPE,
  r_include_type            aobdosr.aobdosr_include_type%TYPE,
  r_records_per_page        aobdosr.aobdosr_records_per_page%TYPE,
  r_user_id                 aobdosr.aobdosr_user_id%TYPE,
  r_data_origin             aobdosr.aobdosr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

custom_search_header_ref

TYPE custom_search_header_ref IS REF CURSOR RETURN custom_search_header_rec;

Entity cursor variable type

custom_search_header_tab

TYPE custom_search_header_tab IS TABLE OF custom_search_header_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version

Function f_api_version RETURN PLS_INTEGER

Returns the API version number.

Returns

Version of the API signature. Changes only when the signature changes.

f_exists

Function f_exists(p_pidm      aobdosr.aobdosr_pidm%TYPE,
                  p_srch_name aobdosr.aobdosr_srch_name%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

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_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_isequal

Function f_isequal(rec_one custom_search_header_rec,
                   rec_two custom_search_header_rec) RETURN VARCHAR2

Compares two records for equality.
Tests each field of rec_one against the corresponding field of rec_two. Two null values are considered equal.

Parameters

	rec_one	The first record to compare. Type custom_search_header_rec Required
	rec_two	The second record to compare. Type custom_search_header_rec Required

Returns

Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all

Function f_query_all(p_pidm      aobdosr.aobdosr_pidm%TYPE,
                     p_srch_name aobdosr.aobdosr_srch_name%TYPE)
  RETURN custom_search_header_ref

Selects all records for the entity.

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

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm      aobdosr.aobdosr_pidm%TYPE,
                     p_srch_name aobdosr.aobdosr_srch_name%TYPE)
  RETURN custom_search_header_ref

Selects one record using the key.

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

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN custom_search_header_ref

Selects one record using the ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

Function f_query_one_lock(p_pidm      aobdosr.aobdosr_pidm%TYPE,
                          p_srch_name aobdosr.aobdosr_srch_name%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN custom_search_header_ref

Selects one record and locks it.

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_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

p_create

Procedure p_create(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,
                   p_rowid_out         OUT gb_common.internal_record_id_type)

Creates a 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. P=Advancement Individuals, C=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_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm      aobdosr.aobdosr_pidm%TYPE,
                   p_srch_name aobdosr.aobdosr_srch_name%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a 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_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        aobdosr.aobdosr_pidm%TYPE,
                 p_srch_name   aobdosr.aobdosr_srch_name%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks a record.
If ROWID is not passed in, the record is located using the key values and the ROWID of the locked row is passed in p_rowid_inout

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_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

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

Updates a 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. P=Advancement Individuals, C=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_rowid	Database ROWID of the record to be updated. VARCHAR2(18)