index

Package rp_dl_period_schedule

Common Business Process interface for the DL_PERIOD_SCHEDULE API (rp_dl_period_schedule).


Program units
f_api_version   Returns the API version number.
f_exists   Checks if a record exists.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using key.
p_create   Creates a record.
p_delete   Deletes a record.
p_update   Updates a record.
p_recalc_from_disb   Recalculates the loan_amt value from the child disbursement records (RLRDLDB)


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    rlrdlps.rlrdlps_pidm%TYPE,
                  p_loan_no rlrdlps.rlrdlps_loan_no%TYPE,
                  p_period  rlrdlps.rlrdlps_period%TYPE,
                  p_rowid   gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   The loan number associated with this record. NUMBER(4) Required Key
p_period   The period associated with the Direct Loan schedule. VARCHAR2(15) 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    rlrdlps.rlrdlps_pidm%TYPE,
                     p_loan_no rlrdlps.rlrdlps_loan_no%TYPE,
                     p_period  rlrdlps.rlrdlps_period%TYPE)
  RETURN rb_dl_period_schedule.dl_period_schedule_ref

Selects all records for the entity.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   The loan number associated with this record. NUMBER(4) Required Key
p_period   The period associated with the Direct Loan schedule. VARCHAR2(15) Required Key

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


f_query_one

FUNCTION f_query_one(p_pidm    rlrdlps.rlrdlps_pidm%TYPE,
                     p_loan_no rlrdlps.rlrdlps_loan_no%TYPE,
                     p_period  rlrdlps.rlrdlps_period%TYPE)
  RETURN rb_dl_period_schedule.dl_period_schedule_ref

Selects one record using key.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   The loan number associated with this record. NUMBER(4) Required Key
p_period   The period associated with the Direct Loan schedule. VARCHAR2(15) Required Key

Returns
A cursor variable that will fetch exactly one record.


p_create

PROCEDURE p_create(p_pidm        rlrdlps.rlrdlps_pidm%TYPE,
                   p_loan_no     rlrdlps.rlrdlps_loan_no%TYPE,
                   p_period      rlrdlps.rlrdlps_period%TYPE,
                   p_fund_code   rlrdlps.rlrdlps_fund_code%TYPE,
                   p_loan_amt    rlrdlps.rlrdlps_loan_amt%TYPE,
                   p_user_id     rlrdlps.rlrdlps_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin rlrdlps.rlrdlps_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   The loan number associated with this record. NUMBER(4) Required Key
p_period   The period associated with the Direct Loan schedule. VARCHAR2(15) Required Key
p_fund_code   The fund code associated with this disbursement. VARCHAR2(6) Required
p_loan_amt   The loan amount scheduled for the period. NUMBER(,) Required
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    rlrdlps.rlrdlps_pidm%TYPE DEFAULT NULL,
                   p_loan_no rlrdlps.rlrdlps_loan_no%TYPE DEFAULT NULL,
                   p_period  rlrdlps.rlrdlps_period%TYPE DEFAULT NULL,
                   p_rowid   gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   The loan number associated with this record. NUMBER(4) Required Key
p_period   The period associated with the Direct Loan schedule. VARCHAR2(15) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_update

PROCEDURE p_update(p_pidm        rlrdlps.rlrdlps_pidm%TYPE,
                   p_loan_no     rlrdlps.rlrdlps_loan_no%TYPE,
                   p_period      rlrdlps.rlrdlps_period%TYPE,
                   p_fund_code   rlrdlps.rlrdlps_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_loan_amt    rlrdlps.rlrdlps_loan_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id     rlrdlps.rlrdlps_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin rlrdlps.rlrdlps_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   The loan number associated with this record. NUMBER(4) Required Key
p_period   The period associated with the Direct Loan schedule. VARCHAR2(15) Required Key
p_fund_code   The fund code associated with this disbursement. VARCHAR2(6) Required
p_loan_amt   The loan amount scheduled for the period. NUMBER(,) Required
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)


p_recalc_from_disb

PROCEDURE p_recalc_from_disb(p_pidm    rlrdlps.rlrdlps_pidm%TYPE,
                             p_loan_no rlrdlps.rlrdlps_loan_no%TYPE,
                             p_period  rlrdlps.rlrdlps_period%TYPE)

Recalculates the loan_amt value from the child disbursement records (RLRDLDB)

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   The loan number associated with this record. NUMBER(4) Required Key
p_period   The period associated with the Direct Loan schedule. VARCHAR2(15) Required Key