index

Package gb_stvterm_rules

NOTE: Please be advised that this API  is currently intended to only support internal operations.
To ensure data integrity,  this api  is not supported  when called by external applications or interfaces to manipulate data. The recommendation for external applications is to use message level integration  to integrate with this entitity in  SCT Banner.
 
This package provides the support subprograms for the Term Code Validation API (gb_stvterm).


Program units
p_register_entity   Registers the attribute/value pairs to the message cache.
p_register_entity   Registers the attribute/value pairs to the message cache.
p_validate   Validates all the data in the record.


p_register_entity

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            p_internal_record_id VARCHAR2)

Registers the attribute/value pairs to the message cache.
This signature uses the ROWID only for the delete operations.

Parameters
p_internal_record_id   Database VARCHAR2(18)


p_register_entity

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            p_code               stvterm.stvterm_code%TYPE,
                            p_desc               stvterm.stvterm_desc%TYPE,
                            p_start_date         stvterm.stvterm_start_date%TYPE,
                            p_end_date           stvterm.stvterm_end_date%TYPE,
                            p_fa_proc_yr         stvterm.stvterm_fa_proc_yr%TYPE,
                            p_fa_term            stvterm.stvterm_fa_term%TYPE,
                            p_fa_period          stvterm.stvterm_fa_period%TYPE,
                            p_fa_end_period      stvterm.stvterm_fa_end_period%TYPE,
                            p_acyr_code          stvterm.stvterm_acyr_code%TYPE,
                            p_housing_start_date stvterm.stvterm_housing_start_date%TYPE,
                            p_housing_end_date   stvterm.stvterm_housing_end_date%TYPE,
                            p_system_req_ind     stvterm.stvterm_system_req_ind%TYPE,
                            p_trmt_code          stvterm.stvterm_trmt_code%TYPE,
                            p_internal_record_id VARCHAR2)

Registers the attribute/value pairs to the message cache.
This signature registers all the parameters

Parameters
p_code   999999 - End of Time. VARCHAR2(6) Required Key
p_desc   Term associated with the term code. The term is identified by the academic year and term number in YYYYTT format. VARCHAR2(30) Required
p_start_date   Term start date in DD-MON-YY format. DATE Required
p_end_date   Term end date in DD-MON-YY format. DATE Required
p_fa_proc_yr   Financial aid processing start and end years (e.g., the financial aid processing year 2005 - 2006 is formatted 0506.). VARCHAR2(4)
p_fa_term   Financial aid award term. VARCHAR2(1)
p_fa_period   Financial aid award beginning period. NUMBER(2)
p_fa_end_period   Financial aid award ending period. NUMBER(2)
p_acyr_code   This column is not currently in use. VARCHAR2(4) Required
p_housing_start_date   Housing Start Date. DATE Required
p_housing_end_date   Housing End Date. DATE Required
p_system_req_ind   System Required Indicator. VARCHAR2(1)
p_trmt_code   Term type for this term. Will default from SHBCGPA_TRMT_CODE. VARCHAR2(1)
p_internal_record_id   Database VARCHAR2(18)


p_validate

PROCEDURE p_validate(p_code               stvterm.stvterm_code%TYPE,
                     p_desc               stvterm.stvterm_desc%TYPE,
                     p_start_date         stvterm.stvterm_start_date%TYPE,
                     p_end_date           stvterm.stvterm_end_date%TYPE,
                     p_fa_proc_yr         stvterm.stvterm_fa_proc_yr%TYPE DEFAULT NULL,
                     p_fa_term            stvterm.stvterm_fa_term%TYPE DEFAULT NULL,
                     p_fa_period          stvterm.stvterm_fa_period%TYPE DEFAULT NULL,
                     p_fa_end_period      stvterm.stvterm_fa_end_period%TYPE DEFAULT NULL,
                     p_acyr_code          stvterm.stvterm_acyr_code%TYPE,
                     p_housing_start_date stvterm.stvterm_housing_start_date%TYPE,
                     p_housing_end_date   stvterm.stvterm_housing_end_date%TYPE,
                     p_system_req_ind     stvterm.stvterm_system_req_ind%TYPE DEFAULT NULL,
                     p_trmt_code          stvterm.stvterm_trmt_code%TYPE DEFAULT NULL)

Validates all the data in the record.

Parameters
p_code   999999 - End of Time. VARCHAR2(6) Required Key
p_desc   Term associated with the term code. The term is identified by the academic year and term number in YYYYTT format. VARCHAR2(30) Required
p_start_date   Term start date in DD-MON-YY format. DATE Required
p_end_date   Term end date in DD-MON-YY format. DATE Required
p_fa_proc_yr   Financial aid processing start and end years (e.g., the financial aid processing year 2005 - 2006 is formatted 0506.). VARCHAR2(4)
p_fa_term   Financial aid award term. VARCHAR2(1)
p_fa_period   Financial aid award beginning period. NUMBER(2)
p_fa_end_period   Financial aid award ending period. NUMBER(2)
p_acyr_code   This column is not currently in use. VARCHAR2(4) Required
p_housing_start_date   Housing Start Date. DATE Required
p_housing_end_date   Housing End Date. DATE Required
p_system_req_ind   System Required Indicator. VARCHAR2(1)
p_trmt_code   Term type for this term. Will default from SHBCGPA_TRMT_CODE. VARCHAR2(1)