Package gb_name

Package gb_name_translate

This package provides the Common Business interface for NAME_TRANSLATE.

Used to translate aliases or nicknames to given names (first name and/or middle names).

Since records cannot be changed, the p_update procedure has been removed.

Program units

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

Types

name_translate_rec
name_translate_ref	Entity cursor variable type
name_translate_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity name

M_ENTITY_NAME

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

Business Entity name

name_translate_rec

TYPE name_translate_rec IS RECORD (
   r_name                    gorname.gorname_name%TYPE,
   r_alias                   gorname.gorname_alias%TYPE,
   r_user_id                 gorname.gorname_user_id%TYPE,
   r_data_origin             gorname.gorname_data_origin%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

name_translate_ref

TYPE name_translate_ref IS REF CURSOR RETURN name_translate_rec;

Entity cursor variable type

name_translate_tab

TYPE name_translate_tab IS TABLE OF name_translate_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_name  gorname.gorname_name%TYPE,
                  p_alias gorname.gorname_alias%TYPE,
                  p_rowid VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_name	Given first name/middle name of person. VARCHAR2(15) Required Key
	p_alias	Alias or nickname associated with name. VARCHAR2(15) Required Key
	p_rowid	Database rowid of record to select. VARCHAR(18)

Returns

Y if found, otherwise N.

f_isequal

FUNCTION f_isequal(rec_one name_translate_rec,
                   rec_two name_translate_rec) RETURN VARCHAR2

Compare 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 name_translate_rec Required
	rec_two	The second record to compare. Type name_translate_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_name  gorname.gorname_name%TYPE,
                     p_alias gorname.gorname_alias%TYPE)
  RETURN name_translate_ref

Selects all records for the entity.

Parameters

	p_name	Given first name/middle name of person. VARCHAR2(15) Required Key
	p_alias	Alias or nickname associated with name. VARCHAR2(15) Required Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_name  gorname.gorname_name%TYPE,
                     p_alias gorname.gorname_alias%TYPE)
  RETURN name_translate_ref

Selects one record using key.

Parameters

	p_name	Given first name/middle name of person. VARCHAR2(15) Required Key
	p_alias	Alias or nickname associated with name. VARCHAR2(15) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid VARCHAR2) RETURN name_translate_ref

Selects one record using rowid.

Parameters

p_rowid

Database rowid of record to select. VARCHAR(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

FUNCTION f_query_one_lock(p_name  gorname.gorname_name%TYPE,
                          p_alias gorname.gorname_alias%TYPE,
                          p_rowid VARCHAR2 DEFAULT NULL)
  RETURN name_translate_ref

Selects one record and locks it.

Parameters

	p_name	Given first name/middle name of person. VARCHAR2(15) Required Key
	p_alias	Alias or nickname associated with name. VARCHAR2(15) Required Key
	p_rowid	Database rowid of record to select. VARCHAR(18)

Returns

A cursor variable for one record, locking the record.

p_create

PROCEDURE p_create(p_name        gorname.gorname_name%TYPE,
                   p_alias       gorname.gorname_alias%TYPE,
                   p_user_id     gorname.gorname_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorname.gorname_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT VARCHAR2)

Creates a record.

Parameters

	p_name	Given first name/middle name of person. VARCHAR2(15) Required Key
	p_alias	Alias or nickname associated with name. VARCHAR2(15) Required Key
	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 data. VARCHAR2(30)
	p_rowid_out	Database rowid of record created. VARCHAR(18) Required

p_delete

PROCEDURE p_delete(p_name  gorname.gorname_name%TYPE,
                   p_alias gorname.gorname_alias%TYPE,
                   p_rowid VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_name	Given first name/middle name of person. VARCHAR2(15) Required Key
	p_alias	Alias or nickname associated with name. VARCHAR2(15) Required Key
	p_rowid	Database rowid of record to delete. VARCHAR(18)

p_lock

PROCEDURE p_lock(p_name        gorname.gorname_name%TYPE,
                 p_alias       gorname.gorname_alias%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_name	Given first name/middle name of person. VARCHAR2(15) Required Key
	p_alias	Alias or nickname associated with name. VARCHAR2(15) Required Key
	p_rowid_inout	Database rowid of record to lock. VARCHAR(18) Required