index

Package gb_cm_source_priority

This package provides the Common Business interface for Common Matching Source Priority.
 
The rules defined for each Common Matching Source code must be provided a priority number.
The priority number will define the sequence of the rules to be processed by the Common Matching procedure.


Program units
f_api_version   Returns the API version number.
f_exists   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_all_by_cmsc   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 Create a priority number and description for each ruled to be defined for the Common Matching Source Code.
p_delete   Deletes a record
p_lock   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
p_update   Updates a record

Types
cm_source_priority_rec   Entity record type
cm_source_priority_ref   Entity cursor variable type
cm_source_priority_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity name


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(18) := 'CM_SOURCE_PRIORITY';

Business Entity name


cm_source_priority_rec

TYPE cm_source_priority_rec IS RECORD (
   r_cmsc_code               gorcmsp.gorcmsp_cmsc_code%TYPE,
   r_priority_no             gorcmsp.gorcmsp_priority_no%TYPE,
   r_desc                    gorcmsp.gorcmsp_desc%TYPE,
   r_user_id                 gorcmsp.gorcmsp_user_id%TYPE,
   r_data_origin             gorcmsp.gorcmsp_data_origin%TYPE,
   r_long_desc               gorcmsp.gorcmsp_long_desc%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type


cm_source_priority_ref

TYPE cm_source_priority_ref IS REF CURSOR RETURN cm_source_priority_rec;

Entity cursor variable type


cm_source_priority_tab

TYPE cm_source_priority_tab IS TABLE OF cm_source_priority_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   gorcmsp.gorcmsp_cmsc_code%TYPE,
                  p_priority_no gorcmsp.gorcmsp_priority_no%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 source code to be processed.

Returns
Y if found, otherwise N


f_isequal

FUNCTION f_isequal(rec_one cm_source_priority_rec,
                   rec_two cm_source_priority_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_source_priority_rec.
rec_two   The second record to compare. Defined as type cm_source_priority_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   gorcmsp.gorcmsp_cmsc_code%TYPE,
                     p_priority_no gorcmsp.gorcmsp_priority_no%TYPE)
  RETURN cm_source_priority_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 source code to be processed.

Returns
A cursor variable that will fetch the set of records


f_query_all_by_cmsc

FUNCTION f_query_all_by_cmsc(p_cmsc_code gorcmsp.gorcmsp_cmsc_code%TYPE)
  RETURN cm_source_priority_ref

Selects all records for the entity.
This query uses only CMSC_CODE to locate a record.

Parameters
p_cmsc_code   Common Matching Source Code associated with rules.

Returns
A cursor variable that will fetch the set of records


f_query_one

FUNCTION f_query_one(p_cmsc_code   gorcmsp.gorcmsp_cmsc_code%TYPE,
                     p_priority_no gorcmsp.gorcmsp_priority_no%TYPE)
  RETURN cm_source_priority_ref

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

Parameters
p_cmsc_code   Common Matching Source Code associated with rules.
p_priority_no   Priority number of source code to be processed.

Returns
A cursor variable that will fetch exactly one record


f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid VARCHAR2) RETURN cm_source_priority_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_query_one_lock

FUNCTION f_query_one_lock(p_cmsc_code   gorcmsp.gorcmsp_cmsc_code%TYPE,
                          p_priority_no gorcmsp.gorcmsp_priority_no%TYPE,
                          p_rowid       VARCHAR2 DEFAULT NULL)
  RETURN cm_source_priority_ref

Selects one record and locks it.

Parameters
p_cmsc_code   Common Matching Source Code associated with rules.
p_priority_no   Priority number of source code to be processed.
p_rowid   Database ROWID of record to select

Returns
A cursor variable for one record, locking the record


p_create

PROCEDURE p_create(p_cmsc_code   gorcmsp.gorcmsp_cmsc_code%TYPE,
                   p_priority_no gorcmsp.gorcmsp_priority_no%TYPE,
                   p_desc        gorcmsp.gorcmsp_desc%TYPE,
                   p_user_id     gorcmsp.gorcmsp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorcmsp.gorcmsp_data_origin%TYPE DEFAULT NULL,
                   p_long_desc   gorcmsp.gorcmsp_long_desc%TYPE DEFAULT NULL,
                   p_rowid_out   OUT VARCHAR2)

Creates a record Create a priority number and description for each ruled to be defined for the Common Matching Source Code.

Parameters
p_cmsc_code   Common Matching Source Code associated with rules. required key, VARCHAR2(20) must exist as valid row on GTVCMSC table.
p_priority_no   Priority number of source code to be processed. required  unique two-digit number.
p_desc   Priority number description. required VARCHAR2(60)
p_user_id   Oracle user ID of the User who created or last updated the record. required  VARCHAR2(30)
p_data_origin   Application source for this database row. optional  VARCHAR2(30)
p_rowid_out   Database ROWID of record created


p_delete

PROCEDURE p_delete(p_cmsc_code   gorcmsp.gorcmsp_cmsc_code%TYPE,
                   p_priority_no gorcmsp.gorcmsp_priority_no%TYPE,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Deletes a record
 
The priority number for the Common Matching Source Code may not be deleted if rules exist for the Common Matching Source Code and priority number in the Common Matching Rules table (GORCMSR).
If no rules exist, the priority number may be removed for the Common Matching Source Code.

Parameters
p_cmsc_code   Common Matching Source Code associated with rules.
p_priority_no   Priority number of source code to be processed.
p_rowid   Database ROWID of record to delete


p_lock

PROCEDURE p_lock(p_cmsc_code   gorcmsp.gorcmsp_cmsc_code%TYPE,
                 p_priority_no gorcmsp.gorcmsp_priority_no%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 source code to be processed.
p_rowid_inout   Database ROWID of record to lock


p_update

PROCEDURE p_update(p_cmsc_code   gorcmsp.gorcmsp_cmsc_code%TYPE,
                   p_priority_no gorcmsp.gorcmsp_priority_no%TYPE,
                   p_desc        gorcmsp.gorcmsp_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     gorcmsp.gorcmsp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorcmsp.gorcmsp_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_long_desc   gorcmsp.gorcmsp_long_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Updates a record
 
Updates the Priority number and/or the description for the Common Matching Source Code.

Parameters
p_cmsc_code   Common Matching Source Code associated with rules. required key, VARCHAR2(20) must exist as valid row on GTVCMSC table.
p_priority_no   Priority number of source code to be processed. required  unique two-digit number  .
p_desc   Priority number description. required VARCHAR2(60)
p_user_id   Oracle user ID of the User who created or last updated the record. required  VARCHAR2(30)
p_data_origin   Application source for this database row. optional  VARCHAR2(30)
p_rowid   Database ROWID of record to update optional  VARCHAR2(18)