Package gb_pin

Package gb_pin_question

Common Business interface for the PIN_QUESTION API (gb_pin_question).

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

pin_question_rec	Business Entity record type
pin_question_ref	Entity cursor variable type
pin_question_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) := 'PIN_QUESTION';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

pin_question_rec

TYPE pin_question_rec IS RECORD (
  r_id                      gobqstn.gobqstn_id%TYPE,
  r_desc                    gobqstn.gobqstn_desc%TYPE,
  r_display_ind             gobqstn.gobqstn_display_ind%TYPE,
  r_user_id                 gobqstn.gobqstn_user_id%TYPE,
  r_data_origin             gobqstn.gobqstn_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

pin_question_ref

TYPE pin_question_ref IS REF CURSOR RETURN pin_question_rec;

Entity cursor variable type

pin_question_tab

TYPE pin_question_tab IS TABLE OF pin_question_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_id    gobqstn.gobqstn_id%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_id	Unique identifier for the question. VARCHAR2(6) 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 pin_question_rec,
                   rec_two pin_question_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 pin_question_rec Required
	rec_two	The second record to compare. Type pin_question_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_id gobqstn.gobqstn_id%TYPE) RETURN pin_question_ref

Selects all records for the entity.

Parameters

p_id

Unique identifier for the question. VARCHAR2(6) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_id gobqstn.gobqstn_id%TYPE) RETURN pin_question_ref

Selects one record using key.

Parameters

p_id

Unique identifier for the question. VARCHAR2(6) 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 pin_question_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_id    gobqstn.gobqstn_id%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN pin_question_ref

Selects one record and locks it.

Parameters

	p_id	Unique identifier for the question. VARCHAR2(6) 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_id          gobqstn.gobqstn_id%TYPE,
                   p_desc        gobqstn.gobqstn_desc%TYPE,
                   p_display_ind gobqstn.gobqstn_display_ind%TYPE,
                   p_user_id     gobqstn.gobqstn_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gobqstn.gobqstn_data_origin%TYPE,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_id	Unique identifier for the question. VARCHAR2(6) Required Key
	p_desc	Descriptive questions. VARCHAR2(255) Required
	p_display_ind	Descriptive questions. VARCHAR2(1) Required
	p_user_id	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) Required
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_id    gobqstn.gobqstn_id%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_id	Unique identifier for the question. VARCHAR2(6) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_id          gobqstn.gobqstn_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_id	Unique identifier for the question. VARCHAR2(6) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_id          gobqstn.gobqstn_id%TYPE,
                   p_desc        gobqstn.gobqstn_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_display_ind gobqstn.gobqstn_display_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     gobqstn.gobqstn_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gobqstn.gobqstn_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_id	Unique identifier for the question. VARCHAR2(6) Required Key
	p_desc	Descriptive questions. VARCHAR2(255) Required
	p_display_ind	Descriptive questions. VARCHAR2(1) Required
	p_user_id	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) Required
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)