index

Package ab_gift_auxl_hold_rules

This package provides the messaging support and field validation for the Gift Auxiliary Hold API (ab_gift_auxl_hold).
 
The validation procedure is called by the API, but may be called directly by an application if data validation is needed prior to calling the API.
Regardless, the API will always run the validation checks.

Program units
p_register_entity   Registers the attribute value pairs to the message cache for delete operations.
p_register_entity   Registers the attribute/value pairs to the message cache for create and update operations.
p_validate   Validates all data in the record.

p_register_entity 

Procedure p_register_entity(p_operation_type     NUMBER,
                            p_internal_record_id gb_common.internal_record_id_type)

Registers the attribute value pairs to the message cache for delete operations.
This procedure passes the operation type and a set of constant strings and data values to the messaging system. The constants represent the name of each data element and are defined in the DML package specification.
The procedure is overloaded so the API p_delete has a signature to call that only requires operation and ROWID.
This signature uses the ROWID only for delete operations.

Parameters
p_operation_type   Type of DML operation: create, update, delete. NUMBER Required
p_internal_record_id   Database ROWID VARCHAR2(18) Required

p_register_entity 

Procedure p_register_entity(p_operation_type     NUMBER,
                            p_id                 agrauxh.agrauxh_id%TYPE,
                            p_gift_no            agrauxh.agrauxh_gift_no%TYPE,
                            p_auxl_code          agrauxh.agrauxh_auxl_code%TYPE,
                            p_auxl_desc          agrauxh.agrauxh_auxl_desc%TYPE,
                            p_dcpr_cost          agrauxh.agrauxh_dcpr_cost%TYPE,
                            p_user_id            agrauxh.agrauxh_user_id%TYPE DEFAULT gb_common.f_sct_user,
                            p_data_origin        agrauxh.agrauxh_data_origin%TYPE,
                            p_auxl_value_date    agrauxh.agrauxh_auxl_value_date%TYPE,
                            p_pidm               agrauxh.agrauxh_pidm%TYPE,
                            p_dcpr_code          agrauxh.agrauxh_dcpr_code%TYPE,
                            p_issue_date         agrauxh.agrauxh_issue_date%TYPE,
                            p_dcpr_value         agrauxh.agrauxh_dcpr_value%TYPE,
                            p_desc               agrauxh.agrauxh_desc%TYPE,
                            p_acc_rej_ind        agrauxh.agrauxh_acc_rej_ind%TYPE,
                            p_acc_rej_date       agrauxh.agrauxh_acc_rej_date%TYPE,
                            p_donr_code          agrauxh.agrauxh_donr_code%TYPE,
                            p_pref_clas          agrauxh.agrauxh_pref_clas%TYPE,
                            p_deduct_for_taxes   agrauxh.agrauxh_deduct_for_taxes%TYPE,
                            p_comment            agrauxh.agrauxh_comment%TYPE,
                            p_internal_record_id gb_common.internal_record_id_type)

Registers the attribute/value pairs to the message cache for create and update operations.
 
This signature registers all parameters.

Parameters
p_operation_type   Type of DML operation: create, update, delete. NUMBER Required
p_id   Banner ID associated with the gift. VARCHAR2(36) Required
p_gift_no   The system assigned number for the gift. VARCHAR2(28) Required
p_auxl_code   Auxiliary code associated with the gift. VARCHAR2(20) Required
p_auxl_desc   Description for the auxiliary code for the gift. VARCHAR2(240) Required
p_dcpr_cost   Actual cost to institution of benefit/premium. NUMBER(11,2) Required
p_user_id   System maintained field specifying user name. VARCHAR2(120) Required
p_data_origin   System maintained field specifying the origin of the data. VARCHAR2(120) Required
p_auxl_value_date   Date the Auxiliary Value was determined. DATE Required
p_pidm   Internal system generated identification number. NUMBER(8)
p_dcpr_code   Benefit/premium associated with the gift. VARCHAR2(16)
p_issue_date   Date the benefit/premium was issued. DATE
p_dcpr_value   Market value of benefit/premium. NUMBER(11,2)
p_desc   Brief description of the benefit/premium. VARCHAR2(240)
p_acc_rej_ind   Indicator for whether benefit/premium was accepted/rejected. VARCHAR2(4)
p_acc_rej_date   Date benefit/premium was accepted/rejected. DATE
p_donr_code   Donor category code for ID associated with gift. VARCHAR2(16)
p_pref_clas   Preferred class year for ID. VARCHAR2(16)
p_deduct_for_taxes   Indicator for whether premium is to be deducted for taxes. VARCHAR2(4)
p_comment   Free format comment for associated amount/benefit/premium. CLOB
p_internal_record_id   Database ROWID VARCHAR2(18) Required

