index

Package rp_dl_origination

Common Business logic interface for the Direct Loan Origination Business Process API (rp_dl_origination).

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_delete   Deletes a record.
p_recalc   Recalculates and updates the loan amount for a record based on the child record values in RLRDLPS
p_update   Updates a record.

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    rlrdlor.rlrdlor_pidm%TYPE,
                  p_loan_no rlrdlor.rlrdlor_loan_no%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   A system generated loan number for the student. NUMBER(4) 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    rlrdlor.rlrdlor_pidm%TYPE,
                     p_loan_no rlrdlor.rlrdlor_loan_no%TYPE DEFAULT NULL)
  RETURN rb_dl_origination.dl_origination_ref

Selects all records for the entity.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   A system generated loan number for the student. NUMBER(4)

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

f_query_one 

Function f_query_one(p_pidm    rlrdlor.rlrdlor_pidm%TYPE,
                     p_loan_no rlrdlor.rlrdlor_loan_no%TYPE)
  RETURN rb_dl_origination.dl_origination_ref

Selects one record using key.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   A system generated loan number for the student. NUMBER(4) Required Key

Returns
A cursor variable that will fetch exactly one record.

p_delete 

Procedure p_delete(p_pidm    rlrdlor.rlrdlor_pidm%TYPE,
                   p_loan_no rlrdlor.rlrdlor_loan_no%TYPE)

