Package rp_dl

Package rp_dl_disb

Program units

f_api_version	Returns the API version number.
f_exists	Pass-through to the RB_DL_DISB.F_EXISTS function.
f_query_all	Pass-through to the RB_DL_DISB.F_QUERY_ALL function.
f_query_one	Pass-through to the RB_DL_DISB.F_QUERY_ONE function.
f_query_by_rowid	Pass-through to the RB_DL_DISB.F_QUERY_BY_ROWID function.
f_get_next_disb_no	Returns the next available disbursement number for the Direct Loan.
f_get_cip_code	Returns the current CIP code for the DL disbursement.
f_get_enrollment_school_cde	Returns the current enrollment school code for the DL disbursement.
p_create	Creates all the disbursements for the specified loan and period, including the necessary child detail records, and also updates the parent table amounts (RLRDLPS and RLRDLOR).
p_update	Updates a disbursement record and maintains the disbursement detail records.
p_delete	Deletes a record from the table, including child records.
p_recalc_from_disb_detail	Recalculates all values for the specified disbursement summary record based on the current values in the disbursement detail records.
p_resched	Reschedule DL disbursements based on all possible rescheduling rules that can affect Direct Loans.
f_can_delete	Indicates if the specified record can be deleted.
f_can_update	Indicates if the specified record can be updated.

Types

indicator_type

Local type for indicator values.

indicator_type

SUBTYPE indicator_type IS VARCHAR2(1);

Local type for indicator values.

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    rlrdldb.rlrdldb_pidm%TYPE,
                  p_loan_no rlrdldb.rlrdldb_loan_no%TYPE,
                  p_disb_no rlrdldb.rlrdldb_disb_no%TYPE,
                  p_rowid   gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Pass-through to the RB_DL_DISB.F_EXISTS function.
Determine if a record in the table exists.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_query_all

FUNCTION f_query_all(p_pidm    rlrdldb.rlrdldb_pidm%TYPE,
                     p_loan_no rlrdldb.rlrdldb_loan_no%TYPE,
                     p_disb_no rlrdldb.rlrdldb_disb_no%TYPE) RETURN rb_dl_disb.dl_disb_ref

Pass-through to the RB_DL_DISB.F_QUERY_ALL function.
Returns a REF CURSOR for the set of all matching records.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm    rlrdldb.rlrdldb_pidm%TYPE,
                     p_loan_no rlrdldb.rlrdldb_loan_no%TYPE,
                     p_disb_no rlrdldb.rlrdldb_disb_no%TYPE) RETURN rb_dl_disb.dl_disb_ref

Pass-through to the RB_DL_DISB.F_QUERY_ONE function.
Returns a REF CURSOR for one record.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) 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 rb_dl_disb.dl_disb_ref

Pass-through to the RB_DL_DISB.F_QUERY_BY_ROWID function.
Returns a REF CURSOR for one record.

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_get_next_disb_no

FUNCTION f_get_next_disb_no(p_pidm    rlrdldb.rlrdldb_pidm%TYPE,
                            p_loan_no rlrdldb.rlrdldb_loan_no%TYPE) RETURN rlrdldb.rlrdldb_disb_no%TYPE

Returns the next available disbursement number for the Direct Loan.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key

Returns

The next available Direct Loan Disbursement Number for this loan.

f_get_cip_code

FUNCTION f_get_cip_code(p_pidm    rlrdldb.rlrdldb_pidm%TYPE,
                        p_loan_no rlrdldb.rlrdldb_loan_no%TYPE,
                        p_disb_no rlrdldb.rlrdldb_disb_no%TYPE) RETURN rlrdldb.rlrdldb_cip_code%TYPE

Returns the current CIP code for the DL disbursement.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key

Returns

The CIP Code from the disbursement record.

f_get_enrollment_school_cde

FUNCTION f_get_enrollment_school_cde(p_pidm    rlrdldb.rlrdldb_pidm%TYPE,
                                     p_loan_no rlrdldb.rlrdldb_loan_no%TYPE,
                                     p_disb_no rlrdldb.rlrdldb_disb_no%TYPE)
  RETURN rlrdldb.rlrdldb_enrollment_school_cde%TYPE

Returns the current enrollment school code for the DL disbursement.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key

Returns

The Enrollment School Code from the disbursement record.

p_create

