Package rp_dl_disb

Package rp_dl_disb_detail

Program units

f_api_version	Return the current version number of the business entity API (not the file version number).
f_exists	Pass-through to the RB_DL_DISB_DETAIL.F_EXISTS function.
f_query_all	Pass-through to the RB_DL_DISB_DETAIL.F_QUERY_ALL function.
f_query_one	Pass-through to the RB_DL_DISB_DETAIL.F_QUERY_ONE function.
f_get_next_disb_seq_no	Returns the next available DL disbursement sequence number for this disbursement.
p_create	Creates a new disbursement detail record and updates its parents.
p_delete	Deletes a disbursement detail record and updates its parents.
p_update	Updates a disbursement detail record and its parents.
f_can_delete	Indicates if the specified record can be deleted.
f_can_update	Indicates if the specified record can be updated.
f_can_create	Indicates if disbursement detail records can be created for the disbursement.
f_get_max_rec	Returns an RLRDLDD%ROWTYPE record for the row with the max sequence number for the specified disbursement.
f_get_rec	Returns an RLRDLDD%ROWTYPE record for the row with the specified sequence number for the specified disbursement.

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

Return the current version number of the business entity API (not the file version number).

Returns

Version of the API signature. Changes only when the signature changes.

f_exists

FUNCTION f_exists(p_pidm    rlrdldd.rlrdldd_pidm%TYPE,
                  p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                  p_disb_no rlrdldd.rlrdldd_disb_no%TYPE,
                  p_seq_no  rlrdldd.rlrdldd_seq_no%TYPE,
                  p_rowid   gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Pass-through to the RB_DL_DISB_DETAIL.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_seq_no	The sequence for this disbursement record. This sequence number starts at one for each scheduled disbursement number and is incremented by one each time an adjustment is made to the 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    rlrdldd.rlrdldd_pidm%TYPE,
                     p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                     p_disb_no rlrdldd.rlrdldd_disb_no%TYPE,
                     p_seq_no  rlrdldd.rlrdldd_seq_no%TYPE) RETURN rb_dl_disb_detail.dl_disb_detail_ref

Pass-through to the RB_DL_DISB_DETAIL.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
	p_seq_no	The sequence for this disbursement record. This sequence number starts at one for each scheduled disbursement number and is incremented by one each time an adjustment is made to the 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    rlrdldd.rlrdldd_pidm%TYPE,
                     p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                     p_disb_no rlrdldd.rlrdldd_disb_no%TYPE,
                     p_seq_no  rlrdldd.rlrdldd_seq_no%TYPE) RETURN rb_dl_disb_detail.dl_disb_detail_ref

Pass-through to the RB_DL_DISB_DETAIL.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
	p_seq_no	The sequence for this disbursement record. This sequence number starts at one for each scheduled disbursement number and is incremented by one each time an adjustment is made to the disbursement. NUMBER(2) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_get_next_disb_seq_no

FUNCTION f_get_next_disb_seq_no(p_pidm    rlrdldd.rlrdldd_pidm%TYPE,
                                p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                                p_disb_no rlrdldd.rlrdldd_disb_no%TYPE) RETURN rlrdldd.rlrdldd_seq_no%TYPE

Returns the next available DL disbursement sequence number for this 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

Version of the API signature. Changes only when the signature changes.

p_create

