index

Package sb_wl_exclusion

This package provides the Common Business interface for the Waitlist Exclusion Rules API (sb_wl_exclusion).
 
This has waitlist exclusion rules that will prevent a student from being added to a course's waitlist if the student falls in any of the specified exclusion rules.
The key to the waitlist reordering rules entry is the primary_key sequence number.

Program units
f_api_version  
f_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
wl_exclusion_rec  
wl_exclusion_ref  
wl_exclusion_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(12) := 'WL_EXCLUSION';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

wl_exclusion_rec 

TYPE wl_exclusion_rec IS RECORD (
  r_primary_key             sobexcr.sobexcr_primary_key%TYPE,
  r_term_code               sobexcr.sobexcr_term_code%TYPE,
  r_user_id                 sobexcr.sobexcr_user_id%TYPE,
  r_levl_code               sobexcr.sobexcr_levl_code%TYPE,
  r_camp_code               sobexcr.sobexcr_camp_code%TYPE,
  r_coll_code               sobexcr.sobexcr_coll_code%TYPE,
  r_degc_code               sobexcr.sobexcr_degc_code%TYPE,
  r_program                 sobexcr.sobexcr_program%TYPE,
  r_clas_code               sobexcr.sobexcr_clas_code%TYPE,
  r_atts_code               sobexcr.sobexcr_atts_code%TYPE,
  r_astd_code               sobexcr.sobexcr_astd_code%TYPE,
  r_chrt_code               sobexcr.sobexcr_chrt_code%TYPE,
  r_lfst_code               sobexcr.sobexcr_lfst_code%TYPE,
  r_majr_code               sobexcr.sobexcr_majr_code%TYPE,
  r_min_gpa                 sobexcr.sobexcr_min_gpa%TYPE,
  r_max_gpa                 sobexcr.sobexcr_max_gpa%TYPE,
  r_data_origin             sobexcr.sobexcr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

wl_exclusion_ref 

TYPE wl_exclusion_ref IS REF CURSOR RETURN wl_exclusion_rec;

Entity cursor variable type

wl_exclusion_tab 

TYPE wl_exclusion_tab IS TABLE OF wl_exclusion_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_primary_key sobexcr.sobexcr_primary_key%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_isequal 

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

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

f_query_all 

Function f_query_all(p_primary_key sobexcr.sobexcr_primary_key%TYPE)
  RETURN wl_exclusion_ref

Selects all records for the entity.

Parameters
p_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) Required Key

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

f_query_one 

Function f_query_one(p_primary_key sobexcr.sobexcr_primary_key%TYPE)
  RETURN wl_exclusion_ref

Selects one record using key.

Parameters
p_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) 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 wl_exclusion_ref

Selects one record using 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_primary_key sobexcr.sobexcr_primary_key%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN wl_exclusion_ref

Selects one record and locks it.

Parameters
p_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) 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_term_code   sobexcr.sobexcr_term_code%TYPE,
                   p_user_id     sobexcr.sobexcr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_levl_code   sobexcr.sobexcr_levl_code%TYPE DEFAULT NULL,
                   p_camp_code   sobexcr.sobexcr_camp_code%TYPE DEFAULT NULL,
                   p_coll_code   sobexcr.sobexcr_coll_code%TYPE DEFAULT NULL,
                   p_degc_code   sobexcr.sobexcr_degc_code%TYPE DEFAULT NULL,
                   p_program     sobexcr.sobexcr_program%TYPE DEFAULT NULL,
                   p_clas_code   sobexcr.sobexcr_clas_code%TYPE DEFAULT NULL,
                   p_atts_code   sobexcr.sobexcr_atts_code%TYPE DEFAULT NULL,
                   p_astd_code   sobexcr.sobexcr_astd_code%TYPE DEFAULT NULL,
                   p_chrt_code   sobexcr.sobexcr_chrt_code%TYPE DEFAULT NULL,
                   p_lfst_code   sobexcr.sobexcr_lfst_code%TYPE DEFAULT NULL,
                   p_majr_code   sobexcr.sobexcr_majr_code%TYPE DEFAULT NULL,
                   p_min_gpa     sobexcr.sobexcr_min_gpa%TYPE DEFAULT NULL,
                   p_max_gpa     sobexcr.sobexcr_max_gpa%TYPE DEFAULT NULL,
                   p_data_origin sobexcr.sobexcr_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) Required Key
