Package gb_cm

Package gb_cm_rules

This package provides the Common Business interface for Common Matching Rules

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists.
f_exists_by_column	Checks to see if a record exists for a spcified data dictionary column.
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_all_reqd_added	Returns BOOLEAN 'TRUE' if number of GORCMSR rows for one GORCMSP row
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

cm_rules_rec
cm_rules_ref	Entity cursor variable type
cm_rules_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(8) := 'CM_RULES';

Business Entity name

cm_rules_rec

TYPE cm_rules_rec IS RECORD (
   r_cmsc_code               gorcmsr.gorcmsr_cmsc_code%TYPE,
   r_priority_no             gorcmsr.gorcmsr_priority_no%TYPE,
   r_column_name             gorcmsr.gorcmsr_column_name%TYPE,
   r_length                  gorcmsr.gorcmsr_length%TYPE,
   r_data_req_ind            gorcmsr.gorcmsr_data_req_ind%TYPE,
   r_user_id                 gorcmsr.gorcmsr_user_id%TYPE,
   r_data_origin             gorcmsr.gorcmsr_data_origin%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

cm_rules_ref

TYPE cm_rules_ref IS REF CURSOR RETURN cm_rules_rec;

Entity cursor variable type

cm_rules_tab

TYPE cm_rules_tab IS TABLE OF cm_rules_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   gorcmsr.gorcmsr_cmsc_code%TYPE,
                  p_priority_no gorcmsr.gorcmsr_priority_no%TYPE,
                  p_column_name gorcmsr.gorcmsr_column_name%TYPE DEFAULT NULL,
                  p_rowid       VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_cmsc_code	Common Matching Source Code associated with rules.
	p_priority_no	Priority number of rule to be processed.
	p_column_name	Database column name associated with element used for Common Matching process.
	p_column_name	If specified, it will attempt to identify a single row. If not specified it will return 'Y' if it matches one or more rows. Optional.

Returns

Y if found, otherwise N

f_exists_by_column

FUNCTION f_exists_by_column(p_column_name gorcmsr.gorcmsr_column_name%TYPE)
  RETURN VARCHAR2

Checks to see if a record exists for a spcified data dictionary column.

Parameters

p_column_name

Database column name associated with element used for Common Matching process.

Returns

Y if found, otherwise N

f_isequal

FUNCTION f_isequal(rec_one cm_rules_rec,
                   rec_two cm_rules_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. Defined as type cm_rules_rec.
	rec_two	The second record to compare. Defined as type cm_rules_rec.

Returns

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

f_query_all

FUNCTION f_query_all(p_cmsc_code   gorcmsr.gorcmsr_cmsc_code%TYPE,
                     p_priority_no gorcmsr.gorcmsr_priority_no%TYPE,
                     p_column_name gorcmsr.gorcmsr_column_name%TYPE DEFAULT NULL)
  RETURN cm_rules_ref

Selects all records for the entity.
This query uses all the key values to locate a record.

Parameters

	p_cmsc_code	Common Matching Source Code associated with rules.
	p_priority_no	Priority number of rule to be processed.
	p_column_name	Database column name associated with element used for Common Matching process.

Returns

A cursor variable that will fetch the set of records

f_query_one

FUNCTION f_query_one(p_cmsc_code   gorcmsr.gorcmsr_cmsc_code%TYPE,
                     p_priority_no gorcmsr.gorcmsr_priority_no%TYPE,
                     p_column_name gorcmsr.gorcmsr_column_name%TYPE)
  RETURN cm_rules_ref

Selects one record using key.
Always returns the current record for the source code, priority number, column_name.

Parameters

	p_cmsc_code	Common Matching Source Code associated with rules.
	p_priority_no	Priority number of rule to be processed.
	p_column_name	Database column name associated with element used for Common Matching process.

Returns

A cursor variable that will fetch exactly one record

f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid VARCHAR2) RETURN cm_rules_ref

Selects one record using ROWID.

Parameters

p_rowid

Database ROWID of record to select

Returns

A cursor variable that will fetch exactly one record

f_all_reqd_added

FUNCTION f_all_reqd_added(p_cmsc_code   gorcmsr.gorcmsr_cmsc_code%TYPE,
                          p_priority_no gorcmsr.gorcmsr_priority_no%TYPE,
                          p_column_name gorcmsr.gorcmsr_column_name%TYPE,
                          p_user_id     gorcmsr.gorcmsr_user_id%TYPE)
  RETURN BOOLEAN

Returns BOOLEAN 'TRUE' if number of GORCMSR rows for one GORCMSP row
equals number of GORCMDD rows set to be required elements for
Common Matching rules.

Parameters

	p_cmsc_code	Common Matching Source Code associated with rules.
	p_priority_no	Priority number of rule to be processed.
	p_column_name	Database column name associated with element used for Common Matching process.
	p_user_id	Oracle User ID

Returns

BOOLEAN TRUE or FALSE

p_create

PROCEDURE p_create(p_cmsc_code    gorcmsr.gorcmsr_cmsc_code%TYPE,
                   p_priority_no  gorcmsr.gorcmsr_priority_no%TYPE,
                   p_column_name  gorcmsr.gorcmsr_column_name%TYPE,
                   p_length       gorcmsr.gorcmsr_length%TYPE,
                   p_data_req_ind gorcmsr.gorcmsr_data_req_ind%TYPE DEFAULT 'Y',
                   p_user_id      gorcmsr.gorcmsr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin  gorcmsr.gorcmsr_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out    OUT VARCHAR2)

Creates a record.

Parameters

p_cmsc_code

Common Matching Source Code associated with rules.

p_priority_no

Priority number of rule to be processed.

p_column_name

Database column name associated with element used for Common Matching process.

p_length

Number of characters that will be matched in Common Matching process.

p_data_req_ind

Data required indicator.

	R	Indicates this element is required both in database and from input source.
	Y	Indicates data may be null either in database of from input source.

p_user_id

Oracle User ID of the User who created or last updated the record.

p_data_origin

Application source for this database row.

p_rowid_out

Database ROWID of record created

p_delete

PROCEDURE p_delete(p_cmsc_code   gorcmsr.gorcmsr_cmsc_code%TYPE,
                   p_priority_no gorcmsr.gorcmsr_priority_no%TYPE,
                   p_column_name gorcmsr.gorcmsr_column_name%TYPE,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_cmsc_code	Common Matching Source Code associated with rules.
	p_priority_no	Priority number of rule to be processed.
	p_column_name	Database column name associated with element used for Common Matching process.
	p_rowid	Database ROWID of record to delete

p_lock

PROCEDURE p_lock(p_cmsc_code   gorcmsr.gorcmsr_cmsc_code%TYPE,
                 p_priority_no gorcmsr.gorcmsr_priority_no%TYPE,
                 p_column_name gorcmsr.gorcmsr_column_name%TYPE,
                 p_rowid_inout IN OUT VARCHAR2)

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	Common Matching Source Code associated with rules.
	p_priority_no	Priority number of rule to be processed.
	p_column_name	Database column name associated with element used for Common Matching process.
	p_rowid_inout	Database ROWID of record to lock

p_update

PROCEDURE p_update(p_cmsc_code    gorcmsr.gorcmsr_cmsc_code%TYPE,
                   p_priority_no  gorcmsr.gorcmsr_priority_no%TYPE,
                   p_column_name  gorcmsr.gorcmsr_column_name%TYPE,
                   p_length       gorcmsr.gorcmsr_length%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_req_ind gorcmsr.gorcmsr_data_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id      gorcmsr.gorcmsr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin  gorcmsr.gorcmsr_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid        VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters

p_cmsc_code

Common Matching Source Code associated with rules.

p_priority_no

Priority number of rule to be processed.

p_column_name

Database column name associated with element used for Common Matching process.

p_length

Number of characters that will be matched in Common Matching process.

p_data_req_ind

Data required indicator.

	R	Indicates this element is required both in database and from input source.
	Y	Indicates data may be null either in database of from input source.

p_user_id

Oracle User ID of the User who created or last updated the record.

p_data_origin

Application source for this database row.

p_rowid

Database ROWID of record to update