index

Package sb_gradapp_selrule

This package provides the Common Business interface for the Graduation Application Select Rules API (sb_gradapp_selrule).
 
Graduation application select rules determine which graduation application display rule to use for a learner's curriculum record during the graduation application self-service process.
 
Select rules are examined in process order.  The process order number is unique within the table.  If the information defined on a select rule matches the learner's curriculum, the select rule is considered passing and the display rule defined on that passing select rule is the display rule used for that curriculum when selected by the learner during the self-service graduation application process.

Program units
f_api_version  
f_exists  
F_ProcOrdNo_Exists  
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_selrule_rec  
gradapp_selrule_ref  
gradapp_selrule_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(15) := 'GRADAPP_SELRULE';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

gradapp_selrule_rec 

TYPE gradapp_selrule_rec IS RECORD (
  r_seqno                   shbgads.shbgads_seqno%TYPE,
  r_process_order_no        shbgads.shbgads_process_order_no%TYPE,
  r_gadr_code               shbgads.shbgads_gadr_code%TYPE,
  r_user_id                 shbgads.shbgads_user_id%TYPE,
  r_levl_code               shbgads.shbgads_levl_code%TYPE,
  r_camp_code               shbgads.shbgads_camp_code%TYPE,
  r_coll_code               shbgads.shbgads_coll_code%TYPE,
  r_degc_code               shbgads.shbgads_degc_code%TYPE,
  r_program                 shbgads.shbgads_program%TYPE,
  r_lfst_code               shbgads.shbgads_lfst_code%TYPE,
  r_majr_code               shbgads.shbgads_majr_code%TYPE,
  r_dept_code               shbgads.shbgads_dept_code%TYPE,
  r_data_origin             shbgads.shbgads_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gradapp_selrule_ref 

TYPE gradapp_selrule_ref IS REF CURSOR RETURN gradapp_selrule_rec;

Entity cursor variable type

gradapp_selrule_tab 

TYPE gradapp_selrule_tab IS TABLE OF gradapp_selrule_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_seqno shbgads.shbgads_seqno%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_seqno   One-up number to define the row. NUMBER(8) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

F_ProcOrdNo_Exists 

Function F_ProcOrdNo_Exists(p_process_order_no shbgads.shbgads_process_order_no%TYPE)
  RETURN VARCHAR2

Checks if process order no exists.

Parameters
p_process_order_no   Order in which to check the select rules. NUMBER(6) Required

Returns
Y if found, otherwise N.

f_isequal 

Function f_isequal(rec_one gradapp_selrule_rec,
                   rec_two gradapp_selrule_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_selrule_rec Required
rec_two   The second record to compare. Type gradapp_selrule_rec Required

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

f_query_all 

Function f_query_all(p_gadr_code shbgads.shbgads_gadr_code%TYPE DEFAULT NULL,
                     p_levl_code shbgads.shbgads_levl_code%TYPE DEFAULT NULL,
                     p_camp_code shbgads.shbgads_camp_code%TYPE DEFAULT NULL,
                     p_coll_code shbgads.shbgads_coll_code%TYPE DEFAULT NULL,
                     p_degc_code shbgads.shbgads_degc_code%TYPE DEFAULT NULL,
                     p_program   shbgads.shbgads_program%TYPE DEFAULT NULL,
                     p_lfst_code shbgads.shbgads_lfst_code%TYPE DEFAULT NULL,
                     p_majr_code shbgads.shbgads_majr_code%TYPE DEFAULT NULL,
                     p_dept_code shbgads.shbgads_dept_code%TYPE DEFAULT NULL)
  RETURN gradapp_selrule_ref

Selects all records for the entity.

Parameters
p_gadr_code   Display rule code for the graduation application. VARCHAR2(15) Required
p_levl_code   Level code of the select rule. VARCHAR2(2)
p_camp_code   Campus code of the select rule. VARCHAR2(3)
p_coll_code   College code of the select rule. VARCHAR2(2)
p_degc_code   Degree code of the select rule. VARCHAR2(6)
p_program   Program of the select rule. VARCHAR2(12)
p_lfst_code   Learner field of study type code of the select rule. VARCHAR2(15)
p_majr_code   Major code for the field of study of the select rule. VARCHAR2(4)
p_dept_code   Department code associated with the major field of study of the select rule. VARCHAR2(4)

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

f_query_one 

Function f_query_one(p_seqno shbgads.shbgads_seqno%TYPE)
  RETURN gradapp_selrule_ref

Selects one record using the key.

Parameters
p_seqno   One-up number to define the row. NUMBER(8) 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_selrule_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_seqno shbgads.shbgads_seqno%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gradapp_selrule_ref

Selects one record and locks it.

Parameters
p_seqno   One-up number to define the row. NUMBER(8) 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_seqno            shbgads.shbgads_seqno%TYPE,
                   p_process_order_no shbgads.shbgads_process_order_no%TYPE,
                   p_gadr_code        shbgads.shbgads_gadr_code%TYPE,
                   p_user_id          shbgads.shbgads_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_levl_code        shbgads.shbgads_levl_code%TYPE DEFAULT NULL,
                   p_camp_code        shbgads.shbgads_camp_code%TYPE DEFAULT NULL,
                   p_coll_code        shbgads.shbgads_coll_code%TYPE DEFAULT NULL,
                   p_degc_code        shbgads.shbgads_degc_code%TYPE DEFAULT NULL,
                   p_program          shbgads.shbgads_program%TYPE DEFAULT NULL,
                   p_lfst_code        shbgads.shbgads_lfst_code%TYPE DEFAULT NULL,
                   p_majr_code        shbgads.shbgads_majr_code%TYPE DEFAULT NULL,
                   p_dept_code        shbgads.shbgads_dept_code%TYPE DEFAULT NULL,
                   p_data_origin      shbgads.shbgads_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out        OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_seqno   One-up number to define the row. NUMBER(8) Required Key
p_process_order_no   Order in which to check the select rules. NUMBER(6) Required
p_gadr_code   Display rule code for the graduation application. VARCHAR2(15) Required
p_user_id   ID of the most recent user to create or update the row in the SHBGADS table. VARCHAR2(30) Required
p_levl_code   Level code of the select rule. VARCHAR2(2)
p_camp_code   Campus code of the select rule. VARCHAR2(3)
p_coll_code   College code of the select rule. VARCHAR2(2)
p_degc_code   Degree code of the select rule. VARCHAR2(6)
p_program   Program of the select rule. VARCHAR2(12)
p_lfst_code   Learner field of study type code of the select rule. VARCHAR2(15)
p_majr_code   Major code for the field of study of the select rule. VARCHAR2(4)
p_dept_code   Department code associated with the major field of study of the select rule. VARCHAR2(4)
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_seqno shbgads.shbgads_seqno%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_seqno   One-up number to define the row. NUMBER(8) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_seqno       shbgads.shbgads_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_seqno   One-up number to define the row. NUMBER(8) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_seqno            shbgads.shbgads_seqno%TYPE,
                   p_process_order_no shbgads.shbgads_process_order_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_gadr_code        shbgads.shbgads_gadr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id          shbgads.shbgads_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_levl_code        shbgads.shbgads_levl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_camp_code        shbgads.shbgads_camp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_code        shbgads.shbgads_coll_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_degc_code        shbgads.shbgads_degc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_program          shbgads.shbgads_program%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lfst_code        shbgads.shbgads_lfst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_majr_code        shbgads.shbgads_majr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dept_code        shbgads.shbgads_dept_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin      shbgads.shbgads_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid            gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_seqno   One-up number to define the row. NUMBER(8) Required Key
p_process_order_no   Order in which to check the select rules. NUMBER(6) Required
p_gadr_code   Display rule code for the graduation application. VARCHAR2(15) Required
p_user_id   ID of the most recent user to create or update the row in the SHBGADS table. VARCHAR2(30) Required
p_levl_code   Level code of the select rule. VARCHAR2(2)
p_camp_code   Campus code of the select rule. VARCHAR2(3)
p_coll_code   College code of the select rule. VARCHAR2(2)
p_degc_code   Degree code of the select rule. VARCHAR2(6)
p_program   Program of the select rule. VARCHAR2(12)
p_lfst_code   Learner field of study type code of the select rule. VARCHAR2(15)
p_majr_code   Major code for the field of study of the select rule. VARCHAR2(4)
p_dept_code   Department code associated with the major field of study of the select rule. VARCHAR2(4)
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)