PROCEDURE p_create(p_pidm                  rlrdldb.rlrdldb_pidm%TYPE,
                   p_loan_no               rlrdldb.rlrdldb_loan_no%TYPE,
                   p_disb_no               rlrdldb.rlrdldb_disb_no%TYPE,
                   p_aidy_code             rlrdldb.rlrdldb_aidy_code%TYPE,
                   p_fund_code             rlrdldb.rlrdldb_fund_code%TYPE,
                   p_period                rlrdldb.rlrdldb_period%TYPE,
                   p_sched_date            rlrdldb.rlrdldb_sched_date%TYPE DEFAULT NULL,
                   p_disb_sched_no_days    rlrdldb.rlrdldb_disb_sched_no_days%TYPE DEFAULT NULL,
                   p_ar_term_code          rlrdldb.rlrdldb_ar_term_code%TYPE DEFAULT NULL,
                   p_total_gross_amt       rlrdldb.rlrdldb_total_gross_amt%TYPE DEFAULT NULL,
                   p_total_fee_amt         rlrdldb.rlrdldb_total_fee_amt%TYPE DEFAULT NULL,
                   p_total_rebate_amt      rlrdldb.rlrdldb_total_rebate_amt%TYPE DEFAULT NULL,
                   p_total_net_amt         rlrdldb.rlrdldb_total_net_amt%TYPE DEFAULT NULL,
                   p_reported_date         rlrdldb.rlrdldb_reported_date%TYPE DEFAULT NULL,
                   p_enrollment_school_cde rlrdldb.rlrdldb_enrollment_school_cde%TYPE DEFAULT NULL,
                   p_enrollment_status     rlrdldb.rlrdldb_enrollment_status%TYPE DEFAULT NULL,
                   p_cip_code              rlrdldb.rlrdldb_cip_code%TYPE DEFAULT NULL,
                   p_pay_pd_start_date     rlrdldb.rlrdldb_pay_pd_start_date%TYPE DEFAULT NULL,
                   p_period_multiple_disb  indicator_type DEFAULT 'N')

Creates all the disbursements for the specified loan and period, including the necessary child detail records, and also updates the parent table amounts (RLRDLPS and RLRDLOR).

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key
	p_aidy_code	The aid year associated with this disbursement. VARCHAR2(4) Required
	p_fund_code	The fund code associated with this disbursement. VARCHAR2(6) Required
	p_period	The period associated with this disbursement. VARCHAR2(15) Required
	p_sched_date	Used by the disbursement process as the first date on which this disbursement may occur. DATE
	p_disb_sched_no_days	The number of days prior to or after the first class start date of the student to schedule the disbursement. NUMBER(3)
	p_ar_term_code	The term associated with the accounts receivable indicator for the period. VARCHAR2(6)
	p_total_gross_amt	The Gross Amount for this disbursement. NUMBER(11,2)
	p_total_fee_amt	The Fee Amount for this disbursement. NUMBER(11,2)
	p_total_rebate_amt	The Rebate Amount for this disbursement. NUMBER(11,2)
	p_total_net_amt	The Net Amount for this disbursement. NUMBER(11,2)
	p_reported_date	Date reported to COD as the disbursement date. DATE
	p_enrollment_school_cde	The 8 digit OPEID and Branch Code where the student is physically enrolled for this loan disbursement reported to COD. VARCHAR2(8)
	p_enrollment_status	The student's enrollment status for this disbursement reported to COD. VARCHAR2(1)
	p_cip_code	The student's Classification of Instructional Program Code for this disbursement reported to COD. VARCHAR2(20)
	p_pay_pd_start_date	The start date of the payment period for this disbursement. DATE
	p_period_multiple_disb	Indicates whether to create more than 1 disbursement for the loan based on RORBAYD/RORSAYD. indicator_type

p_update

PROCEDURE p_update(p_pidm                  rlrdldb.rlrdldb_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_loan_no               rlrdldb.rlrdldb_loan_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_disb_no               rlrdldb.rlrdldb_disb_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_aidy_code             rlrdldb.rlrdldb_aidy_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fund_code             rlrdldb.rlrdldb_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_period                rlrdldb.rlrdldb_period%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sched_date            rlrdldb.rlrdldb_sched_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_disb_sched_no_days    rlrdldb.rlrdldb_disb_sched_no_days%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_ar_term_code          rlrdldb.rlrdldb_ar_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_total_gross_amt       rlrdldb.rlrdldb_total_gross_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_total_fee_amt         rlrdldb.rlrdldb_total_fee_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_total_rebate_amt      rlrdldb.rlrdldb_total_rebate_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_total_net_amt         rlrdldb.rlrdldb_total_net_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_reported_date         rlrdldb.rlrdldb_reported_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_enrollment_school_cde rlrdldb.rlrdldb_enrollment_school_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_enrollment_status     rlrdldb.rlrdldb_enrollment_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cip_code              rlrdldb.rlrdldb_cip_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pay_pd_start_date     rlrdldb.rlrdldb_pay_pd_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_rowid                 gb_common.internal_record_id_type DEFAULT NULL)

