Package ab_custom_search

Package ab_custom_search_detail

This package provides the Common Business interface for the Custom Search Detail API (ab_custom_search_detail).

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.

After a new Advancement Officer Search Options Preference Header record (AOBDOSR) is defined using the Custom Search Header API (ab_custom_search_header), Advancement Officer Search Options Preference Repeating records (AORDOSR) are created using this API.

The Advancement Officer Search Options Preference Repeating records (AORDOSR) are created using Advancement Officer Search Option Codes (ATVDOSR_CODE) from the Advancement Officer Search Options Table (ATVDOSR).

Elements contained in the Advancement Officer Search Options Preference Repeating record (AORDOSR) are:

Internal Identification Number - the unquie identifier (PIDM) of the Advancement Officer who created the search.
Search Name - 30-character name for the search.
Advancement Officer Search Code - 10-character code used to identify the individual search options.
Values must exist on the Advancement Officer Search Options Table (ATVDOSR).
Display Sequence Number - Numeric value from 01 to 99 used to determine the order to display the search options on the search page.
Display Indicator - 'Y' (checked) indicates that the search option should be displayed on the search page.
'N' (unchecked) indicates that the search option should not be displayed on the search 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_detail_rec	Business Entity record type
custom_search_detail_ref	Entity cursor variable type
custom_search_detail_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_DETAIL';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

custom_search_detail_rec

TYPE custom_search_detail_rec IS RECORD (
  r_pidm                    aordosr.aordosr_pidm%TYPE,
  r_srch_name               aordosr.aordosr_srch_name%TYPE,
  r_dosr_code               aordosr.aordosr_dosr_code%TYPE,
  r_disp_seqno              aordosr.aordosr_disp_seqno%TYPE,
  r_disp_ind                aordosr.aordosr_disp_ind%TYPE,
  r_user_id                 aordosr.aordosr_user_id%TYPE,
  r_data_origin             aordosr.aordosr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

custom_search_detail_ref

TYPE custom_search_detail_ref IS REF CURSOR RETURN custom_search_detail_rec;

Entity cursor variable type

custom_search_detail_tab

TYPE custom_search_detail_tab IS TABLE OF custom_search_detail_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      aordosr.aordosr_pidm%TYPE,
                  p_srch_name aordosr.aordosr_srch_name%TYPE,
                  p_dosr_code aordosr.aordosr_dosr_code%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_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) 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_detail_rec,
                   rec_two custom_search_detail_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_detail_rec Required
	rec_two	The second record to compare. Type custom_search_detail_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      aordosr.aordosr_pidm%TYPE,
                     p_srch_name aordosr.aordosr_srch_name%TYPE,
                     p_dosr_code aordosr.aordosr_dosr_code%TYPE)
  RETURN custom_search_detail_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
	p_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm      aordosr.aordosr_pidm%TYPE,
                     p_srch_name aordosr.aordosr_srch_name%TYPE,
                     p_dosr_code aordosr.aordosr_dosr_code%TYPE)
  RETURN custom_search_detail_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
	p_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) 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_detail_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      aordosr.aordosr_pidm%TYPE,
                          p_srch_name aordosr.aordosr_srch_name%TYPE,
                          p_dosr_code aordosr.aordosr_dosr_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN custom_search_detail_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_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) 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        aordosr.aordosr_pidm%TYPE,
                   p_srch_name   aordosr.aordosr_srch_name%TYPE,
                   p_dosr_code   aordosr.aordosr_dosr_code%TYPE,
                   p_disp_seqno  aordosr.aordosr_disp_seqno%TYPE,
                   p_disp_ind    aordosr.aordosr_disp_ind%TYPE,
                   p_user_id     aordosr.aordosr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin aordosr.aordosr_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_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) Required Key
	p_disp_seqno	Display Order Sequence Number. NUMBER(2) Required
	p_disp_ind	Indicator for whether the search option should be displayed on the search page. VARCHAR2(1) 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      aordosr.aordosr_pidm%TYPE,
                   p_srch_name aordosr.aordosr_srch_name%TYPE,
                   p_dosr_code aordosr.aordosr_dosr_code%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_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        aordosr.aordosr_pidm%TYPE,
                 p_srch_name   aordosr.aordosr_srch_name%TYPE,
                 p_dosr_code   aordosr.aordosr_dosr_code%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_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_pidm        aordosr.aordosr_pidm%TYPE,
                   p_srch_name   aordosr.aordosr_srch_name%TYPE,
                   p_dosr_code   aordosr.aordosr_dosr_code%TYPE,
                   p_disp_seqno  aordosr.aordosr_disp_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_disp_ind    aordosr.aordosr_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     aordosr.aordosr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin aordosr.aordosr_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_dosr_code	Advancement Officer Search Option Code. VARCHAR2(10) Required Key
	p_disp_seqno	Display Order Sequence Number. NUMBER(2) Required
	p_disp_ind	Indicator for whether the search option should be displayed on the search page. VARCHAR2(1) 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)