PROCEDURE p_create(p_pidm                  rlrdldd.rlrdldd_pidm%TYPE,
                   p_loan_no               rlrdldd.rlrdldd_loan_no%TYPE,
                   p_disb_no               rlrdldd.rlrdldd_disb_no%TYPE,
                   p_seq_no                rlrdldd.rlrdldd_seq_no%TYPE,
                   p_aidy_code             rlrdldd.rlrdldd_aidy_code%TYPE,
                   p_fund_code             rlrdldd.rlrdldd_fund_code%TYPE,
                   p_period                rlrdldd.rlrdldd_period%TYPE,
                   p_sched_date            rlrdldd.rlrdldd_sched_date%TYPE,
                   p_authorized_ind        rlrdldd.rlrdldd_authorized_ind%TYPE DEFAULT 'N',
                   p_feed_ind              rlrdldd.rlrdldd_feed_ind%TYPE DEFAULT 'N',
                   p_disb_status           rlrdldd.rlrdldd_disb_status%TYPE DEFAULT NULL,
                   p_ar_term_code          rlrdldd.rlrdldd_ar_term_code%TYPE DEFAULT NULL,
                   p_document_id           rlrdldd.rlrdldd_document_id%TYPE DEFAULT NULL,
                   p_gross_amt             rlrdldd.rlrdldd_gross_amt%TYPE DEFAULT NULL,
                   p_fee_amt               rlrdldd.rlrdldd_fee_amt%TYPE DEFAULT NULL,
                   p_rebate_amt            rlrdldd.rlrdldd_rebate_amt%TYPE DEFAULT NULL,
                   p_net_amt               rlrdldd.rlrdldd_net_amt%TYPE DEFAULT NULL,
                   p_feed_date             rlrdldd.rlrdldd_feed_date%TYPE DEFAULT NULL,
                   p_reported_date         rlrdldd.rlrdldd_reported_date%TYPE DEFAULT NULL,
                   p_enrollment_school_cde rlrdldd.rlrdldd_enrollment_school_cde%TYPE DEFAULT NULL,
                   p_enrollment_status     rlrdldd.rlrdldd_enrollment_status%TYPE DEFAULT NULL,
                   p_cip_code              rlrdldd.rlrdldd_cip_code%TYPE DEFAULT NULL,
                   p_pay_pd_start_date     rlrdldd.rlrdldd_pay_pd_start_date%TYPE DEFAULT NULL,
                   p_ar_tran_number        rlrdldd.rlrdldd_ar_tran_number%TYPE DEFAULT NULL,
                   p_load                  rlrdldd.rlrdldd_load%TYPE DEFAULT NULL,
                   p_load_opt              rlrdldd.rlrdldd_load_opt%TYPE DEFAULT NULL,
                   p_comment               rlrdldd.rlrdldd_comment%TYPE DEFAULT NULL,
                   p_disb_sched_no_days    rlrdldd.rlrdldd_disb_sched_no_days%TYPE DEFAULT NULL,
                   p_user_id               rlrdldd.rlrdldd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin           rlrdldd.rlrdldd_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a new disbursement detail record and updates its parents.

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_seq_no	The sequence for this disbursement record. This sequence number starts at one for each scheduled disbursement number and is incremented by one each time an adjustment is made to the 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 a sequence 1 disbursement may occur. DATE Required
	p_authorized_ind	Indicates if this disbursement sequence is authorized for payment by the disbursement process. Only applicable for Direct Loan Advance Pay processing. VARCHAR2(1)
	p_feed_ind	Indicates if the disbursement sequence has been fed to Accounts Receivable. VARCHAR2(1)
	p_disb_status	The processing status of the disbursement sequence. VARCHAR2(1)
	p_ar_term_code	The term associated with the accounts receivable indicator for the period. VARCHAR2(6)
	p_document_id	The COD document identification number associated with this disbursement sequence record. VARCHAR2(30)
	p_gross_amt	The Gross Amount for this disbursement sequence. NUMBER(11,2)
	p_fee_amt	The Fee Amount for this disbursement sequence. NUMBER(11,2)
	p_rebate_amt	The Rebate Amount for this disbursement sequence. NUMBER(11,2)
	p_net_amt	The Net Amount for this disbursement sequence. NUMBER(11,2)
	p_feed_date	Date the disbursement sequence was paid to the student's account in Accounts Receivable. DATE
	p_reported_date	Disbursement date reported to COD as of this sequence. DATE
	p_enrollment_school_cde	The 8 digit OPEID and Branch Code where the student is physically enrolled for this loan disbursement sequence. VARCHAR2(8)
	p_enrollment_status	The student's enrollment status for this disbursement sequence. VARCHAR2(1)
	p_cip_code	The student's Classification of Instructional Program Code for this disbursement sequence. VARCHAR2(20)
	p_pay_pd_start_date	The start date of the payment period for this disbursement. DATE
	p_ar_tran_number	The transaction number on student's account in Accounts Receivable where the disbursement sequence was applied. NUMBER(8)
	p_load	The student's enrollment load calculated at the time of disbursement. VARCHAR2(1)
	p_load_opt	The enrollment option used to determine the disbursement load. VARCHAR2(1)
	p_comment	Any special processing comments or instructions entered by the user. VARCHAR2(4000)
	p_user_id	The user ID of the person who inserted or last updated this record. VARCHAR2(30)
	p_data_origin	The latest source for the data contained in this record. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm    rlrdldd.rlrdldd_pidm%TYPE,
                   p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                   p_disb_no rlrdldd.rlrdldd_disb_no%TYPE,
                   p_seq_no  rlrdldd.rlrdldd_seq_no%TYPE,
                   p_rowid   gb_common.internal_record_id_type DEFAULT NULL)

Deletes a disbursement detail record and updates its parents.

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_seq_no	The sequence for this disbursement record. This sequence number starts at one for each scheduled disbursement number and is incremented by one each time an adjustment is made to the disbursement. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_update

