index

Package gb_busprofpii

This package provides the Common Business interface for Business Profile PII Assignments.


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.
p_update   Updates a record.

Types
busprofpii_rec  
busprofpii_ref   Entity cursor variable type
busprofpii_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity name


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(10) := 'BUSPROFPII';

Business Entity name


busprofpii_rec

TYPE busprofpii_rec IS RECORD (
   r_fbpr_code               gorfbpi.gorfbpi_fbpr_code%TYPE,
   r_fdmn_code               gorfbpi.gorfbpi_fdmn_code%TYPE,
   r_user_id                 gorfbpi.gorfbpi_user_id%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

busprofpii_ref

TYPE busprofpii_ref IS REF CURSOR RETURN busprofpii_rec;

Entity cursor variable type


busprofpii_tab

TYPE busprofpii_tab IS TABLE OF busprofpii_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_fbpr_code gorfbpi.gorfbpi_fbpr_code%TYPE,
                  p_fdmn_code gorfbpi.gorfbpi_fdmn_code%TYPE,
                  p_rowid     VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) 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 busprofpii_rec,
                   rec_two busprofpii_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.
* @param rec_one The first record to compare. Type busprofpii_rec Required
* @param rec_two The second record to compare. Type busprofpii_rec Required
* @return Y if all values in records are equal, otherwise N. Nulls match Nulls.


f_query_all

FUNCTION f_query_all(p_fbpr_code gorfbpi.gorfbpi_fbpr_code%TYPE,
                     p_fdmn_code gorfbpi.gorfbpi_fdmn_code%TYPE)
  RETURN busprofpii_ref

Selects all records for the entity.

Parameters
p_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) Required Key

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


f_query_one

FUNCTION f_query_one(p_fbpr_code gorfbpi.gorfbpi_fbpr_code%TYPE,
                     p_fdmn_code gorfbpi.gorfbpi_fdmn_code%TYPE)
  RETURN busprofpii_ref

Selects one record using key.

Parameters
p_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) 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 busprofpii_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_fbpr_code gorfbpi.gorfbpi_fbpr_code%TYPE,
                          p_fdmn_code gorfbpi.gorfbpi_fdmn_code%TYPE,
                          p_rowid     VARCHAR2 DEFAULT NULL)
  RETURN busprofpii_ref

Selects one record and locks it.

Parameters
p_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) 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_fbpr_code gorfbpi.gorfbpi_fbpr_code%TYPE,
                   p_fdmn_code gorfbpi.gorfbpi_fdmn_code%TYPE,
                   p_user_id   gorfbpi.gorfbpi_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out OUT VARCHAR2)

Creates a record.

Parameters
p_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) Required Key
p_user_id   The most recent user to create or update a record. VARCHAR2(30) Required
p_rowid_out   Database rowid of record created. VARCHAR(18) Required


p_delete

PROCEDURE p_delete(p_fbpr_code gorfbpi.gorfbpi_fbpr_code%TYPE,
                   p_fdmn_code gorfbpi.gorfbpi_fdmn_code%TYPE,
                   p_rowid     VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters
p_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) Required Key
p_rowid   Database rowid of record to delete. VARCHAR(18)


p_lock

PROCEDURE p_lock(p_fbpr_code   gorfbpi.gorfbpi_fbpr_code%TYPE,
                 p_fdmn_code   gorfbpi.gorfbpi_fdmn_code%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_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) Required Key
p_rowid_inout   Database rowid of record to lock. VARCHAR(18) Required


p_update

PROCEDURE p_update(p_fbpr_code gorfbpi.gorfbpi_fbpr_code%TYPE,
                   p_fdmn_code gorfbpi.gorfbpi_fdmn_code%TYPE,
                   p_user_id   gorfbpi.gorfbpi_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid     VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters
p_fbpr_code   FGAC business profile code. VARCHAR2(30) Required Key
p_fdmn_code   PII domain the business profile is assigned. VARCHAR2(30) Required Key
p_user_id   The most recent user to create or update a record. VARCHAR2(30) Required
p_rowid   Database rowid of record to update. VARCHAR(18)