p_validate 

Procedure p_validate(p_id               agrauxh.agrauxh_id%TYPE,
                     p_gift_no          agrauxh.agrauxh_gift_no%TYPE,
                     p_auxl_code        agrauxh.agrauxh_auxl_code%TYPE,
                     p_auxl_desc        agrauxh.agrauxh_auxl_desc%TYPE,
                     p_dcpr_cost        agrauxh.agrauxh_dcpr_cost%TYPE,
                     p_user_id          agrauxh.agrauxh_user_id%TYPE DEFAULT gb_common.f_sct_user,
                     p_data_origin      agrauxh.agrauxh_data_origin%TYPE,
                     p_auxl_value_date  agrauxh.agrauxh_auxl_value_date%TYPE,
                     p_pidm             agrauxh.agrauxh_pidm%TYPE DEFAULT NULL,
                     p_dcpr_code        agrauxh.agrauxh_dcpr_code%TYPE DEFAULT NULL,
                     p_issue_date       agrauxh.agrauxh_issue_date%TYPE DEFAULT NULL,
                     p_dcpr_value       agrauxh.agrauxh_dcpr_value%TYPE DEFAULT NULL,
                     p_desc             agrauxh.agrauxh_desc%TYPE DEFAULT NULL,
                     p_acc_rej_ind      agrauxh.agrauxh_acc_rej_ind%TYPE DEFAULT NULL,
                     p_acc_rej_date     agrauxh.agrauxh_acc_rej_date%TYPE DEFAULT NULL,
                     p_donr_code        agrauxh.agrauxh_donr_code%TYPE DEFAULT NULL,
                     p_pref_clas        agrauxh.agrauxh_pref_clas%TYPE DEFAULT NULL,
                     p_deduct_for_taxes agrauxh.agrauxh_deduct_for_taxes%TYPE DEFAULT NULL,
                     p_comment          agrauxh.agrauxh_comment%TYPE DEFAULT NULL)

Validates all data in the record.
 
The following edits are performed. All failed edit messages are appended and issued in a single application exception.


Parameters
p_id   Banner ID associated with the gift. VARCHAR2(36) Required
p_gift_no   The system assigned number for the gift. VARCHAR2(28) Required
p_auxl_code   Auxiliary code associated with the gift. VARCHAR2(20) Required
p_auxl_desc   Description for the auxiliary code for the gift. VARCHAR2(240) Required
p_dcpr_cost   Actual cost to institution of benefit/premium. NUMBER(11,2) Required
p_user_id   System maintained field specifying user name. VARCHAR2(120) Required
p_data_origin   System maintained field specifying the origin of the data. VARCHAR2(120) Required
p_auxl_value_date   Date the Auxiliary Value was determined. DATE Required
p_pidm   Internal system generated identification number. NUMBER(8)
p_dcpr_code   Benefit/premium associated with the gift. VARCHAR2(16)
p_issue_date   Date the benefit/premium was issued. DATE
p_dcpr_value   Market value of benefit/premium. NUMBER(11,2)
p_desc   Brief description of the benefit/premium. VARCHAR2(240)
p_acc_rej_ind   Indicator for whether benefit/premium was accepted/rejected. VARCHAR2(4)
p_acc_rej_date   Date benefit/premium was accepted/rejected. DATE
p_donr_code   Donor category code for ID associated with gift. VARCHAR2(16)
p_pref_clas   Preferred class year for ID. VARCHAR2(16)
p_deduct_for_taxes   Indicator for whether premium is to be deducted for taxes. VARCHAR2(4)
p_comment   Free format comment for associated amount/benefit/premium. CLOB