Package gb_cm_disp

Package gb_cm_disp_hier

Common Business interface for the Common Matching Display Hierarchy API (gb_cm_disp_hier).

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists.
f_exists_by_type_seq_code	Checks to see 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

cm_disp_hier_rec	Business Entity record type
cm_disp_hier_ref	Entity cursor variable type
cm_disp_hier_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(12) := 'CM_DISP_HIER';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

cm_disp_hier_rec

TYPE cm_disp_hier_rec IS RECORD (
  r_cmsc_code               gorcmdh.gorcmdh_cmsc_code%TYPE,
  r_hier_type               gorcmdh.gorcmdh_hier_type%TYPE,
  r_hier_seq_no             gorcmdh.gorcmdh_hier_seq_no%TYPE,
  r_hier_code               gorcmdh.gorcmdh_hier_code%TYPE,
  r_user_id                 gorcmdh.gorcmdh_user_id%TYPE,
  r_data_origin             gorcmdh.gorcmdh_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

cm_disp_hier_ref

TYPE cm_disp_hier_ref IS REF CURSOR RETURN cm_disp_hier_rec;

Entity cursor variable type

cm_disp_hier_tab

TYPE cm_disp_hier_tab IS TABLE OF cm_disp_hier_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_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                  p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE,
                  p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_exists_by_type_seq_code

FUNCTION f_exists_by_type_seq_code(p_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                                   p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE DEFAULT NULL,
                                   p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%TYPE DEFAULT NULL,
                                   p_hier_code   gorcmdh.gorcmdh_hier_code%TYPE DEFAULT NULL,
                                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) Required Key
	p_hier_seq_no	Sequence of the Hierarchy code within the Hierarchy type. NUMBER(2) Optional
	p_hier_code	Hierarchy code for the Hierarchy type. Validated against STVATYP, GTVEMAL, or STVTELE. VARCHAR2(4) Optional
	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 cm_disp_hier_rec,
                   rec_two cm_disp_hier_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 cm_disp_hier_rec Required
	rec_two	The second record to compare. Type cm_disp_hier_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_cmsc_code gorcmdh.gorcmdh_cmsc_code%TYPE,
                     p_hier_type gorcmdh.gorcmdh_hier_type%TYPE)
  RETURN cm_disp_hier_ref

Selects all records for the entity.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) Required Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                     p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE,
                     p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%TYPE)
  RETURN cm_disp_hier_ref

Selects one record using key.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) 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 cm_disp_hier_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_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                          p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE,
                          p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN cm_disp_hier_ref

Selects one record and locks it.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) 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_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                   p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE,
                   p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%TYPE,
                   p_hier_code   gorcmdh.gorcmdh_hier_code%TYPE,
                   p_user_id     gorcmdh.gorcmdh_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorcmdh.gorcmdh_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) Required Key
	p_hier_seq_no	Sequence of the Hierarchy code within the Hierarchy type. NUMBER(2) Required
	p_hier_code	Hierarchy code for the Hierarchy type. Validated against STVATYP, GTVEMAL, or STVTELE. VARCHAR2(4) Required
	p_user_id	User ID of the User who created or last updated the record. 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_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                   p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE,
                   p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                 p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE,
                 p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%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_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_cmsc_code   gorcmdh.gorcmdh_cmsc_code%TYPE,
                   p_hier_type   gorcmdh.gorcmdh_hier_type%TYPE,
                   p_hier_seq_no gorcmdh.gorcmdh_hier_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_hier_code   gorcmdh.gorcmdh_hier_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     gorcmdh.gorcmdh_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorcmdh.gorcmdh_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_cmsc_code	The Common Matching Source Code. VARCHAR2(20) Required Key
	p_hier_type	Contains one of three values: ATYP for Address Type, EMAL for E-mail Type, or TELE for Telephone Type. VARCHAR2(4) Required Key
	p_hier_seq_no	Sequence of the Hierarchy code within the Hierarchy type. NUMBER(2) Required
	p_hier_code	Hierarchy code for the Hierarchy type. Validated against STVATYP, GTVEMAL, or STVTELE. VARCHAR2(4) Required
	p_user_id	User ID of the User who created or last updated the record. 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)