Package gp_geniden

Common Business interface for the GENIDEN API (gp_geniden).

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 key.
f_query_by_rowid	Selects one record using 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

geniden_rec	Business Entity record type
geniden_ref	Entity cursor variable type
geniden_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(7) := 'GENIDEN';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

geniden_rec

TYPE geniden_rec IS RECORD (
  r_gidm                    geniden.geniden_gidm%TYPE,
  r_syst_code               geniden.geniden_syst_code%TYPE,
  r_entity_code             geniden.geniden_entity_code%TYPE,
  r_id                      geniden.geniden_id%TYPE,
  r_last_name               geniden.geniden_last_name%TYPE,
  r_first_name              geniden.geniden_first_name%TYPE,
  r_mi                      geniden.geniden_mi%TYPE,
  r_house_number            geniden.geniden_house_number%TYPE,
  r_street_line1            geniden.geniden_street_line1%TYPE,
  r_street_line2            geniden.geniden_street_line2%TYPE,
  r_street_line3            geniden.geniden_street_line3%TYPE,
  r_street_line4            geniden.geniden_street_line4%TYPE,
  r_city                    geniden.geniden_city%TYPE,
  r_stat_code               geniden.geniden_stat_code%TYPE,
  r_zip                     geniden.geniden_zip%TYPE,
  r_natn_code               geniden.geniden_natn_code%TYPE,
  r_phone_area              geniden.geniden_phone_area%TYPE,
  r_phone_number            geniden.geniden_phone_number%TYPE,
  r_phone_ext               geniden.geniden_phone_ext%TYPE,
  r_ctry_code_phone         geniden.geniden_ctry_code_phone%TYPE,
  r_ssn                     geniden.geniden_ssn%TYPE,
  r_birth_date              geniden.geniden_birth_date%TYPE,
  r_sex                     geniden.geniden_sex%TYPE,
  r_email_address           geniden.geniden_email_address%TYPE,
  r_atyp_code               geniden.geniden_atyp_code%TYPE,
  r_tele_code               geniden.geniden_tele_code%TYPE,
  r_emal_code               geniden.geniden_emal_code%TYPE,
  r_asrc_code               geniden.geniden_asrc_code%TYPE,
  r_surname_prefix          geniden.geniden_surname_prefix%TYPE,
  r_pidm                    geniden.geniden_pidm%TYPE,
  r_match_status            geniden.geniden_match_status%TYPE,
  r_match_date              geniden.geniden_match_date%TYPE,
  r_load_status             geniden.geniden_load_status%TYPE,
  r_load_date               geniden.geniden_load_date%TYPE,
  r_user_id                 geniden.geniden_user_id%TYPE,
  r_name_prefix             geniden.geniden_name_prefix%TYPE,
  r_name_suffix             geniden.geniden_name_suffix%TYPE,
  r_pref_first_name         geniden.geniden_pref_first_name%TYPE,
  r_cnty_code               geniden.geniden_cnty_code%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

geniden_ref

TYPE geniden_ref IS REF CURSOR RETURN geniden_rec;

Entity cursor variable type

geniden_tab

TYPE geniden_tab IS TABLE OF geniden_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_gidm  geniden.geniden_gidm%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_gidm	Unique ID of General Matching Person. NUMBER(8) 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 geniden_rec,
                   rec_two geniden_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 geniden_rec Required
	rec_two	The second record to compare. Type geniden_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_gidm geniden.geniden_gidm%TYPE) RETURN geniden_ref

Selects all records for the entity.

Parameters

p_gidm

Unique ID of General Matching Person. NUMBER(8) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_gidm geniden.geniden_gidm%TYPE) RETURN geniden_ref

Selects one record using key.

Parameters

p_gidm

Unique ID of General Matching Person. NUMBER(8) 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 geniden_ref

Selects one record using 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_gidm  geniden.geniden_gidm%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN geniden_ref

Selects one record and locks it.