PROCEDURE p_update(p_pidm                  rlrdldd.rlrdldd_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_loan_no               rlrdldd.rlrdldd_loan_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_disb_no               rlrdldd.rlrdldd_disb_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_seq_no                rlrdldd.rlrdldd_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_aidy_code             rlrdldd.rlrdldd_aidy_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fund_code             rlrdldd.rlrdldd_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_period                rlrdldd.rlrdldd_period%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sched_date            rlrdldd.rlrdldd_sched_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_authorized_ind        rlrdldd.rlrdldd_authorized_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_feed_ind              rlrdldd.rlrdldd_feed_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_disb_status           rlrdldd.rlrdldd_disb_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ar_term_code          rlrdldd.rlrdldd_ar_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_document_id           rlrdldd.rlrdldd_document_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_gross_amt             rlrdldd.rlrdldd_gross_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_fee_amt               rlrdldd.rlrdldd_fee_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rebate_amt            rlrdldd.rlrdldd_rebate_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_net_amt               rlrdldd.rlrdldd_net_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_feed_date             rlrdldd.rlrdldd_feed_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_reported_date         rlrdldd.rlrdldd_reported_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_enrollment_school_cde rlrdldd.rlrdldd_enrollment_school_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_enrollment_status     rlrdldd.rlrdldd_enrollment_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cip_code              rlrdldd.rlrdldd_cip_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pay_pd_start_date     rlrdldd.rlrdldd_pay_pd_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_ar_tran_number        rlrdldd.rlrdldd_ar_tran_number%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_load                  rlrdldd.rlrdldd_load%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_load_opt              rlrdldd.rlrdldd_load_opt%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_comment               rlrdldd.rlrdldd_comment%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_disb_sched_no_days    rlrdldd.rlrdldd_disb_sched_no_days%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id               rlrdldd.rlrdldd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin           rlrdldd.rlrdldd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                 gb_common.internal_record_id_type DEFAULT NULL)

Updates a disbursement detail record and its parents.

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_seq_no	The sequence for this disbursement record. This sequence number starts at one for each scheduled disbursement number and is incremented by one each time an adjustment is made to the 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 a sequence 1 disbursement may occur. DATE Required
	p_authorized_ind	Indicates if this disbursement sequence is authorized for payment by the disbursement process. Only applicable for Direct Loan Advance Pay processing. VARCHAR2(1) Required
	p_feed_ind	Indicates if the disbursement sequence has been fed to Accounts Receivable. VARCHAR2(1) Required
	p_disb_status	The processing status of the disbursement sequence. VARCHAR2(1)
	p_ar_term_code	The term associated with the accounts receivable indicator for the period. VARCHAR2(6)
	p_document_id	The COD document identification number associated with this disbursement sequence record. VARCHAR2(30)
	p_gross_amt	The Gross Amount for this disbursement sequence. NUMBER(11,2)
	p_fee_amt	The Fee Amount for this disbursement sequence. NUMBER(11,2)
	p_rebate_amt	The Rebate Amount for this disbursement sequence. NUMBER(11,2)
	p_net_amt	The Net Amount for this disbursement sequence. NUMBER(11,2)
	p_feed_date	Date the disbursement sequence was paid to the student's account in Accounts Receivable. DATE
	p_reported_date	Disbursement date reported to COD as of this sequence. DATE
	p_enrollment_school_cde	The 8 digit OPEID and Branch Code where the student is physically enrolled for this loan disbursement sequence. VARCHAR2(8)
	p_enrollment_status	The student's enrollment status for this disbursement sequence. VARCHAR2(1)
	p_cip_code	The student's Classification of Instructional Program Code for this disbursement sequence. VARCHAR2(20)
	p_pay_pd_start_date	The start date of the payment period for this disbursement. DATE
	p_ar_tran_number	The transaction number on student's account in Accounts Receivable where the disbursement sequence was applied. NUMBER(8)
	p_load	The student's enrollment load calculated at the time of disbursement. VARCHAR2(1)
	p_load_opt	The enrollment option used to determine the disbursement load. VARCHAR2(1)
	p_comment	Any special processing comments or instructions entered by the user. VARCHAR2(4000)
	p_user_id	The user ID of the person who inserted or last updated this record. VARCHAR2(30)
	p_data_origin	The latest source for the data contained in this record. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)

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

f_can_create

FUNCTION f_can_create(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 disbursement detail records can be created for the 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

f_get_max_rec

FUNCTION f_get_max_rec(p_pidm    rlrdldd.rlrdldd_pidm%TYPE,
                       p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                       p_disb_no rlrdldd.rlrdldd_disb_no%TYPE) RETURN rlrdldd%ROWTYPE

Returns an RLRDLDD%ROWTYPE record for the row with the max sequence number for the specified 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

f_get_rec

FUNCTION f_get_rec(p_pidm    rlrdldd.rlrdldd_pidm%TYPE,
                   p_loan_no rlrdldd.rlrdldd_loan_no%TYPE,
                   p_disb_no rlrdldd.rlrdldd_disb_no%TYPE,
                   p_seq_no  rlrdldd.rlrdldd_seq_no%TYPE) RETURN rlrdldd%ROWTYPE

Returns an RLRDLDD%ROWTYPE record for the row with the specified sequence number for the specified 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