Package gb_person

Package gb_person_race

Common Business interface for the PERSON_RACE API (gb_person_race).

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists.
f_exists_by_race_cde	Checks to see if a record exists by GORPRAC_RACE_CDE for any PIDM.
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

person_race_rec	Business Entity record type
person_race_ref	Entity cursor variable type
person_race_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(11) := 'PERSON_RACE';

Business Entity Name

person_race_rec

TYPE person_race_rec IS RECORD (
  r_pidm                    gorprac.gorprac_pidm%TYPE,
  r_race_cde                gorprac.gorprac_race_cde%TYPE,
  r_user_id                 gorprac.gorprac_user_id%TYPE,
  r_data_origin             gorprac.gorprac_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

person_race_ref

TYPE person_race_ref IS REF CURSOR RETURN person_race_rec;

Entity cursor variable type

person_race_tab

TYPE person_race_tab IS TABLE OF person_race_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     gorprac.gorprac_pidm%TYPE,
                  p_race_cde gorprac.gorprac_race_cde%TYPE,
                  p_rowid    gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_pidm	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_exists_by_race_cde

FUNCTION f_exists_by_race_cde(p_race_cde gorprac.gorprac_race_cde%TYPE)
  RETURN VARCHAR2

Checks to see if a record exists by GORPRAC_RACE_CDE for any PIDM.

Parameters

p_race_cde

institution defined race code on GORRACE . VARCHAR2(3) Required Key

Returns

Y if found, otherwise N.

f_isequal

FUNCTION f_isequal(rec_one person_race_rec,
                   rec_two person_race_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 person_race_rec Required
	rec_two	The second record to compare. Type person_race_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     gorprac.gorprac_pidm%TYPE,
                     p_race_cde gorprac.gorprac_race_cde%TYPE)
  RETURN person_race_ref

Selects all records for the entity.

Parameters

	p_pidm	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) Required Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_pidm     gorprac.gorprac_pidm%TYPE,
                     p_race_cde gorprac.gorprac_race_cde%TYPE)
  RETURN person_race_ref

Selects one record using key.

Parameters

	p_pidm	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) 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 person_race_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_pidm     gorprac.gorprac_pidm%TYPE,
                          p_race_cde gorprac.gorprac_race_cde%TYPE,
                          p_rowid    gb_common.internal_record_id_type DEFAULT NULL)
  RETURN person_race_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) 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        gorprac.gorprac_pidm%TYPE,
                   p_race_cde    gorprac.gorprac_race_cde%TYPE,
                   p_user_id     gorprac.gorprac_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorprac.gorprac_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_pidm	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) Required Key
	p_user_id	User who inserted or last updated the data. VARCHAR2(30) Required
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm     gorprac.gorprac_pidm%TYPE,
                   p_race_cde gorprac.gorprac_race_cde%TYPE,
                   p_rowid    gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_pidm        gorprac.gorprac_pidm%TYPE,
                 p_race_cde    gorprac.gorprac_race_cde%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	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_pidm        gorprac.gorprac_pidm%TYPE,
                   p_race_cde    gorprac.gorprac_race_cde%TYPE,
                   p_user_id     gorprac.gorprac_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorprac.gorprac_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	Internal System Identification Number. NUMBER(8) Required Key
	p_race_cde	institution defined race code on GORRACE . VARCHAR2(3) Required Key
	p_user_id	User who inserted or last updated the data. VARCHAR2(30) Required
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)