Package gb_streams

Package gb_streams_columns

Common Business interface for the STREAMS_COLUMNS API (gb_streams_columns).

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

streams_columns_rec	Business Entity record type
streams_columns_ref	Entity cursor variable type
streams_columns_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(15) := 'STREAMS_COLUMNS';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

streams_columns_rec

TYPE streams_columns_rec IS RECORD (
  r_ctab_seq_no             gorccol.gorccol_ctab_seq_no%TYPE,
  r_column_name             gorccol.gorccol_column_name%TYPE,
  r_user_id                 gorccol.gorccol_user_id%TYPE,
  r_data_origin             gorccol.gorccol_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

streams_columns_ref

TYPE streams_columns_ref IS REF CURSOR RETURN streams_columns_rec;

Entity cursor variable type

streams_columns_tab

TYPE streams_columns_tab IS TABLE OF streams_columns_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_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                  p_column_name gorccol.gorccol_column_name%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. VARCHAR2(30) 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 streams_columns_rec,
                   rec_two streams_columns_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 streams_columns_rec Required
	rec_two	The second record to compare. Type streams_columns_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                     p_column_name gorccol.gorccol_column_name%TYPE)
  RETURN streams_columns_ref

Selects all records for the entity.

Parameters

	p_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. VARCHAR2(30) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                     p_column_name gorccol.gorccol_column_name%TYPE)
  RETURN streams_columns_ref

Selects one record using key.

Parameters

	p_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. 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 gb_common.internal_record_id_type)
  RETURN streams_columns_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_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                          p_column_name gorccol.gorccol_column_name%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN streams_columns_ref

Selects one record and locks it.

Parameters

	p_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. VARCHAR2(30) 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_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                   p_column_name gorccol.gorccol_column_name%TYPE,
                   p_user_id     gorccol.gorccol_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorccol.gorccol_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. VARCHAR2(30) Required Key
	p_user_id	User ID of the user who created or last updated the row. 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_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                   p_column_name gorccol.gorccol_column_name%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. VARCHAR2(30) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                 p_column_name gorccol.gorccol_column_name%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_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. VARCHAR2(30) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_ctab_seq_no gorccol.gorccol_ctab_seq_no%TYPE,
                   p_column_name gorccol.gorccol_column_name%TYPE,
                   p_user_id     gorccol.gorccol_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gorccol.gorccol_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_ctab_seq_no	References GORCTAB_SEQ_NO in GORCTAB. Repeats itself for every row in GORCTAB. NUMBER(,) Required Key
	p_column_name	Column name of a table that is monitored. VARCHAR2(30) Required Key
	p_user_id	User ID of the user who created or last updated the row. 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)