index

Package gb_np_name_trans

This package provides the Common Business interface for NP_NAME_TRANS.
 
Used to translate aliases to non-person names.  For example, equate International Business Machines to IBM.
 
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   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.

Types
np_name_trans_rec   Entity record type
np_name_trans_ref   Entity cursor variable type
np_name_trans_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity name

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(13) := 'NP_NAME_TRANS';

Business Entity name

np_name_trans_rec 

TYPE np_name_trans_rec IS RECORD (
   r_name                    gornpnm.gornpnm_name%TYPE,
   r_alias                   gornpnm.gornpnm_alias%TYPE,
   r_user_id                 gornpnm.gornpnm_user_id%TYPE,
   r_data_origin             gornpnm.gornpnm_data_origin%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

np_name_trans_ref 

TYPE np_name_trans_ref IS REF CURSOR RETURN np_name_trans_rec;

Entity cursor variable type

np_name_trans_tab 

TYPE np_name_trans_tab IS TABLE OF np_name_trans_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  gornpnm.gornpnm_name%TYPE,
                  p_alias gornpnm.gornpnm_alias%TYPE,
                  p_rowid VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_name   Given name of non-person. VARCHAR2(60) Required Key
p_alias   Alias or nickname associated with name. VARCHAR2(60) 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 np_name_trans_rec,
                   rec_two np_name_trans_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 np_name_trans_rec Required
rec_two   The second record to compare. Type np_name_trans_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  gornpnm.gornpnm_name%TYPE,
                     p_alias gornpnm.gornpnm_alias%TYPE)
  RETURN np_name_trans_ref

Selects all records for the entity.

Parameters
p_name   Given name of non-person. VARCHAR2(60) Required Key
p_alias   Alias or nickname associated with name. VARCHAR2(60) Required Key

Returns
A cursor variable that will fetch the set of records.

f_query_one 

FUNCTION f_query_one(p_name  gornpnm.gornpnm_name%TYPE,
                     p_alias gornpnm.gornpnm_alias%TYPE)
  RETURN np_name_trans_ref

Selects one record using key.

Parameters
p_name   Given name of non-person. VARCHAR2(60) Required Key
p_alias   Alias or nickname associated with name. VARCHAR2(60) 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 np_name_trans_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  gornpnm.gornpnm_name%TYPE,
                          p_alias gornpnm.gornpnm_alias%TYPE,
                          p_rowid VARCHAR2 DEFAULT NULL)
  RETURN np_name_trans_ref

Selects one record and locks it.

Parameters
p_name   Given name of non-person. VARCHAR2(60) Required Key
p_alias   Alias or nickname associated with name. VARCHAR2(60) 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        gornpnm.gornpnm_name%TYPE,
                   p_alias       gornpnm.gornpnm_alias%TYPE,
                   p_user_id     gornpnm.gornpnm_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gornpnm.gornpnm_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT VARCHAR2)

Creates a record.

Parameters
p_name   Given name of non-person. VARCHAR2(60) Required Key
p_alias   Alias or nickname associated with name. VARCHAR2(60) Required Key
p_user_id   Oracle 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  gornpnm.gornpnm_name%TYPE,
                   p_alias gornpnm.gornpnm_alias%TYPE,
                   p_rowid VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters
p_name   Given name of non-person. VARCHAR2(60) Required Key
p_alias   Alias or nickname associated with name. VARCHAR2(60) Required Key
p_rowid   Database ROWID of record to delete. VARCHAR(18)

p_lock 

PROCEDURE p_lock(p_name        gornpnm.gornpnm_name%TYPE,
                 p_alias       gornpnm.gornpnm_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 name of non-person. VARCHAR2(60) Required Key
p_alias   Alias or nickname associated with name. VARCHAR2(60) Required Key
p_rowid_inout   Database ROWID of record to lock. VARCHAR(18) Required