index

Package gb_race_ethnicity

Common Business interface for the RACE_ETHNICITY API (gb_race_ethnicity).


Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if a record exists.
f_exists_by_rrac   Checks to see if GORRACE record exists that relies on row in GTVRRAC.
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.
f_get_description   *  Returns description for the code.
f_validate_edi_equiv   Returns 'Y' or 'N' depending on whether EMI Equivalent is valid or invalid.
f_new_ethnicity_values   Returns SELECT statement to populate Record Group for values of New Ethnicity
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
race_ethnicity_rec   Business Entity record type
race_ethnicity_ref   Entity cursor variable type
race_ethnicity_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name

Cursors
gorrace_c   Returns the record from rule table.


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(14) := 'RACE_ETHNICITY';

Business Entity Name


race_ethnicity_rec

TYPE race_ethnicity_rec IS RECORD (
  r_race_cde                gorrace.gorrace_race_cde%TYPE,
  r_desc                    gorrace.gorrace_desc%TYPE,
  r_user_id                 gorrace.gorrace_user_id%TYPE,
  r_rrac_code               gorrace.gorrace_rrac_code%TYPE,
  r_edi_equiv               gorrace.gorrace_edi_equiv%TYPE,
  r_lms_equiv               gorrace.gorrace_lms_equiv%TYPE,
  r_data_origin             gorrace.gorrace_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


race_ethnicity_ref

TYPE race_ethnicity_ref IS REF CURSOR RETURN race_ethnicity_rec;

Entity cursor variable type


race_ethnicity_tab

TYPE race_ethnicity_tab IS TABLE OF race_ethnicity_rec INDEX BY BINARY_INTEGER;

Entity table type


gorrace_c

CURSOR gorrace_c(
    p_code  gorrace.gorrace_race_cde%TYPE)
 RETURN gorrace%ROWTYPE;

Returns the record from rule table.


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_race_cde gorrace.gorrace_race_cde%TYPE,
                  p_rowid    gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_race_cde   race code referenced on the Person Identification Forms. The codes are institution defined. 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_rrac

FUNCTION f_exists_by_rrac(p_rrac_code gorrace.gorrace_rrac_code%TYPE)
  RETURN VARCHAR2

Checks to see if GORRACE record exists that relies on row in GTVRRAC.

Parameters
p_rrac_code   race code referenced on the Regulatory Race Validation Form. The codes are institution defined. VARCHAR2(3) Required Key

Returns
Y if found, otherwise N.


f_isequal

FUNCTION f_isequal(rec_one race_ethnicity_rec,
                   rec_two race_ethnicity_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 race_ethnicity_rec Required
rec_two   The second record to compare. Type race_ethnicity_rec Required

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


f_query_all

FUNCTION f_query_all(p_race_cde gorrace.gorrace_race_cde%TYPE)
  RETURN race_ethnicity_ref

Selects all records for the entity.

Parameters
p_race_cde   race code referenced on the Person Identification Forms. The codes are institution defined. VARCHAR2(3) Required Key

Returns
A cursor variable that will fetch the set of records.


f_query_one

FUNCTION f_query_one(p_race_cde gorrace.gorrace_race_cde%TYPE)
  RETURN race_ethnicity_ref

Selects one record using key.

Parameters
p_race_cde   race code referenced on the Person Identification Forms. The codes are institution defined. 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 race_ethnicity_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_race_cde gorrace.gorrace_race_cde%TYPE,
                          p_rowid    gb_common.internal_record_id_type DEFAULT NULL)
  RETURN race_ethnicity_ref

Selects one record and locks it.

Parameters
p_race_cde   race code referenced on the Person Identification Forms. The codes are institution defined. 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.


f_get_description

FUNCTION f_get_description(p_code gorrace.gorrace_race_cde%TYPE)
  RETURN VARCHAR2

  Returns description for the code.
 @param p_code  regulatory race code. These values will be used in the data col
lection of race information that is required by regulations established by the United States government. Other countries with race data collection requirements can also use this field to identify race codes. These codes are mapped to the institution defined codes on GORRACE.
 @return Description


f_validate_edi_equiv

FUNCTION f_validate_edi_equiv(p_edi_equiv gorrace.gorrace_edi_equiv%TYPE)
  RETURN VARCHAR2

Returns 'Y' or 'N' depending on whether EMI Equivalent is valid or invalid.

Parameters
p_edi_equiv   Returns  'Y' if valid, 'N' if invalid


f_new_ethnicity_values

FUNCTION f_new_ethnicity_values RETURN VARCHAR2

Returns SELECT statement to populate Record Group for values of New Ethnicity


p_create

PROCEDURE p_create(p_race_cde    gorrace.gorrace_race_cde%TYPE,
                   p_desc        gorrace.gorrace_desc%TYPE,
                   p_user_id     gorrace.gorrace_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rrac_code   gorrace.gorrace_rrac_code%TYPE DEFAULT NULL,
                   p_edi_equiv   gorrace.gorrace_edi_equiv%TYPE DEFAULT NULL,
                   p_lms_equiv   gorrace.gorrace_lms_equiv%TYPE DEFAULT NULL,
                   p_data_origin gorrace.gorrace_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_race_cde   Race code referenced on the Person Identification Forms. The codes are institution defined. VARCHAR2(3) Required Key
p_desc   Race description associated with the race code. VARCHAR2(60) Required
p_user_id   Oracle User ID of the person who inserted or last updated the data. VARCHAR2(30) Required
p_rrac_code   Regulatory race code. VARCHAR2(1)
p_edi_equiv   The EDI/SPEEDE race code that equates to the race code. VARCHAR2(1)
p_lms_equiv   The LMS (IA Plus) race code that equates to this Banner race code. Translation to this LMS code occurs during the LMS transaction feed from Banner FA. VARCHAR2(1)
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_race_cde gorrace.gorrace_race_cde%TYPE,
                   p_rowid    gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_race_cde   Race code referenced on the Person Identification Forms. The codes are institution defined. VARCHAR2(3) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

PROCEDURE p_lock(p_race_cde    gorrace.gorrace_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_race_cde   Race code referenced on the Person Identification Forms. The codes are institution defined. VARCHAR2(3) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

PROCEDURE p_update(p_race_cde    gorrace.gorrace_race_cde%TYPE,
                   p_desc        gorrace.gorrace_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     gorrace.gorrace_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rrac_code   gorrace.gorrace_rrac_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_edi_equiv   gorrace.gorrace_edi_equiv%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lms_equiv   gorrace.gorrace_lms_equiv%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin gorrace.gorrace_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_race_cde   Race code referenced on the Person Identification Forms. The codes are institution defined. VARCHAR2(3) Required Key
p_desc   Race description associated with the race code. VARCHAR2(60) Required
p_user_id   User who inserted or last updated the data. VARCHAR2(30) Required
p_rrac_code   Regulatory race code. VARCHAR2(1)
p_edi_equiv   EDI/SPEEDE race code that equates to the race code. VARCHAR2(1)
p_lms_equiv   LMS (IA Plus) race code that equates to this Banner race code. Translation to this LMS code occurs during the LMS transaction feed from Banner FA. VARCHAR2(1)
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)