Deletes a record.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   A system generated loan number for the student. NUMBER(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_recalc 

Procedure p_recalc(p_pidm    rlrdlor.rlrdlor_pidm%TYPE,
                   p_loan_no rlrdlor.rlrdlor_loan_no%TYPE)

Recalculates and updates the loan amount for a record based on the child record values in RLRDLPS

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   A system generated loan number for the student. NUMBER(4) Required Key

p_update 

Procedure p_update(p_pidm                rlrdlor.rlrdlor_pidm%TYPE,
                   p_loan_no             rlrdlor.rlrdlor_loan_no%TYPE,
                   p_aidy_code           rlrdlor.rlrdlor_aidy_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fund_code           rlrdlor.rlrdlor_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_loan_id             rlrdlor.rlrdlor_loan_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_loan_type           rlrdlor.rlrdlor_loan_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_school_code         rlrdlor.rlrdlor_school_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_create_date         rlrdlor.rlrdlor_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_lock_ind            rlrdlor.rlrdlor_lock_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lnst_code           rlrdlor.rlrdlor_lnst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fee_pct             rlrdlor.rlrdlor_fee_pct%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rebate_pct          rlrdlor.rlrdlor_rebate_pct%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_loan_amt            rlrdlor.rlrdlor_loan_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_in_default          rlrdlor.rlrdlor_in_default%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_hppa_ind            rlrdlor.rlrdlor_hppa_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_addl_unsub_elig_ind rlrdlor.rlrdlor_addl_unsub_elig_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acad_yr_start_date  rlrdlor.rlrdlor_acad_yr_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_acad_yr_end_date    rlrdlor.rlrdlor_acad_yr_end_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_award_start_date    rlrdlor.rlrdlor_award_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_award_end_date      rlrdlor.rlrdlor_award_end_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_prep_or_teach_ind   rlrdlor.rlrdlor_prep_or_teach_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_entrance_ind        rlrdlor.rlrdlor_entrance_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_status              rlrdlor.rlrdlor_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_mpn_linked_ind      rlrdlor.rlrdlor_mpn_linked_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_spgm_lock_ind       rlrdlor.rlrdlor_spgm_lock_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_spgm_seq_no         rlrdlor.rlrdlor_spgm_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_bbay_code           rlrdlor.rlrdlor_bbay_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sayr_code           rlrdlor.rlrdlor_sayr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_disc_print_flag     rlrdlor.rlrdlor_disc_print_flag%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_yr_in_coll          rlrdlor.rlrdlor_yr_in_coll%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_process_date        rlrdlor.rlrdlor_process_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_dependency_status   rlrdlor.rlrdlor_dependency_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sar_tran_no         rlrdlor.rlrdlor_sar_tran_no%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_mpn_id              rlrdlor.rlrdlor_mpn_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_date_sent           rlrdlor.rlrdlor_date_sent%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_document_id         rlrdlor.rlrdlor_document_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id             rlrdlor.rlrdlor_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin         rlrdlor.rlrdlor_data_origin%TYPE DEFAULT dml_common.f_unspecified_string)

Updates a record.

Parameters
p_pidm   Internal system student identification number. NUMBER(8) Required Key
p_loan_no   A system generated loan number for the student. NUMBER(4) Required Key
p_aidy_code   The aid year to be associated with the information in this record. VARCHAR2(4) Required
p_fund_code   The fund code associated with the loan application. VARCHAR2(6) Required
p_loan_id   A system generated field constructed from the SSN, loan type, loan year, Direct Loan school code, and loan sequence number. VARCHAR2(21) Required
p_loan_type   The loan type for the record. VARCHAR2(1) Required
p_school_code   The Department of Education's Direct Loan school code to be used for loan processing for the attending institution. VARCHAR2(6) Required
p_create_date   The date the loan application was created. DATE Required
p_lock_ind   Indicates whether the loan has been locked. VARCHAR2(1) Required
p_lnst_code   The code used to identify the current status of the loan in processing. VARCHAR2(4) Required
p_fee_pct   The percentage of the loan that will be subtracted from the loan proceed for origination fees. NUMBER(6,3) Required
p_rebate_pct   Rebate fee percent. NUMBER(6,3) Required
p_loan_amt   The loan amount for the origination. NUMBER(11,2) Required
p_in_default   Indicates whether the student is in default on a Title IV loan as reported by NSLDS. VARCHAR2(1) Required
p_hppa_ind   Indicates whether this student qualifies for additional Unsubsidized loans up to the HPPA limits. VARCHAR2(1) Required
p_addl_unsub_elig_ind   Indicates whether this dependent student is eligible for additional unsubsidized loan due to a Parent PLUS denial. VARCHAR2(1) Required
p_acad_yr_start_date   The date on which the student's academic year starts for this origination. DATE Required
p_acad_yr_end_date   The date on which the student's academic year ends for this origination. DATE Required
p_award_start_date   The start date of the loan award based on the period awards contained within the loan. DATE Required
p_award_end_date   The end date of the loan award based on the period awards contained within the loan. DATE Required
p_prep_or_teach_ind   Indicates if specific loan limits should be applied due to enrollment in preparatory coursework required prior to enrolling in an undergraduate degree or certificate program or a graduate or professional program, or due to coursework necessary for teacher certification. VARCHAR2(1) Required
p_entrance_ind   Indicates whether the borrower has completed entrance counseling for this loan type. VARCHAR2(1) Required
p_status   The current status of the origination. VARCHAR2(1) Required
p_mpn_linked_ind   COD's acknowledgement that this origination is linked to the MPN ID at COD. VARCHAR2(1) Required
p_spgm_lock_ind   Indicates if the student program information sequence is locked for the loan origination record. VARCHAR2(1) Required
p_spgm_seq_no   Sequence of the program information record used on this origination. NUMBER(3)
p_bbay_code   The Borrower-Based Academic Year associated with this record. VARCHAR2(15)
p_sayr_code   The Scheduled Academic Year associated with this record. VARCHAR2(15)
p_disc_print_flag   This field indicates a request to have COD print or reprint the disclosure statement. VARCHAR2(1)
p_yr_in_coll   The student's year in college for this origination record. VARCHAR2(1)
p_process_date   The date that the origination was processed by COD and the response returned to the school. DATE
p_dependency_status   Indicates if the student is (I)ndependent or (D)ependent. VARCHAR2(1)
p_sar_tran_no   The eligible SAR transaction number that was reported with the origination record. VARCHAR2(2)
p_mpn_id   The ID printed on the Master Promissory Note associated with this loan. VARCHAR2(21)
p_date_sent   The date that the Direct Loan origination record was sent to COD. DATE
p_document_id   The document identification number for the document in which the loan's initial origination was sent to COD. VARCHAR2(30)
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)