Package sb_gradapp

This package provides the Common Business interface for the Graduation Application API (sb_gradapp).

Learners may apply to graduate via self-service or the institution may create a graduation application for the learner. The institution may also update and delete graduation applications.

Program units

f_api_version

f_exists

f_isactive

f_isequal

f_query_all

f_query_one

f_query_by_rowid

f_query_one_lock

p_create

p_delete

p_lock

p_update

Types

gradapp_rec

gradapp_ref

gradapp_tab

Constants

M_ENTITY_NAME

M_BASE_TABLE_NAME

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(7) := 'GRADAPP';

Business Entity Name

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'SHBGAPP';

Base table name

gradapp_rec

TYPE gradapp_rec IS RECORD (
  r_pidm                    shbgapp.shbgapp_pidm%TYPE,
  r_seqno                   shbgapp.shbgapp_seqno%TYPE,
  r_request_date            shbgapp.shbgapp_request_date%TYPE,
  r_gast_code               shbgapp.shbgapp_gast_code%TYPE,
  r_gast_date               shbgapp.shbgapp_gast_date%TYPE,
  r_user_id                 shbgapp.shbgapp_user_id%TYPE,
  r_gadr_code               shbgapp.shbgapp_gadr_code%TYPE,
  r_dgmr_upd_grst_code      shbgapp.shbgapp_dgmr_upd_grst_code%TYPE,
  r_grad_date               shbgapp.shbgapp_grad_date%TYPE,
  r_grad_term_code          shbgapp.shbgapp_grad_term_code%TYPE,
  r_grad_acyr_code          shbgapp.shbgapp_grad_acyr_code%TYPE,
  r_grad_attend_cde         shbgapp.shbgapp_grad_attend_cde%TYPE,
  r_last_name               shbgapp.shbgapp_last_name%TYPE,
  r_first_name              shbgapp.shbgapp_first_name%TYPE,
  r_mi                      shbgapp.shbgapp_mi%TYPE,
  r_name_suffix             shbgapp.shbgapp_name_suffix%TYPE,
  r_street1                 shbgapp.shbgapp_street1%TYPE,
  r_street2                 shbgapp.shbgapp_street2%TYPE,
  r_street3                 shbgapp.shbgapp_street3%TYPE,
  r_street4                 shbgapp.shbgapp_street4%TYPE,
  r_house_number            shbgapp.shbgapp_house_number%TYPE,
  r_city                    shbgapp.shbgapp_city%TYPE,
  r_stat_code               shbgapp.shbgapp_stat_code%TYPE,
  r_zip                     shbgapp.shbgapp_zip%TYPE,
  r_natn_code               shbgapp.shbgapp_natn_code%TYPE,
  r_term_code_detc          shbgapp.shbgapp_term_code_detc%TYPE,
  r_wpyo_code               shbgapp.shbgapp_wpyo_code%TYPE,
  r_detc_detail_code        shbgapp.shbgapp_detc_detail_code%TYPE,
  r_detc_desc               shbgapp.shbgapp_detc_desc%TYPE,
  r_chrg                    shbgapp.shbgapp_chrg%TYPE,
  r_fee_date                shbgapp.shbgapp_fee_date%TYPE,
  r_tran_number             shbgapp.shbgapp_tran_number%TYPE,
  r_wpyo_receipt_number     shbgapp.shbgapp_wpyo_receipt_number%TYPE,
  r_data_origin             shbgapp.shbgapp_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gradapp_ref

TYPE gradapp_ref IS REF CURSOR RETURN gradapp_rec;

Entity cursor variable type

gradapp_tab

TYPE gradapp_tab IS TABLE OF gradapp_rec INDEX BY BINARY_INTEGER;

Entity table type

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  shbgapp.shbgapp_pidm%TYPE,
                  p_seqno shbgapp.shbgapp_seqno%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_isactive

Function f_isactive(p_pidm  shbgapp.shbgapp_pidm%TYPE,
                    p_seqno shbgapp.shbgapp_seqno%TYPE) RETURN VARCHAR2

Tests to see if the graduation application is active.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key

Returns

Y is active, otherwise N.

f_isequal

Function f_isequal(rec_one gradapp_rec, rec_two gradapp_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.

Parameters

	rec_one	The first record to compare. Type gradapp_rec Required
	rec_two	The second record to compare. Type gradapp_rec Required

Returns

Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all

Function f_query_all(p_pidm               shbgapp.shbgapp_pidm%TYPE DEFAULT NULL,
                     p_seqno              shbgapp.shbgapp_seqno%TYPE DEFAULT NULL,
                     p_request_date       shbgapp.shbgapp_request_date%TYPE DEFAULT NULL,
                     p_gast_code          shbgapp.shbgapp_gast_code%TYPE DEFAULT NULL,
                     p_gast_date          shbgapp.shbgapp_gast_date%TYPE DEFAULT NULL,
                     p_gadr_code          shbgapp.shbgapp_gadr_code%TYPE DEFAULT NULL,
                     p_dgmr_upd_grst_code shbgapp.shbgapp_dgmr_upd_grst_code%TYPE DEFAULT NULL,
                     p_grad_date          shbgapp.shbgapp_grad_date%TYPE DEFAULT NULL,
                     p_grad_term_code     shbgapp.shbgapp_grad_term_code%TYPE DEFAULT NULL,
                     p_grad_acyr_code     shbgapp.shbgapp_grad_acyr_code%TYPE DEFAULT NULL,
                     p_grad_attend_cde    shbgapp.shbgapp_grad_attend_cde%TYPE DEFAULT NULL)
  RETURN gradapp_ref

Selects all records for the entity.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key
	p_request_date	Date the graduation application was submitted. DATE Required
	p_gast_code	Status code for the graduation application. VARCHAR2(4) Required
	p_gast_date	Date the graduation application status was last changed. DATE Required
	p_gadr_code	Display rule code in effect when the graduation application was submitted. VARCHAR2(15)
	p_dgmr_upd_grst_code	Graduation status code to use if the SHRDGMR graduation status will be impacted. VARCHAR2(3)
	p_grad_date	Requested graduation date. DATE
	p_grad_term_code	Requested graduation term code. VARCHAR2(6)
	p_grad_acyr_code	Requested graduation academic year. VARCHAR2(4)
	p_grad_attend_cde	Indicator for whether the learner plans to attend the graduation ceremony. VARCHAR2(1)

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm  shbgapp.shbgapp_pidm%TYPE,
                     p_seqno shbgapp.shbgapp_seqno%TYPE) RETURN gradapp_ref

Selects one record using the key.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key

Returns

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_ref

Selects one record using the ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

Function f_query_one_lock(p_pidm  shbgapp.shbgapp_pidm%TYPE,
                          p_seqno shbgapp.shbgapp_seqno%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gradapp_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

p_create

Procedure p_create(p_pidm                shbgapp.shbgapp_pidm%TYPE,
                   p_seqno               shbgapp.shbgapp_seqno%TYPE,
                   p_request_date        shbgapp.shbgapp_request_date%TYPE,
                   p_gast_code           shbgapp.shbgapp_gast_code%TYPE,
                   p_gast_date           shbgapp.shbgapp_gast_date%TYPE,
                   p_user_id             shbgapp.shbgapp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_gadr_code           shbgapp.shbgapp_gadr_code%TYPE DEFAULT NULL,
                   p_dgmr_upd_grst_code  shbgapp.shbgapp_dgmr_upd_grst_code%TYPE DEFAULT NULL,
                   p_grad_date           shbgapp.shbgapp_grad_date%TYPE DEFAULT NULL,
                   p_grad_term_code      shbgapp.shbgapp_grad_term_code%TYPE DEFAULT NULL,
                   p_grad_acyr_code      shbgapp.shbgapp_grad_acyr_code%TYPE DEFAULT NULL,
                   p_grad_attend_cde     shbgapp.shbgapp_grad_attend_cde%TYPE DEFAULT NULL,
                   p_last_name           shbgapp.shbgapp_last_name%TYPE DEFAULT NULL,
                   p_first_name          shbgapp.shbgapp_first_name%TYPE DEFAULT NULL,
                   p_mi                  shbgapp.shbgapp_mi%TYPE DEFAULT NULL,
                   p_name_suffix         shbgapp.shbgapp_name_suffix%TYPE DEFAULT NULL,
                   p_street1             shbgapp.shbgapp_street1%TYPE DEFAULT NULL,
                   p_street2             shbgapp.shbgapp_street2%TYPE DEFAULT NULL,
                   p_street3             shbgapp.shbgapp_street3%TYPE DEFAULT NULL,
                   p_street4             shbgapp.shbgapp_street4%TYPE DEFAULT NULL,
                   p_house_number        shbgapp.shbgapp_house_number%TYPE DEFAULT NULL,
                   p_city                shbgapp.shbgapp_city%TYPE DEFAULT NULL,
                   p_stat_code           shbgapp.shbgapp_stat_code%TYPE DEFAULT NULL,
                   p_zip                 shbgapp.shbgapp_zip%TYPE DEFAULT NULL,
                   p_natn_code           shbgapp.shbgapp_natn_code%TYPE DEFAULT NULL,
                   p_term_code_detc      shbgapp.shbgapp_term_code_detc%TYPE DEFAULT NULL,
                   p_wpyo_code           shbgapp.shbgapp_wpyo_code%TYPE DEFAULT NULL,
                   p_detc_detail_code    shbgapp.shbgapp_detc_detail_code%TYPE DEFAULT NULL,
                   p_detc_desc           shbgapp.shbgapp_detc_desc%TYPE DEFAULT NULL,
                   p_chrg                shbgapp.shbgapp_chrg%TYPE DEFAULT NULL,
                   p_fee_date            shbgapp.shbgapp_fee_date%TYPE DEFAULT NULL,
                   p_tran_number         shbgapp.shbgapp_tran_number%TYPE DEFAULT NULL,
                   p_wpyo_receipt_number shbgapp.shbgapp_wpyo_receipt_number%TYPE DEFAULT NULL,
                   p_data_origin         shbgapp.shbgapp_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out           OUT gb_common.internal_record_id_type,
                   p_seqno_out           OUT shbgapp.shbgapp_seqno%TYPE)

Creates a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key
	p_request_date	Date the graduation application was submitted. DATE Required
	p_gast_code	Status code for the graduation application. VARCHAR2(4) Required
	p_gast_date	Date the graduation application status was last changed. DATE Required
	p_user_id	ID of the most recent user to create or update the row in the SHBGAPP table. VARCHAR2(30) Required
	p_gadr_code	Display rule code in effect when the graduation application was submitted. VARCHAR2(15)
	p_dgmr_upd_grst_code	Graduation status code to use if the SHRDGMR graduation status will be impacted. VARCHAR2(3)
	p_grad_date	Requested graduation date. DATE
	p_grad_term_code	Requested graduation term code. VARCHAR2(6)
	p_grad_acyr_code	Requested graduation academic year. VARCHAR2(4)
	p_grad_attend_cde	Indicator for whether the learner plans to attend the graduation ceremony. VARCHAR2(1)
	p_last_name	Last name requested for printing on the diploma. VARCHAR2(60)
	p_first_name	First name requested for printing on the diploma. VARCHAR2(15)
	p_mi	Middle name requested for printing on the diploma. VARCHAR2(15)
	p_name_suffix	Name suffix requested for printing on the diploma. VARCHAR2(20)
	p_street1	Requested mailing address street line 1 for diploma. VARCHAR2(30)
	p_street2	Requested mailing address street line 2 for diploma. VARCHAR2(30)
	p_street3	Requested mailing address street line 3 for diploma. VARCHAR2(30)
	p_street4	Requested mailing address street line 4 for diploma. VARCHAR2(30)
	p_house_number	Requested mailing address house number for diploma. VARCHAR2(10)
	p_city	Requested mailing address city for diploma. VARCHAR2(20)
	p_stat_code	Requested mailing address state code for diploma. VARCHAR2(3)
	p_zip	Requested mailing address zip for diploma. VARCHAR2(10)
	p_natn_code	Requested mailing address nation code for diploma. VARCHAR2(5)
	p_term_code_detc	Detail code to use for the billing. VARCHAR2(6)
	p_wpyo_code	Code of the payment option of the request. VARCHAR2(4)
	p_detc_detail_code	Charge detail code to be placed on the student's account in billing for submitting a graduation application. VARCHAR2(4)
	p_detc_desc	Description of the charge detail code if it differs from the default on the Detail Code Control Form. VARCHAR2(30)
	p_chrg	Monetary amount to be charged for the graduation application. NUMBER(12,2)
	p_fee_date	Date of the charge. DATE
	p_tran_number	Transaction number for the charge. NUMBER(4)
	p_wpyo_receipt_number	Receipt number for the graduation application. NUMBER(8)
	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_seqno_out	Sequence number created for the new graduation application. Required Out Variable.

p_delete

Procedure p_delete(p_pidm  shbgapp.shbgapp_pidm%TYPE,
                   p_seqno shbgapp.shbgapp_seqno%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        shbgapp.shbgapp_pidm%TYPE,
                 p_seqno       shbgapp.shbgapp_seqno%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.

Parameters

	p_pidm	Internal identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_pidm                shbgapp.shbgapp_pidm%TYPE,
                   p_seqno               shbgapp.shbgapp_seqno%TYPE,
                   p_request_date        shbgapp.shbgapp_request_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_gast_code           shbgapp.shbgapp_gast_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_gast_date           shbgapp.shbgapp_gast_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_user_id             shbgapp.shbgapp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_gadr_code           shbgapp.shbgapp_gadr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dgmr_upd_grst_code  shbgapp.shbgapp_dgmr_upd_grst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_grad_date           shbgapp.shbgapp_grad_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_grad_term_code      shbgapp.shbgapp_grad_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_grad_acyr_code      shbgapp.shbgapp_grad_acyr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_grad_attend_cde     shbgapp.shbgapp_grad_attend_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_last_name           shbgapp.shbgapp_last_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_first_name          shbgapp.shbgapp_first_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_mi                  shbgapp.shbgapp_mi%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_name_suffix         shbgapp.shbgapp_name_suffix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street1             shbgapp.shbgapp_street1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street2             shbgapp.shbgapp_street2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street3             shbgapp.shbgapp_street3%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street4             shbgapp.shbgapp_street4%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_house_number        shbgapp.shbgapp_house_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_city                shbgapp.shbgapp_city%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stat_code           shbgapp.shbgapp_stat_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_zip                 shbgapp.shbgapp_zip%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_natn_code           shbgapp.shbgapp_natn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_detc      shbgapp.shbgapp_term_code_detc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_wpyo_code           shbgapp.shbgapp_wpyo_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_detc_detail_code    shbgapp.shbgapp_detc_detail_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_detc_desc           shbgapp.shbgapp_detc_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_chrg                shbgapp.shbgapp_chrg%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_fee_date            shbgapp.shbgapp_fee_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_tran_number         shbgapp.shbgapp_tran_number%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_wpyo_receipt_number shbgapp.shbgapp_wpyo_receipt_number%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin         shbgapp.shbgapp_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 identification number (PIDM) of the learner for which the graduation application was submitted. NUMBER(8) Required Key
	p_seqno	One-up number for this graduation application submitted by the learner. NUMBER(4) Required Key
	p_request_date	Date the graduation application was submitted. DATE Required
	p_gast_code	Status code for the graduation application. VARCHAR2(4) Required
	p_gast_date	Date the graduation application status was last changed. DATE Required
	p_user_id	ID of the most recent user to create or update the row in the SHBGAPP table. VARCHAR2(30) Required
	p_gadr_code	Display rule code in effect when the graduation application was submitted. VARCHAR2(15)
	p_dgmr_upd_grst_code	Graduation status code to use if the SHRDGMR graduation status will be impacted. VARCHAR2(3)
	p_grad_date	Requested graduation date. DATE
	p_grad_term_code	Requested graduation term code. VARCHAR2(6)
	p_grad_acyr_code	Requested graduation academic year. VARCHAR2(4)
	p_grad_attend_cde	Indicator for whether the learner plans to attend the graduation ceremony. VARCHAR2(1)
	p_last_name	Last name requested for printing on the diploma. VARCHAR2(60)
	p_first_name	First name requested for printing on the diploma. VARCHAR2(15)
	p_mi	Middle name requested for printing on the diploma. VARCHAR2(15)
	p_name_suffix	Name suffix requested for printing on the diploma. VARCHAR2(20)
	p_street1	Requested mailing address street line 1 for diploma. VARCHAR2(30)
	p_street2	Requested mailing address street line 2 for diploma. VARCHAR2(30)
	p_street3	Requested mailing address street line 3 for diploma. VARCHAR2(30)
	p_street4	Requested mailing address street line 4 for diploma. VARCHAR2(30)
	p_house_number	Requested mailing address house number for diploma. VARCHAR2(10)
	p_city	Requested mailing address city for diploma. VARCHAR2(20)
	p_stat_code	Requested mailing address state code for diploma. VARCHAR2(3)
	p_zip	Requested mailing address zip for diploma. VARCHAR2(10)
	p_natn_code	Requested mailing address nation code for diploma. VARCHAR2(5)
	p_term_code_detc	Detail code to use for the billing. VARCHAR2(6)
	p_wpyo_code	Code of the payment option of the request. VARCHAR2(4)
	p_detc_detail_code	Charge detail code to be placed on the student's account in billing for submitting a graduation application. VARCHAR2(4)
	p_detc_desc	Description of the charge detail code if it differs from the default on the Detail Code Control Form. VARCHAR2(30)
	p_chrg	Monetary amount to be charged for the graduation application. NUMBER(12,2)
	p_fee_date	Date of the charge. DATE
	p_tran_number	Transaction number for the charge. NUMBER(4)
	p_wpyo_receipt_number	Receipt number for the graduation application. NUMBER(8)
	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)