Package gb_integ

Package gb_integ_config

Common Business interface for the INTEG_CONFIG API (gb_integ_config).

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_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

integ_config_rec	Business Entity record type
integ_config_ref	Entity cursor variable type
integ_config_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(12) := 'INTEG_CONFIG';

Business Entity Name

m_base_table_name

m_base_table_name CONSTANT VARCHAR2(7) := 'GORICCR';

Base table name

integ_config_rec

TYPE integ_config_rec IS RECORD(
  r_sqpr_code          goriccr.goriccr_sqpr_code%TYPE,
  r_icsn_code          goriccr.goriccr_icsn_code%TYPE,
  r_value              goriccr.goriccr_value%TYPE,
  r_user_id            goriccr.goriccr_user_id%TYPE,
  r_value_desc         goriccr.goriccr_value_desc%TYPE,
  r_seq_no             goriccr.goriccr_seq_no%TYPE,
  r_translation_value  goriccr.goriccr_translation_value%TYPE,
  r_data_origin        goriccr.goriccr_data_origin%TYPE,
  r_internal_record_id gb_common.internal_record_id_type);

Business Entity record type

integ_config_ref

TYPE integ_config_ref IS REF CURSOR RETURN integ_config_rec;

Entity cursor variable type

integ_config_tab

TYPE integ_config_tab IS TABLE OF integ_config_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_sqpr_code goriccr.goriccr_sqpr_code%TYPE,
                  p_icsn_code goriccr.goriccr_icsn_code%TYPE,
                  p_value     goriccr.goriccr_value%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. 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 integ_config_rec,
                   rec_two integ_config_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 integ_config_rec Required
	rec_two	The second record to compare. Type integ_config_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_sqpr_code goriccr.goriccr_sqpr_code%TYPE,
                     p_icsn_code goriccr.goriccr_icsn_code%TYPE)
  RETURN integ_config_ref

Selects all records for the entity.

Parameters

	p_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. VARCHAR2(200) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_sqpr_code goriccr.goriccr_sqpr_code%TYPE,
                     p_icsn_code goriccr.goriccr_icsn_code%TYPE,
                     p_value     goriccr.goriccr_value%TYPE)
  RETURN integ_config_ref

Selects one record using key.

Parameters

	p_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. 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 integ_config_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_one_lock

FUNCTION f_query_one_lock(p_sqpr_code goriccr.goriccr_sqpr_code%TYPE,
                          p_icsn_code goriccr.goriccr_icsn_code%TYPE,
                          p_value     goriccr.goriccr_value%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN integ_config_ref

Selects one record and locks it.

Parameters

	p_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. 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_sqpr_code         goriccr.goriccr_sqpr_code%TYPE,
                   p_icsn_code         goriccr.goriccr_icsn_code%TYPE,
                   p_value             goriccr.goriccr_value%TYPE,
                   p_user_id           goriccr.goriccr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_value_desc        goriccr.goriccr_value_desc%TYPE DEFAULT NULL,
                   p_seq_no            goriccr.goriccr_seq_no%TYPE DEFAULT NULL,
                   p_translation_value goriccr.goriccr_translation_value%TYPE DEFAULT NULL,
                   p_data_origin       goriccr.goriccr_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out         OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. VARCHAR2(200) Required Key
	p_user_id	The unique identification of the user. VARCHAR2(30) Required
	p_value_desc	Description of the value entered for the given setting. VARCHAR2(60)
	p_seq_no	Ordinal number used when order of configuration settings is important. NUMBER(2)
	p_translation_value	A value that is the technical equivalent of the value in the VALUE field. VARCHAR2(200)
	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_sqpr_code goriccr.goriccr_sqpr_code%TYPE,
                   p_icsn_code goriccr.goriccr_icsn_code%TYPE,
                   p_value     goriccr.goriccr_value%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. VARCHAR2(200) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_sqpr_code   goriccr.goriccr_sqpr_code%TYPE,
                 p_icsn_code   goriccr.goriccr_icsn_code%TYPE,
                 p_value       goriccr.goriccr_value%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_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. VARCHAR2(200) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_sqpr_code         goriccr.goriccr_sqpr_code%TYPE,
                   p_icsn_code         goriccr.goriccr_icsn_code%TYPE,
                   p_value             goriccr.goriccr_value%TYPE,
                   p_user_id           goriccr.goriccr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_value_desc        goriccr.goriccr_value_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_seq_no            goriccr.goriccr_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_translation_value goriccr.goriccr_translation_value%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin       goriccr.goriccr_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid             gb_common.internal_record_id_type)

Updates a record.

Parameters

	p_sqpr_code	The integration configuration setting process code. VARCHAR2(30) Required Key
	p_icsn_code	The integration configuration setting name. VARCHAR2(30) Required Key
	p_value	Value of configuration setting. VARCHAR2(200) Required Key
	p_user_id	The unique identification of the user. VARCHAR2(30) Required
	p_value_desc	Description of the value entered for the given setting. VARCHAR2(60)
	p_seq_no	Ordinal number used when order of configuration settings is important. NUMBER(2)
	p_translation_value	A value that is the technical equivalent of the value in the VALUE field. VARCHAR2(200)
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. The ROWID is required because changes to elements of the unique key are allowed. VARCHAR2(18) Required Key