Package gb_gobumap

Common Business interface for the GOBUMAP API (gb_gobumap).

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 key.
f_query_by_rowid	Selects one record using ROWID.
f_query_by_pidm	Selects one record using key.
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

gobumap_rec	Business Entity record type
gobumap_ref	Entity cursor variable type
gobumap_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) := 'GOBUMAP';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

gobumap_rec

TYPE gobumap_rec IS RECORD (
  r_udc_id                  gobumap.gobumap_udc_id%TYPE,
  r_pidm                    gobumap.gobumap_pidm%TYPE,
  r_create_date             gobumap.gobumap_create_date%TYPE,
  r_user_id                 gobumap.gobumap_user_id%TYPE,
  r_data_origin             gobumap.gobumap_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gobumap_ref

TYPE gobumap_ref IS REF CURSOR RETURN gobumap_rec;

Entity cursor variable type

gobumap_tab

TYPE gobumap_tab IS TABLE OF gobumap_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_udc_id gobumap.gobumap_udc_id%TYPE,
                  p_rowid  gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_udc_id	UDC Identifier. VARCHAR2(225) 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 gobumap_rec,
                   rec_two gobumap_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 gobumap_rec Required
	rec_two	The second record to compare. Type gobumap_rec Required

Returns

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

f_query_all

FUNCTION f_query_all RETURN gobumap_ref

Selects all records for the entity.

Parameters

p_udc_id

UDC Identifier. VARCHAR2(225) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_udc_id gobumap.gobumap_udc_id%TYPE)
  RETURN gobumap_ref

Selects one record using key.

Parameters

p_udc_id

UDC Identifier. VARCHAR2(225) 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 gobumap_ref

Selects one record using 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_by_pidm

FUNCTION f_query_by_pidm(p_pidm gobumap.gobumap_pidm%TYPE)
  RETURN gobumap_ref

Selects one record using key.

Parameters

p_pidm

PIDM.

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

FUNCTION f_query_one_lock(p_udc_id gobumap.gobumap_udc_id%TYPE,
                          p_rowid  gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gobumap_ref

Selects one record and locks it.

Parameters

	p_udc_id	UDC Identifier. VARCHAR2(225) 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_udc_id      gobumap.gobumap_udc_id%TYPE,
                   p_pidm        gobumap.gobumap_pidm%TYPE,
                   p_create_date gobumap.gobumap_create_date%TYPE,
                   p_user_id     gobumap.gobumap_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gobumap.gobumap_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_udc_id	UDC Identifier. VARCHAR2(225) Required Key
	p_pidm	Internal identification number of the person. NUMBER(8) Required
	p_create_date	Date on which the record was created. DATE Required
	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 row. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_udc_id gobumap.gobumap_udc_id%TYPE,
                   p_rowid  gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_udc_id	UDC Identifier. VARCHAR2(225) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_udc_id      gobumap.gobumap_udc_id%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

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_udc_id	UDC Identifier. VARCHAR2(225) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_udc_id      gobumap.gobumap_udc_id%TYPE,
                   p_pidm        gobumap.gobumap_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_create_date gobumap.gobumap_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_user_id     gobumap.gobumap_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gobumap.gobumap_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_udc_id	UDC Identifier. VARCHAR2(225) Required Key
	p_pidm	Internal identification number of the person. NUMBER(8) Required
	p_create_date	Date on which the record was created. DATE Required
	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 row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)