Updates a disbursement record and maintains the disbursement detail records. Also updates the parent table amounts (RLRDLPS and RLRDLOR).

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key
	p_aidy_code	The aid year associated with this disbursement. VARCHAR2(4) Required
	p_fund_code	The fund code associated with this disbursement. VARCHAR2(6) Required
	p_period	The period associated with this disbursement. VARCHAR2(15) Required
	p_sched_date	Used by the disbursement process as the first date on which this disbursement may occur. DATE Required
	p_disb_sched_no_days	The number of days prior to or after the first class start date of the student to schedule the disbursement. NUMBER(3)
	p_ar_term_code	The term associated with the accounts receivable indicator for the period. VARCHAR2(6) Required
	p_total_gross_amt	The Gross Amount for this disbursement. NUMBER(11,2) Required
	p_total_fee_amt	The Fee Amount for this disbursement. NUMBER(11,2) Required
	p_total_rebate_amt	The Rebate Amount for this disbursement. NUMBER(11,2) Required
	p_total_net_amt	The Net Amount for this disbursement. NUMBER(11,2) Required
	p_reported_date	Date reported to COD as the disbursement date. DATE
	p_enrollment_school_cde	The 8 digit OPEID and Branch Code where the student is physically enrolled for this loan disbursement reported to COD. VARCHAR2(8)
	p_enrollment_status	The student's enrollment status for this disbursement reported to COD. VARCHAR2(1)
	p_cip_code	The student's Classification of Instructional Program Code for this disbursement reported to COD. VARCHAR2(20)
	p_pay_pd_start_date	The start date of the payment period for this disbursement. DATE
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)

p_delete

PROCEDURE p_delete(p_pidm    rlrdldb.rlrdldb_pidm%TYPE,
                   p_loan_no rlrdldb.rlrdldb_loan_no%TYPE,
                   p_disb_no rlrdldb.rlrdldb_disb_no%TYPE DEFAULT NULL,
                   p_period  rlrdldb.rlrdldb_period%TYPE DEFAULT NULL)

Deletes a record from the table, including child records. Also updates the parent table amounts (RLRDLPS and RLRDLOR).

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_recalc_from_disb_detail

PROCEDURE p_recalc_from_disb_detail(p_pidm    rlrdldb.rlrdldb_pidm%TYPE,
                                    p_loan_no rlrdldb.rlrdldb_loan_no%TYPE,
                                    p_disb_no rlrdldb.rlrdldb_disb_no%TYPE)

Recalculates all values for the specified disbursement summary record based on the current values in the disbursement detail records.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key

p_resched

PROCEDURE p_resched(p_pidm      rlrdldb.rlrdldb_pidm%TYPE,
                    p_period    rlrdldb.rlrdldb_period%TYPE DEFAULT NULL,
                    p_aidy_code rlrdldb.rlrdldb_aidy_code%TYPE DEFAULT NULL,
                    p_fund_code rlrdldb.rlrdldb_fund_code%TYPE DEFAULT NULL)

Reschedule DL disbursements based on all possible rescheduling rules that can affect Direct Loans.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_period	The period for the Direct Loan disbursments to reschedule. VARCHAR2(30)
	p_aidy_code	The Aid Year Code for the Direct Loan disbursements to reschedule. VARCHAR2(4)
	p_fund_code	The Fund Code for the Direct Loan disbursements to reschedule. VARCHAR2(6)

f_can_delete

FUNCTION f_can_delete(p_pidm    rlrdldd.rlrdldd_pidm%TYPE,
                      p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                      p_disb_no rlrdldd.rlrdldd_disb_no%TYPE) RETURN indicator_type

Indicates if the specified record can be deleted.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key

f_can_update

FUNCTION f_can_update(p_pidm    rlrdldd.rlrdldd_pidm%TYPE,
                      p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                      p_disb_no rlrdldd.rlrdldd_disb_no%TYPE) RETURN indicator_type

Indicates if the specified record can be updated.

Parameters

	p_pidm	Internal system student identification number. NUMBER(8) Required Key
	p_loan_no	The loan number associated with this disbursement. NUMBER(4) Required Key
	p_disb_no	The Direct Loan Disbursement Number for this disbursement. NUMBER(2) Required Key