Parameters

	p_gidm	Unique ID of General Matching Person. NUMBER(8) 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_gidm            geniden.geniden_gidm%TYPE,
                   p_syst_code       geniden.geniden_syst_code%TYPE,
                   p_entity_code     geniden.geniden_entity_code%TYPE,
                   p_id              geniden.geniden_id%TYPE,
                   p_last_name       geniden.geniden_last_name%TYPE DEFAULT NULL,
                   p_first_name      geniden.geniden_first_name%TYPE DEFAULT NULL,
                   p_mi              geniden.geniden_mi%TYPE DEFAULT NULL,
                   p_house_number    geniden.geniden_house_number%TYPE DEFAULT NULL,
                   p_street_line1    geniden.geniden_street_line1%TYPE DEFAULT NULL,
                   p_street_line2    geniden.geniden_street_line2%TYPE DEFAULT NULL,
                   p_street_line3    geniden.geniden_street_line3%TYPE DEFAULT NULL,
                   p_street_line4    geniden.geniden_street_line4%TYPE DEFAULT NULL,
                   p_city            geniden.geniden_city%TYPE DEFAULT NULL,
                   p_stat_code       geniden.geniden_stat_code%TYPE DEFAULT NULL,
                   p_zip             geniden.geniden_zip%TYPE DEFAULT NULL,
                   p_natn_code       geniden.geniden_natn_code%TYPE DEFAULT NULL,
                   p_phone_area      geniden.geniden_phone_area%TYPE DEFAULT NULL,
                   p_phone_number    geniden.geniden_phone_number%TYPE DEFAULT NULL,
                   p_phone_ext       geniden.geniden_phone_ext%TYPE DEFAULT NULL,
                   p_ctry_code_phone geniden.geniden_ctry_code_phone%TYPE DEFAULT NULL,
                   p_ssn             geniden.geniden_ssn%TYPE DEFAULT NULL,
                   p_birth_date      geniden.geniden_birth_date%TYPE DEFAULT NULL,
                   p_sex             geniden.geniden_sex%TYPE DEFAULT NULL,
                   p_email_address   geniden.geniden_email_address%TYPE DEFAULT NULL,
                   p_atyp_code       geniden.geniden_atyp_code%TYPE DEFAULT NULL,
                   p_tele_code       geniden.geniden_tele_code%TYPE DEFAULT NULL,
                   p_emal_code       geniden.geniden_emal_code%TYPE DEFAULT NULL,
                   p_asrc_code       geniden.geniden_asrc_code%TYPE DEFAULT NULL,
                   p_surname_prefix  geniden.geniden_surname_prefix%TYPE DEFAULT NULL,
                   p_pidm            geniden.geniden_pidm%TYPE DEFAULT NULL,
                   p_match_status    geniden.geniden_match_status%TYPE DEFAULT NULL,
                   p_match_date      geniden.geniden_match_date%TYPE DEFAULT NULL,
                   p_load_status     geniden.geniden_load_status%TYPE DEFAULT NULL,
                   p_load_date       geniden.geniden_load_date%TYPE DEFAULT NULL,
                   p_user_id         geniden.geniden_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_name_prefix     geniden.geniden_name_prefix%TYPE DEFAULT NULL,
                   p_name_suffix     geniden.geniden_name_suffix%TYPE DEFAULT NULL,
                   p_pref_first_name geniden.geniden_pref_first_name%TYPE DEFAULT NULL,
                   p_cnty_code       geniden.geniden_cnty_code%TYPE DEFAULT NULL,
                   p_rowid_out       OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_gidm	Unique ID of General Matching Person. NUMBER(8) Required Key
	p_syst_code	Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required
	p_entity_code	Identifies whether record is person or non-person to be created. Valid values P = person, C = non-person. VARCHAR2(1) Required
	p_id	Identification number used to access person on-line. VARCHAR2(9) Required
	p_last_name	Last name of person. VARCHAR2(60)
	p_first_name	First name of person. VARCHAR2(60)
	p_mi	Middle name of person. VARCHAR2(60)
	p_house_number	Building or lot number on a street or in an area. VARCHAR2(10)
	p_street_line1	First line of the address associated with the person. VARCHAR2(75)
	p_street_line2	Second line of the address associated with the person. VARCHAR2(75)
	p_street_line3	Third line of the address associated with the person. VARCHAR2(75)
	p_street_line4	Fourth line of the address associated with the person. VARCHAR2(75)
	p_city	City associated with the address of the person. VARCHAR2(50)
	p_stat_code	State associated with the address of the person. VARCHAR2(3)
	p_zip	Postal code associated with the address of the person. VARCHAR2(30)
	p_natn_code	Nation/country associated with the address of the person. VARCHAR2(5)
	p_phone_area	Telephone number area code. VARCHAR2(6)
	p_phone_number	Telephone number. VARCHAR2(12)
	p_phone_ext	Telephone number extension. VARCHAR2(10)
	p_ctry_code_phone	Telephone code that designates the region and country. VARCHAR2(4)
	p_ssn	National ID number of the person. VARCHAR2(15)
	p_birth_date	Person birth date. DATE
	p_sex	Gender of the person. Valid values are M (male), F (female), N (unknown). VARCHAR2(1)
	p_email_address	Email address used for the person for matching purposes. VARCHAR2(128)
	p_atyp_code	Default address type code for the person for matching purposes. VARCHAR2(2)
	p_tele_code	Default telephone type code for the person for matching purposes. VARCHAR2(4)
	p_emal_code	Default email type code for the person for matching purposes. VARCHAR2(4)
	p_asrc_code	Default address source code for the person for matching purposes. VARCHAR2(4)
	p_surname_prefix	Name tag preceding the last name or surname. (Van, Von, Mac, etc.). VARCHAR2(60)
	p_pidm	SPRIDEN_PIDM for matched proxy record. This value is filled in once the general person is matched or migrated to SPRIDEN. NUMBER(8)
	p_match_status	The status code of the match to an existing person in SPRIDEN. Valid values are (N)new, (M)matched. A blank value is unprocessed. VARCHAR2(1)
	p_match_date	The date the match to SPRIDEN took place. DATE
	p_load_status	Status to indicate if person was matched to Banner or new to Banner. VARCHAR2(1)
	p_load_date	Date person record was migrated to Production Banner tables. DATE
	p_user_id	The ID for the user that most recently updated the record. VARCHAR2(30)
	p_name_prefix	Prefix (Mr, Mrs, etc) used before the person name. VARCHAR2(20)
	p_name_suffix	Suffix (Jr, Sr, etc) used after the person name. VARCHAR2(20)
	p_pref_first_name	Preferred first name associated with the person. VARCHAR2(60)
	p_cnty_code	The county associated with the address of the person/non-person to be created. VARCHAR2(5)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_gidm  geniden.geniden_gidm%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_gidm	Unique ID of General Matching Person. NUMBER(8) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_gidm        geniden.geniden_gidm%TYPE,
                 p_rowid_inout IN OUT NOCOPY 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_gidm	Unique ID of General Matching Person. NUMBER(8) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_gidm            geniden.geniden_gidm%TYPE,
                   p_syst_code       geniden.geniden_syst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_entity_code     geniden.geniden_entity_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_id              geniden.geniden_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_last_name       geniden.geniden_last_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_first_name      geniden.geniden_first_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_mi              geniden.geniden_mi%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_house_number    geniden.geniden_house_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line1    geniden.geniden_street_line1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line2    geniden.geniden_street_line2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line3    geniden.geniden_street_line3%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line4    geniden.geniden_street_line4%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_city            geniden.geniden_city%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stat_code       geniden.geniden_stat_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_zip             geniden.geniden_zip%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_natn_code       geniden.geniden_natn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_phone_area      geniden.geniden_phone_area%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_phone_number    geniden.geniden_phone_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_phone_ext       geniden.geniden_phone_ext%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ctry_code_phone geniden.geniden_ctry_code_phone%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ssn             geniden.geniden_ssn%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_birth_date      geniden.geniden_birth_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_sex             geniden.geniden_sex%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_email_address   geniden.geniden_email_address%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_code       geniden.geniden_atyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tele_code       geniden.geniden_tele_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_emal_code       geniden.geniden_emal_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_asrc_code       geniden.geniden_asrc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_surname_prefix  geniden.geniden_surname_prefix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pidm            geniden.geniden_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_match_status    geniden.geniden_match_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_match_date      geniden.geniden_match_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_load_status     geniden.geniden_load_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_load_date       geniden.geniden_load_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_user_id         geniden.geniden_user_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_name_prefix     geniden.geniden_name_prefix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_name_suffix     geniden.geniden_name_suffix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pref_first_name geniden.geniden_pref_first_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cnty_code       geniden.geniden_cnty_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_gidm	Unique ID of General Matching Person. NUMBER(8) Required Key
	p_syst_code	Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required
	p_entity_code	Identifies whether record is person or non-person to be created. Valid values P = person, C = non-person. VARCHAR2(1) Required
	p_id	Identification number used to access person on-line. VARCHAR2(9) Required
	p_last_name	Last name of person. VARCHAR2(60)
	p_first_name	First name of person. VARCHAR2(60)
	p_mi	Middle name of person. VARCHAR2(60)
	p_house_number	Building or lot number on a street or in an area. VARCHAR2(10)
	p_street_line1	First line of the address associated with the person. VARCHAR2(75)
	p_street_line2	Second line of the address associated with the person. VARCHAR2(75)
	p_street_line3	Third line of the address associated with the person. VARCHAR2(75)
	p_street_line4	Fourth line of the address associated with the person. VARCHAR2(75)
	p_city	City associated with the address of the person. VARCHAR2(50)
	p_stat_code	State associated with the address of the person. VARCHAR2(3)
	p_zip	Postal code associated with the address of the person. VARCHAR2(30)
	p_natn_code	Nation/country associated with the address of the person. VARCHAR2(5)
	p_phone_area	Telephone number area code. VARCHAR2(6)
	p_phone_number	Telephone number. VARCHAR2(12)
	p_phone_ext	Telephone number extension. VARCHAR2(10)
	p_ctry_code_phone	Telephone code that designates the region and country. VARCHAR2(4)
	p_ssn	National ID number of the person. VARCHAR2(15)
	p_birth_date	Person birth date. DATE
	p_sex	Gender of the person. Valid values are M (male), F (female), N (unknown). VARCHAR2(1)
	p_email_address	Email address used for the person for matching purposes. VARCHAR2(128)
	p_atyp_code	Default address type code for the person for matching purposes. VARCHAR2(2)
	p_tele_code	Default telephone type code for the person for matching purposes. VARCHAR2(4)
	p_emal_code	Default email type code for the person for matching purposes. VARCHAR2(4)
	p_asrc_code	Default address source code for the person for matching purposes. VARCHAR2(4)
	p_surname_prefix	Name tag preceding the last name or surname. (Van, Von, Mac, etc.). VARCHAR2(60)
	p_pidm	SPRIDEN_PIDM for matched proxy record. This value is filled in once the general person is matched or migrated to SPRIDEN. NUMBER(8)
	p_match_status	The status code of the match to an existing person in SPRIDEN. Valid values are (N)new, (M)matched. A blank value is unprocessed. VARCHAR2(1)
	p_match_date	The date the match to SPRIDEN took place. DATE
	p_load_status	Status to indicate if person was matched to Banner or new to Banner. VARCHAR2(1)
	p_load_date	Date person record was migrated to Production Banner tables. DATE
	p_user_id	The ID for the user that most recently updated the record. VARCHAR2(30)
	p_name_prefix	Prefix (Mr, Mrs, etc) used before the person name. VARCHAR2(20)
	p_name_suffix	Suffix (Jr, Sr, etc) used after the person name. VARCHAR2(20)
	p_pref_first_name	Preferred first name associated with the person. VARCHAR2(60)
	p_cnty_code	The county associated with the address of the person/non-person to be created. VARCHAR2(5)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)