p_term_code   Term code associated with the entries on the Automated Waitlist Term Control Form (SOAWLTC) on Waitlist Exclusions Block. VARCHAR2(6) Required
p_user_id   ID of the user who inserted or last updated the data. VARCHAR2(30) Required
p_levl_code   Level code the system is to use in the exclusion rule. VARCHAR2(2)
p_camp_code   Campus code the system is to use in the exclusion rule. VARCHAR2(3)
p_coll_code   College code the system is to use in the exclusion rule. VARCHAR2(2)
p_degc_code   Degree code the system is to use in the exclusion rule. VARCHAR2(6)
p_program   Program code the system is to use in the exclusion rule. VARCHAR2(12)
p_clas_code   Class code the system is to use in the exclusion rule. VARCHAR2(2)
p_atts_code   Attribute code the system is to use in the exclusion rule. VARCHAR2(4)
p_astd_code   Academic standing code referenced in the General Student, Registration and Academic History Modules. VARCHAR2(2)
p_chrt_code   Cohort code the system is to use in the exclusion rule. VARCHAR2(10)
p_lfst_code   Field of student type the major code values should apply to in the exclusion rule. VARCHAR2(15)
p_majr_code   Major code the system is to use in the exclusion rule. VARCHAR2(4)
p_min_gpa   Minimum GPA the system is to use in the exclusion rule. NUMBER(23,9)
p_max_gpa   Maximum GPA the system is to use in the exclusion rule. NUMBER(23,9)
p_data_origin   Source system that created 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_primary_key sobexcr.sobexcr_primary_key%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_primary_key sobexcr.sobexcr_primary_key%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks a record.
If 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_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_primary_key sobexcr.sobexcr_primary_key%TYPE,
                   p_term_code   sobexcr.sobexcr_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     sobexcr.sobexcr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_levl_code   sobexcr.sobexcr_levl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_camp_code   sobexcr.sobexcr_camp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_code   sobexcr.sobexcr_coll_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_degc_code   sobexcr.sobexcr_degc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_program     sobexcr.sobexcr_program%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_clas_code   sobexcr.sobexcr_clas_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atts_code   sobexcr.sobexcr_atts_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_astd_code   sobexcr.sobexcr_astd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_chrt_code   sobexcr.sobexcr_chrt_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lfst_code   sobexcr.sobexcr_lfst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_majr_code   sobexcr.sobexcr_majr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_min_gpa     sobexcr.sobexcr_min_gpa%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_max_gpa     sobexcr.sobexcr_max_gpa%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin sobexcr.sobexcr_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_primary_key   Unique sequence number to identify exclusion rule. NUMBER(9) Required Key
p_term_code   Term code associated with the entries on the Automated Waitlist Term Control Form (SOAWLTC) on Waitlist Exclusions Block. VARCHAR2(6) Required
p_user_id   ID of the user who inserted or last updated the data. VARCHAR2(30) Required
p_levl_code   Level code the system is to use in the exclusion rule. VARCHAR2(2)
p_camp_code   Campus code the system is to use in the exclusion rule. VARCHAR2(3)
p_coll_code   College code the system is to use in the exclusion rule. VARCHAR2(2)
p_degc_code   Degree code the system is to use in the exclusion rule. VARCHAR2(6)
p_program   Program code the system is to use in the exclusion rule. VARCHAR2(12)
p_clas_code   Class code the system is to use in the exclusion rule. VARCHAR2(2)
p_atts_code   Attribute code the system is to use in the exclusion rule. VARCHAR2(4)
p_astd_code   Academic standing code referenced in the General Student, Registration and Academic History Modules. VARCHAR2(2)
p_chrt_code   Cohort code the system is to use in the exclusion rule. VARCHAR2(10)
p_lfst_code   Field of student type the major code values should apply to in the exclusion rule. VARCHAR2(15)
p_majr_code   Major code the system is to use in the exclusion rule. VARCHAR2(4)
p_min_gpa   Minimum GPA the system is to use in the exclusion rule. NUMBER(23,9)
p_max_gpa   Maximum GPA the system is to use in the exclusion rule. NUMBER(23,9)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)