index

Package tb_depo_control

Functional support for Deposit Control (Common Business interface DEPO_CONTROL in a future release).

Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if a record exists.
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.
f_exists_data   Selects one record using the key value and returns the record.

Types
depo_control_rec   Entity record type
depo_control_ref   Entity cursor variable type
depo_control_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity name

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(12) := 'DEPO_CONTROL';

Business Entity name

depo_control_rec 

TYPE depo_control_rec IS RECORD (
   r_detail_code_deposit     tbbdepc.tbbdepc_detail_code_deposit%TYPE,
   r_detail_code_payment     tbbdepc.tbbdepc_detail_code_payment%TYPE,
   r_auto_release_ind        tbbdepc.tbbdepc_auto_release_ind%TYPE,
   r_release_date            tbbdepc.tbbdepc_release_date%TYPE,
   r_min_amount              tbbdepc.tbbdepc_min_amount%TYPE,
   r_expiration_date         tbbdepc.tbbdepc_expiration_date%TYPE,
   r_dtyp_code               tbbdepc.tbbdepc_dtyp_code%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

depo_control_ref 

TYPE depo_control_ref IS REF CURSOR RETURN depo_control_rec;

Entity cursor variable type

depo_control_tab 

TYPE depo_control_tab IS TABLE OF depo_control_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_detail_code_deposit tbbdepc.tbbdepc_detail_code_deposit%TYPE,
                  p_rowid               VARCHAR2 DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_detail_code_deposit   Detail code that has been identified as a deposit. VARCHAR2(4) Required Key
p_rowid   Database rowid of record to select. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_query_all 

Function f_query_all(p_detail_code_deposit tbbdepc.tbbdepc_detail_code_deposit%TYPE)
  RETURN depo_control_ref

Selects all records for the entity.

Parameters
p_detail_code_deposit   Detail code that has been identified as a deposit (wild card may be used). VARCHAR2(4) Required Key

Returns
A cursor variable that will fetch the set of records.

f_query_one 

Function f_query_one(p_detail_code_deposit tbbdepc.tbbdepc_detail_code_deposit%TYPE)
  RETURN depo_control_ref

Selects one record using key.

Parameters
p_detail_code_deposit   Detail code that has been identified as a deposit. VARCHAR2(4) Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_rowid 

Function f_query_by_rowid(p_rowid VARCHAR2) RETURN depo_control_ref

Selects one record using rowid.

Parameters
p_rowid   Database rowid of record to select. VARCHAR2(18) Required

Returns
A cursor variable that will fetch exactly one record.

f_query_one_lock 

Function f_query_one_lock(p_detail_code_deposit tbbdepc.tbbdepc_detail_code_deposit%TYPE,
                          p_rowid               VARCHAR2 DEFAULT NULL)
  RETURN depo_control_ref

Selects one record and locks it.

Parameters
p_detail_code_deposit   Detail code that has been identified as a deposit. VARCHAR2(4) Required Key
p_rowid   Database rowid of record to select. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.

f_exists_data 

Function f_exists_data(p_detail_code_deposit tbbdepc.tbbdepc_detail_code_deposit%TYPE,
                       p_tbbdepc_rec_out     OUT depo_control_rec)
  RETURN VARCHAR2

Selects one record using the key value and returns the record.

Parameters
p_detail_code_deposit   Detail code that has been identified as a deposit. VARCHAR2(4) Required Key
p_tbbdepc_rec_out   Returns a record of type depo_control_rec.

Returns
Y if found, otherwise N.