Package gb_cm_display

Package gb_cm_display_options

This package provides the Common Business interface for Common Matching Display Options.

The objects that can be displayed and accessed for additional information on records returned as potential matches by the Common Matching process may be associated to the Common Matching Source code.
The objects selected must be also be defined as FORMS in the Object table, GUBOBJS.
Each object must be provided a sequence number to determine how the list of available objects will be displayed.

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists using CMSC code and object name.
f_exists	Checks to see if a record exists using CMSC code and sequence number.
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_display_options_rec	Entity record type
cm_display_options_ref	Entity cursor variable type
cm_display_options_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity name

M_ENTITY_NAME

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

Business Entity name

cm_display_options_rec

TYPE cm_display_options_rec IS RECORD (
   r_cmsc_code               gorcmdo.gorcmdo_cmsc_code%TYPE,
   r_objs_name               gorcmdo.gorcmdo_objs_name%TYPE,
   r_seq_no                  gorcmdo.gorcmdo_seq_no%TYPE,
   r_user_id                 gorcmdo.gorcmdo_user_id%TYPE,
   r_data_origin             gorcmdo.gorcmdo_data_origin%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

cm_display_options_ref

TYPE cm_display_options_ref IS REF CURSOR RETURN cm_display_options_rec;

Entity cursor variable type

cm_display_options_tab

TYPE cm_display_options_tab IS TABLE OF cm_display_options_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 gorcmdo.gorcmdo_cmsc_code%TYPE,
                  p_objs_name gorcmdo.gorcmdo_objs_name%TYPE)
  RETURN VARCHAR2

Checks to see if a record exists using CMSC code and object name.

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.

Returns

Y if found, otherwise N

f_exists

FUNCTION f_exists(p_cmsc_code gorcmdo.gorcmdo_cmsc_code%TYPE,
                  p_seq       gorcmdo.gorcmdo_seq_no%TYPE) RETURN VARCHAR2

Checks to see if a record exists using CMSC code and sequence number.

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.

Returns

Y if found, otherwise N

f_isequal

FUNCTION f_isequal(rec_one cm_display_options_rec,
                   rec_two cm_display_options_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_display_options_rec.
	rec_two	The second record to compare. Defined as type cm_display_options_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 gorcmdo.gorcmdo_cmsc_code%TYPE,
                     p_objs_name gorcmdo.gorcmdo_objs_name%TYPE DEFAULT NULL)
  RETURN cm_display_options_ref

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

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.

Returns

A cursor variable that will fetch the set of records

f_query_one

FUNCTION f_query_one(p_cmsc_code gorcmdo.gorcmdo_cmsc_code%TYPE,
                     p_objs_name gorcmdo.gorcmdo_objs_name%TYPE)
  RETURN cm_display_options_ref

Selects one record using key.
Always returns the current record for the source code, object name.

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.

Returns

A cursor variable that will fetch exactly one record

f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid VARCHAR2) RETURN cm_display_options_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 gorcmdo.gorcmdo_cmsc_code%TYPE,
                          p_objs_name gorcmdo.gorcmdo_objs_name%TYPE,
                          p_rowid     VARCHAR2 DEFAULT NULL)
  RETURN cm_display_options_ref

Selects one record and locks it.

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.
	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   gorcmdo.gorcmdo_cmsc_code%TYPE,
                   p_objs_name   gorcmdo.gorcmdo_objs_name%TYPE,
                   p_seq_no      gorcmdo.gorcmdo_seq_no%TYPE,
                   p_user_id     gorcmdo.gorcmdo_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorcmdo.gorcmdo_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT VARCHAR2)

Creates a record.

Associate the form to be called and display as an option from the Match Entry Process window for the Common Matching Source Code. The form to be called must exist in the Object table (GUBOBJS) and must be defined as a Form. The order to display the forms is assigned a unique sequence number.

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.
	p_seq_no	The order in which to display the form names.
	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 gorcmdo.gorcmdo_cmsc_code%TYPE,
                   p_objs_name gorcmdo.gorcmdo_objs_name%TYPE,
                   p_rowid     VARCHAR2 DEFAULT NULL)

Deletes a record.

Removes the associated SCT Banner Form for the Common Matching Source Code to be called and displayed as an option from the Match Entry Process window.

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.
	p_rowid	Database ROWID of record to delete

p_lock

PROCEDURE p_lock(p_cmsc_code   gorcmdo.gorcmdo_cmsc_code%TYPE,
                 p_objs_name   gorcmdo.gorcmdo_objs_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	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.
	p_rowid_inout	Database ROWID of record to lock

p_update

PROCEDURE p_update(p_cmsc_code   gorcmdo.gorcmdo_cmsc_code%TYPE,
                   p_objs_name   gorcmdo.gorcmdo_objs_name%TYPE,
                   p_seq_no      gorcmdo.gorcmdo_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id     gorcmdo.gorcmdo_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorcmdo.gorcmdo_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Updates a record.

Updates the object to be called and displayed as an option from the Match Entry process window and/or the order to display as an option.

Parameters

	p_cmsc_code	The Common Matching Source Code to associate the forms to be called on the Match Entry Process.
	p_objs_name	The SCT Banner Form to be displayed and called based on the Common Matching Source Code in the key block of the Match Entry Process Form.
	p_seq_no	The order in which to display the form names.
	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