|
Package sb_gradapp_displayrule
This package provides the Common Business interface for the Graduation Application Display Rule API (sb_gradapp_displayrule).
Graduation application display rules determine how the self-service graduation application will be displayed to the learner. The rule includes settings such as which pages to display to the learner, what data is displayed and possibly updateable, and what happens when the graduation application is submitted.
Select rules are defined so the system can determine which display rule to use when a learner applies via self-service to graduate. The institution assigns a unique process order number to each select rule. When a learner applies via self-service to graduate, the select rules are examined in process order sequence, and the display rule from the first select rule that is considered passing will be the display rule used for the learner.
|
M_ENTITY_NAME
M_ENTITY_NAME CONSTANT VARCHAR2(19) := 'GRADAPP_DISPLAYRULE';
Business Entity Name
M_BASE_TABLE_NAME
M_BASE_TABLE_NAME CONSTANT VARCHAR2(7) := 'SHBGADR';
Base table name
gradapp_displayrule_rec
TYPE gradapp_displayrule_rec IS RECORD (
r_code shbgadr.shbgadr_code%TYPE,
r_tprt_code shbgadr.shbgadr_tprt_code%TYPE,
r_grad_date_disp_ind shbgadr.shbgadr_grad_date_disp_ind%TYPE,
r_grad_term_disp_ind shbgadr.shbgadr_grad_term_disp_ind%TYPE,
r_grad_year_disp_ind shbgadr.shbgadr_grad_year_disp_ind%TYPE,
r_gast_code shbgadr.shbgadr_gast_code%TYPE,
r_dgmr_upd_ind shbgadr.shbgadr_dgmr_upd_ind%TYPE,
r_disp_dipl_name_web_ind shbgadr.shbgadr_disp_dipl_name_web_ind%TYPE,
r_disp_name_cde shbgadr.shbgadr_disp_name_cde%TYPE,
r_disp_middle_cde shbgadr.shbgadr_disp_middle_cde%TYPE,
r_disp_suffix_ind shbgadr.shbgadr_disp_suffix_ind%TYPE,
r_disp_dipl_name_ind shbgadr.shbgadr_disp_dipl_name_ind%TYPE,
r_disp_dipl_upd_name_ind shbgadr.shbgadr_disp_dipl_upd_name_ind%TYPE,
r_disp_upd_first_ind shbgadr.shbgadr_disp_upd_first_ind%TYPE,
r_disp_upd_middle_ind shbgadr.shbgadr_disp_upd_middle_ind%TYPE,
r_disp_upd_last_ind shbgadr.shbgadr_disp_upd_last_ind%TYPE,
r_disp_upd_suffix_ind shbgadr.shbgadr_disp_upd_suffix_ind%TYPE,
r_disp_dipl_addr_web_ind shbgadr.shbgadr_disp_dipl_addr_web_ind%TYPE,
r_disp_dipl_addr_ind shbgadr.shbgadr_disp_dipl_addr_ind%TYPE,
r_disp_dipl_upd_addr_ind shbgadr.shbgadr_disp_dipl_upd_addr_ind%TYPE,
r_charge_ind shbgadr.shbgadr_charge_ind%TYPE,
r_user_id shbgadr.shbgadr_user_id%TYPE,
r_letr_code shbgadr.shbgadr_letr_code%TYPE,
r_disp_name_ntyp_code shbgadr.shbgadr_disp_name_ntyp_code%TYPE,
r_dgmr_upd_grst_code shbgadr.shbgadr_dgmr_upd_grst_code%TYPE,
r_data_origin shbgadr.shbgadr_data_origin%TYPE,
r_internal_record_id gb_common.internal_record_id_type);
Business Entity record type
gradapp_displayrule_ref
TYPE gradapp_displayrule_ref IS REF CURSOR RETURN gradapp_displayrule_rec;
Entity cursor variable type
gradapp_displayrule_tab
TYPE gradapp_displayrule_tab IS TABLE OF gradapp_displayrule_rec INDEX BY BINARY_INTEGER;
Entity table type
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_code shbgadr.shbgadr_code%TYPE,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
RETURN VARCHAR2
Checks if a record exists.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18)
|
f_isequal
Function f_isequal(rec_one gradapp_displayrule_rec,
rec_two gradapp_displayrule_rec) RETURN VARCHAR2
Compares two records for equality.
Tests each field of rec_one against the corresponding field of rec_two. Two null values are considered equal.
|
|
Y if all values in records are equal, otherwise N. Nulls match Nulls.
|
f_query_all
Function f_query_all(p_code shbgadr.shbgadr_code%TYPE DEFAULT NULL,
p_tprt_code shbgadr.shbgadr_tprt_code%TYPE DEFAULT NULL,
p_grad_date_disp_ind shbgadr.shbgadr_grad_date_disp_ind%TYPE DEFAULT NULL,
p_grad_term_disp_ind shbgadr.shbgadr_grad_term_disp_ind%TYPE DEFAULT NULL,
p_grad_year_disp_ind shbgadr.shbgadr_grad_year_disp_ind%TYPE DEFAULT NULL,
p_gast_code shbgadr.shbgadr_gast_code%TYPE DEFAULT NULL,
p_letr_code shbgadr.shbgadr_letr_code%TYPE DEFAULT NULL)
RETURN gradapp_displayrule_ref
Selects all records for the entity.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
p_tprt_code
|
Transcript verification type to use for graduation application self-service display rules. VARCHAR2(4) Required
|
|
|
p_grad_date_disp_ind
|
Indicator for whether graduation dates will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_grad_term_disp_ind
|
Indicator for whether graduation terms will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_grad_year_disp_ind
|
Indicator for whether graduation years will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_gast_code
|
Status code for the graduation application when it is submitted. VARCHAR2(4) Required
|
|
|
p_letr_code
|
Code for the confirmation letter that will be displayed at the end of the self-service graduation application process. VARCHAR2(15)
|
|
|
A cursor variable that will fetch a set of records.
|
f_query_one
Function f_query_one(p_code shbgadr.shbgadr_code%TYPE)
RETURN gradapp_displayrule_ref
Selects one record using the key.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
A cursor variable that will fetch exactly one record.
|
f_query_by_rowid
Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
RETURN gradapp_displayrule_ref
Selects one record using the ROWID.
|
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18) Required
|
|
|
A cursor variable that will fetch exactly one record.
|
f_query_one_lock
Function f_query_one_lock(p_code shbgadr.shbgadr_code%TYPE,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
RETURN gradapp_displayrule_ref
Selects one record and locks it.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18)
|
|
|
A cursor variable for one record, locking the record.
|
p_create
Procedure p_create(p_code shbgadr.shbgadr_code%TYPE,
p_tprt_code shbgadr.shbgadr_tprt_code%TYPE,
p_grad_date_disp_ind shbgadr.shbgadr_grad_date_disp_ind%TYPE,
p_grad_term_disp_ind shbgadr.shbgadr_grad_term_disp_ind%TYPE,
p_grad_year_disp_ind shbgadr.shbgadr_grad_year_disp_ind%TYPE,
p_gast_code shbgadr.shbgadr_gast_code%TYPE,
p_dgmr_upd_ind shbgadr.shbgadr_dgmr_upd_ind%TYPE,
p_disp_dipl_name_web_ind shbgadr.shbgadr_disp_dipl_name_web_ind%TYPE,
p_disp_name_cde shbgadr.shbgadr_disp_name_cde%TYPE,
p_disp_middle_cde shbgadr.shbgadr_disp_middle_cde%TYPE,
p_disp_suffix_ind shbgadr.shbgadr_disp_suffix_ind%TYPE,
p_disp_dipl_name_ind shbgadr.shbgadr_disp_dipl_name_ind%TYPE,
p_disp_dipl_upd_name_ind shbgadr.shbgadr_disp_dipl_upd_name_ind%TYPE,
p_disp_upd_first_ind shbgadr.shbgadr_disp_upd_first_ind%TYPE,
p_disp_upd_middle_ind shbgadr.shbgadr_disp_upd_middle_ind%TYPE,
p_disp_upd_last_ind shbgadr.shbgadr_disp_upd_last_ind%TYPE,
p_disp_upd_suffix_ind shbgadr.shbgadr_disp_upd_suffix_ind%TYPE,
p_disp_dipl_addr_web_ind shbgadr.shbgadr_disp_dipl_addr_web_ind%TYPE,
p_disp_dipl_addr_ind shbgadr.shbgadr_disp_dipl_addr_ind%TYPE,
p_disp_dipl_upd_addr_ind shbgadr.shbgadr_disp_dipl_upd_addr_ind%TYPE,
p_charge_ind shbgadr.shbgadr_charge_ind%TYPE,
p_user_id shbgadr.shbgadr_user_id%TYPE DEFAULT gb_common.f_sct_user,
p_letr_code shbgadr.shbgadr_letr_code%TYPE DEFAULT NULL,
p_disp_name_ntyp_code shbgadr.shbgadr_disp_name_ntyp_code%TYPE DEFAULT NULL,
p_dgmr_upd_grst_code shbgadr.shbgadr_dgmr_upd_grst_code%TYPE DEFAULT NULL,
p_data_origin shbgadr.shbgadr_data_origin%TYPE DEFAULT NULL,
p_rowid_out OUT gb_common.internal_record_id_type)
Creates a record.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
p_tprt_code
|
Transcript verification type to use for graduation application self-service display rules. VARCHAR2(4) Required
|
|
|
p_grad_date_disp_ind
|
Indicator for whether graduation dates will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_grad_term_disp_ind
|
Indicator for whether graduation terms will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_grad_year_disp_ind
|
Indicator for whether graduation years will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_gast_code
|
Status code for the graduation application when it is submitted. VARCHAR2(4) Required
|
|
|
p_dgmr_upd_ind
|
Indicator for whether the SHRDGMR table will be impacted when the graduation application is submitted. VARCHAR2(1) Required
|
|
|
p_disp_dipl_name_web_ind
|
Indicator for whether the diploma name page will be displayed for self-service graduation applications. VARCHAR2(1) Required
|
|
|
p_disp_name_cde
|
Indicator for which name is to be displayed on the self-service graduation application diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_middle_cde
|
Indicates the format to use when displaying middle name information on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_suffix_ind
|
Indicator for whether the name suffix information will be displayed on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_name_ind
|
Indicator for whether the diploma name will be displayed on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_upd_name_ind
|
Indicator for whether the learner may provide a diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_first_ind
|
Indicator for whether the learner may update the first name used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_middle_ind
|
Indicator for whether the learner may update the middle name used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_last_ind
|
Indicator for whether the learner may update the last name used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_suffix_ind
|
Indicator for whether the learner may update the suffix used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_addr_web_ind
|
Indicator for whether the diploma mailing address will be displayed self-service page displays for self-service graduation applications. VARCHAR2(1) Required
|
|
|
p_disp_dipl_addr_ind
|
Indicator for whether the diploma mailing address will be displayed on the graduation application self-service diploma mailing address page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_upd_addr_ind
|
Indicator for whether the diploma mailing address information may be updated. VARCHAR2(1) Required
|
|
|
p_charge_ind
|
Indicator for whether a charge will apply when the graduation application is submitted. VARCHAR2(1) Required
|
|
|
p_user_id
|
ID of the most recent user to create or update the row in the SHBGADR table. VARCHAR2(30) Required
|
|
|
p_letr_code
|
Code for the confirmation letter that will be displayed at the end of the self-service graduation application process. VARCHAR2(15)
|
|
|
p_disp_name_ntyp_code
|
Indicates which alternate name should be displayed on the graduation application self-service diploma name page. VARCHAR2(4)
|
|
|
p_dgmr_upd_grst_code
|
Graduation status code to use if the SHRDGMR graduation status will be impacted when the graduation application is submitted. VARCHAR2(3)
|
|
|
p_data_origin
|
Value of the source system that inserted or updated the row. VARCHAR2(30)
|
|
|
p_rowid_out
|
Database ROWID of the record to be created. VARCHAR2(18) Required
|
p_delete
Procedure p_delete(p_code shbgadr.shbgadr_code%TYPE,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
Deletes a record.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
p_rowid
|
Database ROWID of the record to be deleted. VARCHAR2(18)
|
p_lock
Procedure p_lock(p_code shbgadr.shbgadr_code%TYPE,
p_rowid_inout IN OUT gb_common.internal_record_id_type)
Locks a record.
If the ROWID is not passed in, the record is located using the key values and the ROWID of the locked row is passed in p_rowid_inout.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
p_rowid_inout
|
Database ROWID of the record to be locked. VARCHAR2(18) Required
|
p_update
Procedure p_update(p_code shbgadr.shbgadr_code%TYPE,
p_tprt_code shbgadr.shbgadr_tprt_code%TYPE DEFAULT dml_common.f_unspecified_string,
p_grad_date_disp_ind shbgadr.shbgadr_grad_date_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_grad_term_disp_ind shbgadr.shbgadr_grad_term_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_grad_year_disp_ind shbgadr.shbgadr_grad_year_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_gast_code shbgadr.shbgadr_gast_code%TYPE DEFAULT dml_common.f_unspecified_string,
p_dgmr_upd_ind shbgadr.shbgadr_dgmr_upd_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_dipl_name_web_ind shbgadr.shbgadr_disp_dipl_name_web_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_name_cde shbgadr.shbgadr_disp_name_cde%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_middle_cde shbgadr.shbgadr_disp_middle_cde%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_suffix_ind shbgadr.shbgadr_disp_suffix_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_dipl_name_ind shbgadr.shbgadr_disp_dipl_name_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_dipl_upd_name_ind shbgadr.shbgadr_disp_dipl_upd_name_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_upd_first_ind shbgadr.shbgadr_disp_upd_first_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_upd_middle_ind shbgadr.shbgadr_disp_upd_middle_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_upd_last_ind shbgadr.shbgadr_disp_upd_last_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_upd_suffix_ind shbgadr.shbgadr_disp_upd_suffix_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_dipl_addr_web_ind shbgadr.shbgadr_disp_dipl_addr_web_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_dipl_addr_ind shbgadr.shbgadr_disp_dipl_addr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_dipl_upd_addr_ind shbgadr.shbgadr_disp_dipl_upd_addr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_charge_ind shbgadr.shbgadr_charge_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_user_id shbgadr.shbgadr_user_id%TYPE DEFAULT gb_common.f_sct_user,
p_letr_code shbgadr.shbgadr_letr_code%TYPE DEFAULT dml_common.f_unspecified_string,
p_disp_name_ntyp_code shbgadr.shbgadr_disp_name_ntyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
p_dgmr_upd_grst_code shbgadr.shbgadr_dgmr_upd_grst_code%TYPE DEFAULT dml_common.f_unspecified_string,
p_data_origin shbgadr.shbgadr_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
Updates a record.
|
|
p_code
|
Display rule code for the graduation application. VARCHAR2(15) Required Key
|
|
|
p_tprt_code
|
Transcript verification type to use for graduation application self-service display rules. VARCHAR2(4) Required
|
|
|
p_grad_date_disp_ind
|
Indicator for whether graduation dates will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_grad_term_disp_ind
|
Indicator for whether graduation terms will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_grad_year_disp_ind
|
Indicator for whether graduation years will be displayed on the self-service graduation application. VARCHAR2(1) Required
|
|
|
p_gast_code
|
Status code for the graduation application when it is submitted. VARCHAR2(4) Required
|
|
|
p_dgmr_upd_ind
|
Indicator for whether the SHRDGMR table will be impacted when the graduation application is submitted. VARCHAR2(1) Required
|
|
|
p_disp_dipl_name_web_ind
|
Indicator for whether the diploma name page will be displayed for self-service graduation applications. VARCHAR2(1) Required
|
|
|
p_disp_name_cde
|
Indicator for which name is to be displayed on the self-service graduation application diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_middle_cde
|
Indicates the format to use when displaying middle name information on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_suffix_ind
|
Indicator for whether the name suffix information will be displayed on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_name_ind
|
Indicator for whether the diploma name will be displayed on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_upd_name_ind
|
Indicator for whether the learner may provide a diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_first_ind
|
Indicator for whether the learner may update the first name used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_middle_ind
|
Indicator for whether the learner may update the middle name used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_last_ind
|
Indicator for whether the learner may update the last name used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_upd_suffix_ind
|
Indicator for whether the learner may update the suffix used for the diploma name on the graduation application self-service diploma name page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_addr_web_ind
|
Indicator for whether the diploma mailing address will be displayed self-service page displays for self-service graduation applications. VARCHAR2(1) Required
|
|
|
p_disp_dipl_addr_ind
|
Indicator for whether the diploma mailing address will be displayed on the graduation application self-service diploma mailing address page. VARCHAR2(1) Required
|
|
|
p_disp_dipl_upd_addr_ind
|
Indicator for whether the diploma mailing address information may be updated. VARCHAR2(1) Required
|
|
|
p_charge_ind
|
Indicator for whether a charge will apply when the graduation application is submitted. VARCHAR2(1) Required
|
|
|
p_user_id
|
ID of the most recent user to create or update the row in the SHBGADR table. VARCHAR2(30) Required
|
|
|
p_letr_code
|
Code for the confirmation letter that will be displayed at the end of the self-service graduation application process. VARCHAR2(15)
|
|
|
p_disp_name_ntyp_code
|
Indicates which alternate name should be displayed on the graduation application self-service diploma name page. VARCHAR2(4)
|
|
|
p_dgmr_upd_grst_code
|
Graduation status code to use if the SHRDGMR graduation status will be impacted when the graduation application is submitted. VARCHAR2(3)
|
|
|
p_data_origin
|
Value of the source system that inserted or updated the row. VARCHAR2(30)
|
|
|
p_rowid
|
Database ROWID of the record to be updated. VARCHAR2(18)
|