Package gb_goradid

Common Business interface for the GORADID API (gb_goradid).

Program units

f_api_version	Returns the API version number.
f_exists	Checks 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 the key.
f_query_by_rowid	Selects one record using the 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

goradid_rec	Business Entity record type
goradid_ref	Entity cursor variable type
goradid_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(7) := 'GORADID';

Business Entity Name

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'GORADID';

Base table name

goradid_rec

TYPE goradid_rec IS RECORD (
  r_pidm                    goradid.goradid_pidm%TYPE,
  r_additional_id           goradid.goradid_additional_id%TYPE,
  r_adid_code               goradid.goradid_adid_code%TYPE,
  r_user_id                 goradid.goradid_user_id%TYPE,
  r_data_origin             goradid.goradid_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

goradid_ref

TYPE goradid_ref IS REF CURSOR RETURN goradid_rec;

Entity cursor variable type

goradid_tab

TYPE goradid_tab IS TABLE OF goradid_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_pidm          goradid.goradid_pidm%TYPE,
                  p_additional_id goradid.goradid_additional_id%TYPE,
                  p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_isequal

FUNCTION f_isequal(rec_one goradid_rec,
                   rec_two goradid_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 goradid_rec Required
	rec_two	The second record to compare. Type goradid_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_pidm          goradid.goradid_pidm%TYPE,
                     p_additional_id goradid.goradid_additional_id%TYPE)
  RETURN goradid_ref

Selects all records for the entity.

Parameters

	p_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm          goradid.goradid_pidm%TYPE,
                     p_additional_id goradid.goradid_additional_id%TYPE)
  RETURN goradid_ref

Selects one record using the key.

Parameters

	p_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN goradid_ref

Selects one record using the ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

FUNCTION f_query_one_lock(p_pidm          goradid.goradid_pidm%TYPE,
                          p_additional_id goradid.goradid_additional_id%TYPE,
                          p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN goradid_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

p_create

PROCEDURE p_create(p_pidm          goradid.goradid_pidm%TYPE,
                   p_additional_id goradid.goradid_additional_id%TYPE,
                   p_adid_code     goradid.goradid_adid_code%TYPE,
                   p_user_id       goradid.goradid_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin   goradid.goradid_data_origin%TYPE,
                   p_rowid_out     OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key
	p_adid_code	Additional Identification Type Code. VARCHAR2(16) Required
	p_user_id	User ID of the user who created or last updated the record. VARCHAR2(120) Required
	p_data_origin	Source system that created or updated the row. VARCHAR2(120) Required
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm          goradid.goradid_pidm%TYPE,
                   p_additional_id goradid.goradid_additional_id%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_pidm          goradid.goradid_pidm%TYPE,
                 p_additional_id goradid.goradid_additional_id%TYPE,
                 p_rowid_inout   IN OUT NOCOPY gb_common.internal_record_id_type)

Locks a record.
If the 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_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_pidm          goradid.goradid_pidm%TYPE,
                   p_additional_id goradid.goradid_additional_id%TYPE,
                   p_adid_code     goradid.goradid_adid_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id       goradid.goradid_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin   goradid.goradid_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_pidm	Internal identification number of the Validation Type. NUMBER(8) Required Key
	p_additional_id	Additional Identification Code. VARCHAR2(200) Required Key
	p_adid_code	Additional Identification Type Code. VARCHAR2(16) Required
	p_user_id	User ID of the user who created or last updated the record. VARCHAR2(120) Required
	p_data_origin	Source system that created or updated the row. VARCHAR2(120) Required
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)