Package tb_detail

Package tb_detail_code

Functional support for Detail Codes (Common Business interface DETAIL_CODE in a future release).

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists.
f_exists_data	Determines if the code exists and returns the record.
f_get_dcat	Return the category for the code
f_get_description	Return description for the code
f_has_accounting	Checks to see if the detail code has accounting information.
f_isequal	Compare 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.
f_valid_to_delete	Checks many tables to see if detail code is in use, or may be deleted.

Types

detail_code_rec	Entity record type
detail_code_ref	Entity cursor variable type
detail_code_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(11) := 'DETAIL_CODE';

Business Entity name

detail_code_rec

TYPE detail_code_rec IS RECORD (
   r_detail_code             tbbdetc.tbbdetc_detail_code%TYPE,
   r_desc                    tbbdetc.tbbdetc_desc%TYPE,
   r_type_ind                tbbdetc.tbbdetc_type_ind%TYPE,
   r_priority                tbbdetc.tbbdetc_priority%TYPE,
   r_like_term_ind           tbbdetc.tbbdetc_like_term_ind%TYPE,
   r_dcat_code               tbbdetc.tbbdetc_dcat_code%TYPE,
   r_amount                  tbbdetc.tbbdetc_amount%TYPE,
   r_term_code               tbbdetc.tbbdetc_term_code%TYPE,
   r_effective_date          tbbdetc.tbbdetc_effective_date%TYPE,
   r_refundable_ind          tbbdetc.tbbdetc_refundable_ind%TYPE,
   r_receipt_ind             tbbdetc.tbbdetc_receipt_ind%TYPE,
   r_refund_ind              tbbdetc.tbbdetc_refund_ind%TYPE,
   r_payt_code               tbbdetc.tbbdetc_payt_code%TYPE,
   r_prebill_print_ind       tbbdetc.tbbdetc_prebill_print_ind%TYPE,
   r_gl_nos_enterable        tbbdetc.tbbdetc_gl_nos_enterable%TYPE,
   r_taxt_code               tbbdetc.tbbdetc_taxt_code%TYPE,
   r_tbdc_ind                tbbdetc.tbbdetc_tbdc_ind%TYPE,
   r_detail_code_ind         tbbdetc.tbbdetc_detail_code_ind%TYPE,
   r_detc_active_ind         tbbdetc.tbbdetc_detc_active_ind%TYPE,
   r_dird_ind                tbbdetc.tbbdetc_dird_ind%TYPE,
   r_tiv_ind                 tbbdetc.tbbdetc_tiv_ind%TYPE,
   r_inst_chg_ind            tbbdetc.tbbdetc_inst_chg_ind%TYPE,
   r_like_aidy_ind           tbbdetc.tbbdetc_like_aidy_ind%TYPE,
   r_payhist_ind             tbbdetc.tbbdetc_payhist_ind%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

detail_code_ref

TYPE detail_code_ref IS REF CURSOR RETURN detail_code_rec;

Entity cursor variable type

detail_code_tab

TYPE detail_code_tab IS TABLE OF detail_code_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 tbbdetc.tbbdetc_detail_code%TYPE,
                  p_rowid       VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_detail_code	Detail code associated with every charge and payment that can be entered onto an account. VARCHAR2(4) Required Key
	p_rowid	Database rowid of record to select. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_exists_data

Function f_exists_data(p_detail_code     IN tbbdetc.tbbdetc_detail_code%TYPE,
                       r_tbbdetc_rec_out OUT tbbdetc%ROWTYPE)
  RETURN VARCHAR2

Determines if the code exists and returns the record.

Parameters

	p_detail_code	Detail code associated with every charge and payment that can be entered onto an account. VARCHAR2(4) Required Key
	r_tbbdetc_rec_out	Record for the detail code.

Returns

Y if found, otherwise N.

f_get_dcat

Function f_get_dcat(p_detail_code tbbdetc.tbbdetc_detail_code%TYPE)
  RETURN VARCHAR2

Return the category for the code

Parameters

p_detail_code

Detail code associated with every charge and payment that can be entered onto an account. VARCHAR2(4) Required Key

Returns

Category Code

f_get_description

Function f_get_description(p_detail_code tbbdetc.tbbdetc_detail_code%TYPE)
  RETURN VARCHAR2

Return description for the code

Parameters

p_detail_code

Detail code associated with every charge and payment that can be entered onto an account. VARCHAR2(4) Required Key

Returns

Description

f_has_accounting

Function f_has_accounting(p_detail_code tbracct.tbracct_detail_code%TYPE,
                          p_asof_date   DATE,
                          p_tbds_code   tbracct.tbracct_tbds_code%TYPE DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if the detail code has accounting information.
Returns Y if there is accounting detail (TBRACCT) for the Detail Code and Date with a null Term Based designator (not a term based code) or matching Term Based Designator. Therefore, the designator that might be in effect based on Term (or Control Record, for miscellaneous) should normally be provided.

Parameters

	p_detail_code	Detail code associated with every charge and payment that can be entered onto an account. VARCHAR2(4) Required Key
	p_asof_date	Date for which accounting information is verified. DATE Required
	p_tbds_code	Term based designator code, used to differentiate accounting information by term. VARCHAR2(2)

Returns

Y if accounting information exists, otherwise N.

f_isequal

Function f_isequal(rec_one detail_code_rec, rec_two detail_code_rec)
  RETURN VARCHAR2

Compare 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 detail_code_rec Required
	rec_two	The second record to compare. Type detail_code_rec Required

Returns

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

f_query_all

Function f_query_all(p_detail_code     tbbdetc.tbbdetc_detail_code%TYPE DEFAULT NULL,
                     p_dcat_code       tbbdetc.tbbdetc_dcat_code%TYPE DEFAULT NULL,
                     p_detc_active_ind tbbdetc.tbbdetc_detc_active_ind%TYPE DEFAULT NULL)
  RETURN detail_code_ref

Selects all records for the entity.
If parameters are null they are ignored (may return all rows from the table).
A wildcard (%) may be used in the Detail Code parameter.
AND is used when multiple criteria are provided.

Parameters

p_detail_code

Detail code associated with every charge and payment that can be entered onto an account. VARCHAR2(4)

p_dcat_code

Category of the detail code, to group for reporting purposes. VARCHAR2(3)

p_detc_active_ind

Active Status Indicator of the Detail Code. VARCHAR2(1)

	Y	Detail Code is active
	N	Detail Code is not active

Returns

A cursor variable that will fetch the set of records.

f_query_one

Function f_query_one(p_detail_code tbbdetc.tbbdetc_detail_code%TYPE)
  RETURN detail_code_ref

Selects one record using key.

Parameters

p_detail_code

Detail code associated with every charge and payment that can be entered onto an account. 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 detail_code_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 tbbdetc.tbbdetc_detail_code%TYPE,
                          p_rowid       VARCHAR2 DEFAULT NULL)
  RETURN detail_code_ref

Selects one record and locks it.

Parameters

	p_detail_code	Detail code associated with every charge and payment that can be entered onto an account. 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_valid_to_delete

Function f_valid_to_delete(p_detail_code tbbdetc.tbbdetc_detail_code%TYPE)
  RETURN VARCHAR2

Checks many tables to see if detail code is in use, or may be deleted.
The message will reflect primary AR tables where the code has been used, in which case it may not be deleted.
If the code has not been used to create transactions, a message with a partial listing of other tables from which the code should be removed prior to delete is provided.

Parameters

p_detail_code

Detail code associated with every charge and payment that can be entered onto an account. VARCHAR2(4) Required Key

Returns

Error message if code should not be deleted, else null.