Package gb_pin

Package gb_pin_answer

Common Business interface for the PIN_ANSWER API (gb_pin_answer).

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.
f_validate_answer	@param p_pidm NUMBER(,) Required Key

Types

pin_answer_rec	Business Entity record type
pin_answer_ref	Entity cursor variable type
pin_answer_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(10) := 'PIN_ANSWER';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

pin_answer_rec

TYPE pin_answer_rec IS RECORD (
  r_pidm                    gobansr.gobansr_pidm%TYPE,
  r_num                     gobansr.gobansr_num%TYPE,
  r_gobqstn_id              gobansr.gobansr_gobqstn_id%TYPE,
  r_qstn_desc               gobansr.gobansr_qstn_desc%TYPE,
  r_ansr_desc               gobansr.gobansr_ansr_desc%TYPE,
  r_ansr_salt               gobansr.gobansr_ansr_salt%TYPE,
  r_user_id                 gobansr.gobansr_user_id%TYPE,
  r_data_origin             gobansr.gobansr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

pin_answer_ref

TYPE pin_answer_ref IS REF CURSOR RETURN pin_answer_rec;

Entity cursor variable type

pin_answer_tab

TYPE pin_answer_tab IS TABLE OF pin_answer_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  gobansr.gobansr_pidm%TYPE,
                  p_num   gobansr.gobansr_num%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) 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_answer_rec,
                   rec_two pin_answer_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_answer_rec Required
	rec_two	The second record to compare. Type pin_answer_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 gobansr.gobansr_pidm%TYPE,
                     p_num  gobansr.gobansr_num%TYPE) RETURN pin_answer_ref

Selects all records for the entity.

Parameters

	p_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm gobansr.gobansr_pidm%TYPE,
                     p_num  gobansr.gobansr_num%TYPE) RETURN pin_answer_ref

Selects one record using key.

Parameters

	p_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) 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_answer_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_pidm  gobansr.gobansr_pidm%TYPE,
                          p_num   gobansr.gobansr_num%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN pin_answer_ref

Selects one record and locks it.

Parameters

	p_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) 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        gobansr.gobansr_pidm%TYPE,
                   p_num         gobansr.gobansr_num%TYPE,
                   p_gobqstn_id  gobansr.gobansr_gobqstn_id%TYPE DEFAULT NULL,
                   p_qstn_desc   gobansr.gobansr_qstn_desc%TYPE DEFAULT NULL,
                   p_ansr_desc   gobansr.gobansr_ansr_desc%TYPE,
                   p_ansr_salt   gobansr.gobansr_ansr_salt%TYPE,
                   p_user_id     gobansr.gobansr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gobansr.gobansr_data_origin%TYPE,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) Required Key
	p_gobqstn_id	VARCHAR2(6)
	p_qstn_desc	VARCHAR2(255)
	p_ansr_desc	VARCHAR2(255) Required
	p_ansr_salt	VARCHAR2(255) Required
	p_user_id	VARCHAR2(30) Required
	p_data_origin	VARCHAR2(30) Required
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm  gobansr.gobansr_pidm%TYPE,
                   p_num   gobansr.gobansr_num%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_pidm        gobansr.gobansr_pidm%TYPE,
                 p_num         gobansr.gobansr_num%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_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_pidm        gobansr.gobansr_pidm%TYPE,
                   p_num         gobansr.gobansr_num%TYPE,
                   p_gobqstn_id  gobansr.gobansr_gobqstn_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_qstn_desc   gobansr.gobansr_qstn_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ansr_desc   gobansr.gobansr_ansr_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ansr_salt   gobansr.gobansr_ansr_salt%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     gobansr.gobansr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin gobansr.gobansr_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	NUMBER(,) Required Key
	p_num	NUMBER(,) Required Key
	p_gobqstn_id	VARCHAR2(6)
	p_qstn_desc	VARCHAR2(255)
	p_ansr_desc	VARCHAR2(255) Required
	p_ansr_salt	VARCHAR2(255) Required
	p_user_id	VARCHAR2(30) Required
	p_data_origin	VARCHAR2(30) Required
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)

f_validate_answer

FUNCTION f_validate_answer(p_pidm   gobansr.gobansr_pidm%TYPE,
                           p_num    gobansr.gobansr_num%TYPE,
                           p_answer gobansr.gobansr_ansr_desc%TYPE)
  RETURN BOOLEAN

Parameters

	p_pidm	NUMBER(,) Required Key
	p_num	NUMBER(,) Required Key