f_api_version
Function f_api_version RETURN PLS_INTEGER
Returns the API version number.
|
Version of the API signature. Changes only when the signature changes.
|
f_exists
Function f_exists(p_pidm rprawrd.rprawrd_pidm%TYPE,
p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
RETURN VARCHAR2
Checks if a record exists.
|
p_pidm
|
The internal system generated student identification number. NUMBER(8) Required Key
|
|
p_aidy_code
|
The aid year associated with the award. VARCHAR2(4) Required Key
|
|
p_fund_code
|
The fund code associated with the award. VARCHAR2(6) Required Key
|
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18)
|
f_query_all
Function f_query_all(p_pidm rprawrd.rprawrd_pidm%TYPE,
p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE)
RETURN rb_award.award_ref
Selects all records for the entity.
|
p_pidm
|
The internal system generated student identification number. NUMBER(8) Required Key
|
|
p_aidy_code
|
The aid year associated with the award. VARCHAR2(4) Required Key
|
|
p_fund_code
|
The fund code associated with the award. VARCHAR2(6)
|
|
A cursor variable that will fetch a set of records.
|
f_query_one
Function f_query_one(p_pidm rprawrd.rprawrd_pidm%TYPE,
p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE)
RETURN rb_award.award_ref
Selects one record using key.
|
p_pidm
|
The internal system generated student identification number. NUMBER(8) Required Key
|
|
p_aidy_code
|
The aid year associated with the award. VARCHAR2(4) Required Key
|
|
p_fund_code
|
The fund code associated with the award. VARCHAR2(6) Required Key
|
|
A cursor variable that will fetch exactly one record.
|
p_create
Procedure p_create(p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_pidm rprawrd.rprawrd_pidm%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE,
p_awst_code rprawrd.rprawrd_awst_code%TYPE DEFAULT NULL,
p_awst_date rprawrd.rprawrd_awst_date%TYPE DEFAULT NULL,
p_sys_ind rprawrd.rprawrd_sys_ind%TYPE DEFAULT NULL,
p_lock_ind rprawrd.rprawrd_lock_ind%TYPE DEFAULT NULL,
p_unmet_need_ovrde_ind rprawrd.rprawrd_unmet_need_ovrde_ind%TYPE DEFAULT NULL,
p_replace_tfc_ovrde_ind rprawrd.rprawrd_replace_tfc_ovrde_ind%TYPE DEFAULT NULL,
p_treq_ovrde_ind rprawrd.rprawrd_treq_ovrde_ind%TYPE DEFAULT NULL,
p_fed_limit_ovrde_ind rprawrd.rprawrd_fed_limit_ovrde_ind%TYPE DEFAULT NULL,
p_fund_limit_ovrde_ind rprawrd.rprawrd_fund_limit_ovrde_ind%TYPE DEFAULT NULL,
p_offer_exp_date rprawrd.rprawrd_offer_exp_date%TYPE DEFAULT NULL,
p_accept_amt rprawrd.rprawrd_accept_amt%TYPE DEFAULT NULL,
p_accept_date rprawrd.rprawrd_accept_date%TYPE DEFAULT NULL,
p_offer_amt rprawrd.rprawrd_offer_amt%TYPE,
p_offer_date rprawrd.rprawrd_offer_date%TYPE DEFAULT NULL,
p_info_access_ind rprawrd.rprawrd_info_access_ind%TYPE DEFAULT NULL,
p_override_yr_in_coll rprawrd.rprawrd_override_yr_in_coll%TYPE DEFAULT NULL,
p_data_origin rprawrd.rprawrd_data_origin%TYPE DEFAULT gb_common.data_origin,
p_override_no_pell rprawrd.rprawrd_override_no_pell%TYPE DEFAULT NULL,
p_override_fund_rule rprawrd.rprawrd_override_fund_rule%TYPE)
Creates an award.
Version 2 of the p_create procedure.
Includes the p_override_fund_rule parameter not found in Version 1.
The following are the minimum parameters required to create an award:
P_AIDY_CODE
P_PIDM
P_FUND_CODE
P_OFFER_AMT
Pell awards cannot be created using this procedure.
Pre-Banner awards cannot be created using this procedure.
This procedure will:
- If necessary, create an entry in the Applicant Status Table (RORSTAT).
- If necessary, create an entry in the Satisfactory Academic Progress Rules Table (RORSAPR).
- Create an entry in the Mail Table (GURMAIL) if a corresponding entry was created in the
Satisfactory Academic Progress Rules Table (RORSAPR).
- Create the award in the Applicant Award Table (RPRAWRD).
- If necessary, update the award letter indicator on the Applicant Status Table (RORSTAT).
- Create the award schedule in the Applicant Award Schedule Table (RPRATRM) if the auto schedule
indicator (RFRASPC_AUTO_SCHED_IND) = 'Y'.
- Create the disbursement schedule in the Applicant Award Disbursement Table (RPRADSB) for
each entry in the award schedule if the disburse indicator (RFRASPC_DISBURSE_IND) = 'S'
and the award is accepted.
- Update the totals for the fund on the Fund Aid Year Specific Data Table (RFRASPC).
- Create any tracking requirements associated with the fund in the Applicant
Requirements Table (RRRAREQ).
- Create any promissory note requirements associated with the fund in the Promissory
Note Requirement Table (RFRPROM) if the auto schedule indicator (RFRASPC_AUTO_SCHED_IND) = 'Y'
and the promissory note required indicator (RFRASPC_PROM_REQ_IND) = 'Y'.
- Create a manual loan application if the award is accepted, the create loan application indicator
(RPBLOPT_CREATE_APP_IND) = 'Y' and the loan process indicator (RFRASPC_LOAN_PROCESS_IND) = 'Y'.
|
p_aidy_code
|
The aid year associated with the award. VARCHAR2(4) Required Key
|
|
p_pidm
|
The internal system generated student identification number. NUMBER(8) Required Key
|
|
p_fund_code
|
The fund code associated with the award. VARCHAR2(6) Required Key
|
|
p_awst_code
|
The code associated with the current status of the award. VARCHAR2(4) Required
|
|
p_awst_date
|
The date the award status was effective. DATE Required
|
|
p_sys_ind
|
Indicates how the award was created or updated. VARCHAR2(1) Required
|
|
p_lock_ind
|
Indicates if the award has been locked. No changes can occur to a locked fund. VARCHAR2(1) Required
|
|
p_unmet_need_ovrde_ind
|
Indicates if the unmet need validation rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_replace_tfc_ovrde_ind
|
Indicates if the replace EFC validation rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_treq_ovrde_ind
|
Indicates if the fund-specific tracking requirement validation rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_fed_limit_ovrde_ind
|
Indicates if the federal limits rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_fund_limit_ovrde_ind
|
Indicates if the fund limits rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_offer_exp_date
|
The expiration date of the award offer. DATE
|
|
p_accept_amt
|
The accepted dollar amount of the award. NUMBER(11,2)
|
|
p_accept_date
|
The date the award was accepted. DATE
|
|
p_offer_amt
|
The offered dollar amount of the award. NUMBER(11,2)
|
|
p_offer_date
|
The date the award was offered. DATE
|
|
p_info_access_ind
|
Indicates if the award may be accessed via web processing and similar methods. VARCHAR2(1)
|
|
p_override_yr_in_coll
|
Indicates the academic year to use for ACG and SMART Grant eligibility. VARCHAR2(1) Required
|
|
p_data_origin
|
Source system that created or updated the data. VARCHAR2(30)
|
|
p_override_no_pell
|
Indicates if the Pell award validation rule has been overridden for the ACG or SMART grant award. VARCHAR2(1) Required
|
|
p_override_fund_rule
|
Indicates whether the fund awarding rule will be overridden when manually awarding a fund to the student. VARCHAR2(1) Required
|
|
p_rowid_out
|
Database ROWID of the record to be created. VARCHAR2(18) Required
|
p_create
Procedure p_create(p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_pidm rprawrd.rprawrd_pidm%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE,
p_awst_code rprawrd.rprawrd_awst_code%TYPE DEFAULT NULL,
p_awst_date rprawrd.rprawrd_awst_date%TYPE DEFAULT NULL,
p_sys_ind rprawrd.rprawrd_sys_ind%TYPE DEFAULT NULL,
p_lock_ind rprawrd.rprawrd_lock_ind%TYPE DEFAULT NULL,
p_unmet_need_ovrde_ind rprawrd.rprawrd_unmet_need_ovrde_ind%TYPE DEFAULT NULL,
p_replace_tfc_ovrde_ind rprawrd.rprawrd_replace_tfc_ovrde_ind%TYPE DEFAULT NULL,
p_treq_ovrde_ind rprawrd.rprawrd_treq_ovrde_ind%TYPE DEFAULT NULL,
p_fed_limit_ovrde_ind rprawrd.rprawrd_fed_limit_ovrde_ind%TYPE DEFAULT NULL,
p_fund_limit_ovrde_ind rprawrd.rprawrd_fund_limit_ovrde_ind%TYPE DEFAULT NULL,
p_offer_exp_date rprawrd.rprawrd_offer_exp_date%TYPE DEFAULT NULL,
p_accept_amt rprawrd.rprawrd_accept_amt%TYPE DEFAULT NULL,
p_accept_date rprawrd.rprawrd_accept_date%TYPE DEFAULT NULL,
p_offer_amt rprawrd.rprawrd_offer_amt%TYPE,
p_offer_date rprawrd.rprawrd_offer_date%TYPE DEFAULT NULL,
p_info_access_ind rprawrd.rprawrd_info_access_ind%TYPE DEFAULT NULL,
p_override_yr_in_coll rprawrd.rprawrd_override_yr_in_coll%TYPE DEFAULT NULL,
p_data_origin rprawrd.rprawrd_data_origin%TYPE DEFAULT gb_common.data_origin,
p_override_no_pell rprawrd.rprawrd_override_no_pell%TYPE DEFAULT NULL)
Creates an award.
Version 1 of the p_create procedure.
For additional information, see Version 2 of the p_create procedure.
p_delete
Procedure p_delete(p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_pidm rprawrd.rprawrd_pidm%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE)
Deletes an award.
Pell awards cannot be deleted using this procedure if the offer amount is not zero.
Pre-Banner awards cannot be deleted using this procedure.
This procedure will:
- Delete the award from the Applicant Award Table (RPRAWRD).
- Delete the award schedule from the Applicant Award Schedule Table (RPRATRM).
- Delete the disbursement schedule from the Applicant Award Disbursement Table (RPRADSB).
- Update the totals for the fund on the Fund Aid Year Specific Data Table (RFRASPC).
- Delete any unsatisfied tracking requirements associated with the fund from the Applicant
Requirements Table (RRRAREQ).
- Delete any unsatisfied promissory note requirements associated with the fund from the Promissory
Note Requirement Table (RFRPROM).
NOTE: The award to be deleted must be found using the parameter values supplied.
|
p_pidm
|
The internal system generated student identification number. NUMBER(8) Required Key
|
|
p_aidy_code
|
The aid year associated with the award. VARCHAR2(4) Required Key
|
|
p_fund_code
|
The fund code associated with the award. VARCHAR2(6) Required Key
|
|
p_rowid
|
Database ROWID of the record to be deleted. VARCHAR2(18)
|
p_reschedule
Procedure p_reschedule(p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_pidm rprawrd.rprawrd_pidm%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE)
Reschedules an award.
This procedure will:
- Update the award schedule in the Applicant Award Schedule Table (RPRATRM).
- Update the disbursement schedule in the Applicant Award Disbursement Table (RPRADSB) if the
disburse indicator = 'S', the disbursement final indicator (RPRATRM_DISB_FINAL_IND) = 'N'
and the period has not had payments, memos or authorizations.
Awards with mixed statuses will not be rescheduled. For example, if Fall is accepted and Spring is Offered, the award cannot be rescheduled.
|
p_pidm
|
The internal system generated student identification number. NUMBER(8) Required Key
|
|
p_aidy_code
|
The aid year associated with the award. VARCHAR2(4) Required Key
|
|
p_fund_code
|
The fund code associated with the award. VARCHAR2(6) Required Key
|
p_update
Procedure p_update(p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_pidm rprawrd.rprawrd_pidm%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE,
p_awst_code rprawrd.rprawrd_awst_code%TYPE DEFAULT dml_common.f_unspecified_string,
p_awst_date rprawrd.rprawrd_awst_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_sys_ind rprawrd.rprawrd_sys_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_lock_ind rprawrd.rprawrd_lock_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_unmet_need_ovrde_ind rprawrd.rprawrd_unmet_need_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_replace_tfc_ovrde_ind rprawrd.rprawrd_replace_tfc_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_treq_ovrde_ind rprawrd.rprawrd_treq_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_fed_limit_ovrde_ind rprawrd.rprawrd_fed_limit_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_fund_limit_ovrde_ind rprawrd.rprawrd_fund_limit_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_offer_exp_date rprawrd.rprawrd_offer_exp_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_accept_amt rprawrd.rprawrd_accept_amt%TYPE DEFAULT dml_common.f_unspecified_number,
p_accept_date rprawrd.rprawrd_accept_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_offer_amt rprawrd.rprawrd_offer_amt%TYPE DEFAULT dml_common.f_unspecified_number,
p_offer_date rprawrd.rprawrd_offer_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_info_access_ind rprawrd.rprawrd_info_access_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_last_web_update rprawrd.rprawrd_last_web_update%TYPE DEFAULT dml_common.f_unspecified_date,
p_override_yr_in_coll rprawrd.rprawrd_override_yr_in_coll%TYPE DEFAULT dml_common.f_unspecified_string,
p_data_origin rprawrd.rprawrd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
p_override_no_pell rprawrd.rprawrd_override_no_pell%TYPE DEFAULT dml_common.f_unspecified_string,
p_override_fund_rule rprawrd.rprawrd_override_fund_rule%TYPE)
Updates an award.
Version 2 of the p_update procedure.
Includes the p_override_fund_rule parameter not found in Version 1.
Pre-Banner awards cannot be updated using this procedure.
This procedure will:
- Update the award in the Applicant Award Table (RPRAWRD).
- Update the totals for the fund on the Fund Aid Year Specific Data Table (RFRASPC).
- If the award is cancelled,
- Update the award schedule in the Applicant Award Schedule Table (RPRATRM).
- Update the disbursement schedule in the Applicant Award Disbursement Table (RPRADSB) if the
disburse indicator = 'S', the disbursement final indicator (RPRATRM_DISB_FINAL_IND) = 'N'
and the term has not had payments, memos or authorizations.
- Delete any unsatisfied tracking requirements associated with the fund from the Applicant
Requirements Table (RRRAREQ).
- Delete any unsatisfied promissory note requirements associated with the fund from the Promissory
Note Requirement Table (RFRPROM).
- If the award is declined,
- Update the award schedule in the Applicant Award Schedule Table (RPRATRM).
- Update the disbursement schedule in the Applicant Award Disbursement Table (RPRADSB) if the
disburse indicator = 'S', the disbursement final indicator (RPRATRM_DISB_FINAL_IND) = 'N'
and the term has not had payments, memos or authorizations.
- Delete any unsatisfied tracking requirements associated with the fund from the Applicant
Requirements Table (RRRAREQ).
- Delete any unsatisfied promissory note requirements associated with the fund from the Promissory
Note Requirement Table (RFRPROM).
- If the award is offered,
- Update the award schedule in the Applicant Award Schedule Table (RPRATRM).
- Update the disbursement schedule in the Applicant Award Disbursement Table (RPRADSB) if the
disburse indicator = 'S', the disbursement final indicator (RPRATRM_DISB_FINAL_IND) = 'N'
and the term has not had payments, memos or authorizations.
- Create any tracking requirements associated with the fund in the Applicant
Requirements Table (RRRAREQ).
- Delete any unsatisfied promissory note requirements associated with the fund from the Promissory
Note Requirement Table (RFRPROM).
- If the award is accepted,
- Update the award schedule in the Applicant Award Schedule Table (RPRATRM).
- Update the disbursement schedule in the Applicant Award Disbursement Table (RPRADSB) if the
disburse indicator = 'S', the disbursement final indicator (RPRATRM_DISB_FINAL_IND) = 'N'
and the term has not had payments, memos or authorizations.
- Create any tracking requirements associated with the fund in the Applicant
Requirements Table (RRRAREQ).
- Update any promissory note requirements associated with the fund in the Promissory
Note Requirement Table (RFRPROM).
If the award is locked, the award status can be updated if the Award Status Updates When Locked Indicator is checked (ROBINST_UPD_LOCKED_AWARD_IND = 'Y'). Only the award status can be updated, the amount of the award cannot be updated.
The following parameters cannot be updated for awards with mixed statuses (Fall is Accepted and Spring is Offered),
p_awst_code
p_awst_date
p_accept_amt
p_accept_date
p_offer_amt
p_offer_date
|
p_aidy_code
|
The aid year associated with the award. VARCHAR2(4) Required Key
|
|
p_pidm
|
The internal system generated student identification number. NUMBER(8) Required Key
|
|
p_fund_code
|
The fund code associated with the award. VARCHAR2(6) Required Key
|
|
p_awst_code
|
The code associated with the current status of the award. VARCHAR2(4) Required
|
|
p_awst_date
|
The date the award status was effective. DATE Required
|
|
p_sys_ind
|
Indicates how the award was created or updated. VARCHAR2(1) Required
|
|
p_lock_ind
|
Indicates if the award has been locked. No changes can occur to a locked fund. VARCHAR2(1) Required
|
|
p_unmet_need_ovrde_ind
|
Indicates if the unmet need validation rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_replace_tfc_ovrde_ind
|
Indicates if the replace EFC validation rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_treq_ovrde_ind
|
Indicates if the fund-specific tracking requirement validation rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_fed_limit_ovrde_ind
|
Indicates if the federal limits rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_fund_limit_ovrde_ind
|
Indicates if the fund limits rule has been overridden for the award. VARCHAR2(1) Required
|
|
p_offer_exp_date
|
The expiration date of the award offer. DATE
|
|
p_accept_amt
|
The accepted dollar amount of the award. NUMBER(11,2)
|
|
p_accept_date
|
The date the award was accepted. DATE
|
|
p_offer_amt
|
The offered dollar amount of the award. NUMBER(11,2)
|
|
p_offer_date
|
The date the award was offered. DATE
|
|
p_info_access_ind
|
Indicates if the award may be accessed via web processing and similar methods. VARCHAR2(1)
|
|
p_last_web_update
|
The date the award was last updated by web activity. DATE
|
|
p_override_yr_in_coll
|
Indicates the academic year to use for ACG and SMART Grant eligibility. VARCHAR2(1) Required
|
|
p_data_origin
|
Source system that created or updated the data. VARCHAR2(30)
|
|
p_override_no_pell
|
Indicates if the Pell award validation rule has been overridden for the ACG or SMART grant award. VARCHAR2(1) Required
|
|
p_override_fund_rule
|
Indicates whether the fund awarding rule will be overriden when manually awarding a fund to the student. VARCHAR2(1) Required
|
|
p_rowid
|
Database ROWID of the record to be updated. VARCHAR2(18)
|
p_update
Procedure p_update(p_aidy_code rprawrd.rprawrd_aidy_code%TYPE,
p_pidm rprawrd.rprawrd_pidm%TYPE,
p_fund_code rprawrd.rprawrd_fund_code%TYPE,
p_awst_code rprawrd.rprawrd_awst_code%TYPE DEFAULT dml_common.f_unspecified_string,
p_awst_date rprawrd.rprawrd_awst_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_sys_ind rprawrd.rprawrd_sys_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_lock_ind rprawrd.rprawrd_lock_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_unmet_need_ovrde_ind rprawrd.rprawrd_unmet_need_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_replace_tfc_ovrde_ind rprawrd.rprawrd_replace_tfc_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_treq_ovrde_ind rprawrd.rprawrd_treq_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_fed_limit_ovrde_ind rprawrd.rprawrd_fed_limit_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_fund_limit_ovrde_ind rprawrd.rprawrd_fund_limit_ovrde_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_offer_exp_date rprawrd.rprawrd_offer_exp_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_accept_amt rprawrd.rprawrd_accept_amt%TYPE DEFAULT dml_common.f_unspecified_number,
p_accept_date rprawrd.rprawrd_accept_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_offer_amt rprawrd.rprawrd_offer_amt%TYPE DEFAULT dml_common.f_unspecified_number,
p_offer_date rprawrd.rprawrd_offer_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_info_access_ind rprawrd.rprawrd_info_access_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_last_web_update rprawrd.rprawrd_last_web_update%TYPE DEFAULT dml_common.f_unspecified_date,
p_override_yr_in_coll rprawrd.rprawrd_override_yr_in_coll%TYPE DEFAULT dml_common.f_unspecified_string,
p_data_origin rprawrd.rprawrd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
p_override_no_pell rprawrd.rprawrd_override_no_pell%TYPE DEFAULT dml_common.f_unspecified_string)
Updates an award.
Version 1 of the p_update procedure.
For additional information, see Version 2 of the p_update procedure.