index

Package rp_applicant_bbay

Common Business logic interface for the Applicant Borrower-Based Academic Year Business Process API (rp_applicant_bbay).

Program units
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.

f_exists 

Function f_exists(p_pidm      rprbbay.rprbbay_pidm%TYPE,
                  p_bbay_code rprbbay.rprbbay_bbay_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_bbay_code   The Borrower-Based Academic Year associated with applicant. 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      rprbbay.rprbbay_pidm%TYPE,
                     p_bbay_code rprbbay.rprbbay_bbay_code%TYPE DEFAULT NULL)
  RETURN rb_applicant_bbay.applicant_bbay_ref

Selects all records for the entity.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_bbay_code   The Borrower-Based Academic Year associated with applicant. VARCHAR2(15) Required Key

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

f_query_one 

Function f_query_one(p_pidm      rprbbay.rprbbay_pidm%TYPE,
                     p_bbay_code rprbbay.rprbbay_bbay_code%TYPE)
  RETURN rb_applicant_bbay.applicant_bbay_ref

Selects one record using key.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_bbay_code   The Borrower-Based Academic Year associated with applicant. VARCHAR2(15) Required Key

Returns
A cursor variable that will fetch exactly one record.

p_create 

Procedure p_create(p_pidm            rprbbay.rprbbay_pidm%TYPE,
                   p_bbay_code       rprbbay.rprbbay_bbay_code%TYPE,
                   p_bbtp_code       rprbbay.rprbbay_bbtp_code%TYPE DEFAULT NULL,
                   p_budg_dur        rprbbay.rprbbay_budg_dur%TYPE DEFAULT NULL,
                   p_bbay_algo_code  rprbbay.rprbbay_bbay_algo_code%TYPE DEFAULT NULL,
                   p_bbay_seq_no     rprbbay.rprbbay_bbay_seq_no%TYPE DEFAULT NULL,
                   p_aidy_code_funds rprbbay.rprbbay_aidy_code_funds%TYPE DEFAULT NULL,
                   p_aidy_code_efc   rprbbay.rprbbay_aidy_code_efc%TYPE DEFAULT NULL,
                   p_data_origin     rprbbay.rprbbay_data_origin%TYPE DEFAULT NULL)

Creates a record.
 
The following are the minumum parameters to create an Applicant Borrower-Based Academic Year entry:
     P_PIDM
     P_BBAY_CODE
 
The procedure will:
     Create an entry in the Applicant Borrower-Based Academic Year (RPRBBAY) Table
     If necessary, populate the following in the Applicant Award Schedule (RPRATRM) Table for each period
     belonging to the Borrower-Based Academic Year.
          RPRATRM_BBAY_CODE
          RPRATRM_AIDY_CODE_FUNDS
 
If the BBAY will not be split between aid years when the BBAY spans across different aid years
     The aid year of the EFC to be used for determining need must be defined (P_AIDY_CODE_EFC).
     The aid year for the funds to be attributed to must be defined (P_AIDY_CODE_FUNDS).
 
If the BBAY will be split between aid years when the BBAY spans across different aid years
     The aid year of the EFC to be used for determining need may be defined (P_AIDY_CODE_EFC).
     The aid year for the funds cannot be defined(P_AIDY_CODE_FUNDS).

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_bbay_code   The Borrower-Based Academic Year associated with applicant. VARCHAR2(15) Required Key
p_bbtp_code   The code to define the type of Borrower-Based Academic Year. VARCHAR2(10) Required
p_budg_dur   The number of months to be used as the budget duration for the Borrower-Based Academic Year. NUMBER(2) Required
p_bbay_algo_code   The algorithmic rule code used to calculate the Borrower-Based Academic Year code. VARCHAR2(30)
p_bbay_seq_no   The sequence number of the rule code used to calculate the Borrower-Based Academic Year code. NUMBER(5)
p_aidy_code_funds   The aid year associated with the Borrower-Based Academic Year for origination and funding. VARCHAR2(4)
p_aidy_code_efc   The aid year associated with the EFC for the Borrower-Based Academic Year. VARCHAR2(4)
p_data_origin   The latest source for the data contained in this record. VARCHAR2(30)

p_delete 

Procedure p_delete(p_pidm      rprbbay.rprbbay_pidm%TYPE,
                   p_bbay_code rprbbay.rprbbay_bbay_code%TYPE)

Deletes a record.
 
The procedure will:
     Delete the entry in the Applicant Borrower-Based Academic Year (RPRBBAY) Table
     If necessary, update the Applicant Award Schedule (RPRATRM) Table for each period
     belonging to the Borrower-Based Academic Year to remove the associated BBAY Code.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_bbay_code   The Borrower-Based Academic Year associated with applicant. VARCHAR2(15) Required Key

p_update 

Procedure p_update(p_pidm            rprbbay.rprbbay_pidm%TYPE,
                   p_bbay_code       rprbbay.rprbbay_bbay_code%TYPE,
                   p_bbtp_code       rprbbay.rprbbay_bbtp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_budg_dur        rprbbay.rprbbay_budg_dur%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_bbay_algo_code  rprbbay.rprbbay_bbay_algo_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bbay_seq_no     rprbbay.rprbbay_bbay_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_aidy_code_funds rprbbay.rprbbay_aidy_code_funds%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_aidy_code_efc   rprbbay.rprbbay_aidy_code_efc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin     rprbbay.rprbbay_data_origin%TYPE DEFAULT dml_common.f_unspecified_string)

Updates a record.
 
If the BBAY will not be split between aid years when the BBAY spans across different aid years
     The aid year of the EFC to be used for determining need must be defined (P_AIDY_CODE_EFC).
     The aid year for the funds to be attributed to must be defined (P_AIDY_CODE_FUNDS).
 
If the BBAY will be split between aid years when the BBAY spans across different aid years
     The aid year of the EFC to be used for determining need may be defined (P_AIDY_CODE_EFC).
     The aid year for the funds cannot be defined (P_AIDY_CODE_FUNDS).

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_bbay_code   The Borrower-Based Academic Year associated with applicant. VARCHAR2(15) Required Key
p_bbtp_code   The code to define the type of Borrower-Based Academic Year. VARCHAR2(10) Required
p_budg_dur   The number of months to be used as the budget duration for the Borrower-Based Academic Year. NUMBER(2) Required
p_bbay_algo_code   The algorithmic rule code used to calculate the Borrower-Based Academic Year code. VARCHAR2(30)
p_bbay_seq_no   The sequence number of the rule code used to calculate the Borrower-Based Academic Year code. NUMBER(5)
p_aidy_code_funds   The aid year associated with the Borrower-Based Academic Year for origination and funding. VARCHAR2(4)
p_aidy_code_efc   The aid year associated with the EFC for the Borrower-Based Academic Year. VARCHAR2(4)
p_data_origin   The latest source for the data contained in this record. VARCHAR2(30)