Package sb_wl_section

BANINST1@S10B80

Package sb_wl_section_ctrl

This package provides the Common Business interface for the Waitlist Section Control API (sb_wl_section_ctrl).

This has the waitlist configuration for each section.
The key to the waitlist section control entry is the term code and the course reference number.

Program units

f_api_version	Returns the API version number.
f_exists	Checks if a record exists.
f_isequal	Compares two records for equality.
f_query_all	Selects all records for the entity.
f_query_one	Selects one record using the key.
f_query_by_rowid	Selects one record using the ROWID.
f_query_one_lock	Selects one record and locks it.
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

wl_section_ctrl_rec	Business Entity record type
wl_section_ctrl_ref	Entity cursor variable type
wl_section_ctrl_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

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

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

wl_section_ctrl_rec

TYPE wl_section_ctrl_rec IS RECORD (
  r_term_code               ssbwlsc.ssbwlsc_term_code%TYPE,
  r_crn                     ssbwlsc.ssbwlsc_crn%TYPE,
  r_auto_notify_ind         ssbwlsc.ssbwlsc_auto_notify_ind%TYPE,
  r_wl_reg_check_ind        ssbwlsc.ssbwlsc_wl_reg_check_ind%TYPE,
  r_wl_pos_webc_disp_ind    ssbwlsc.ssbwlsc_wl_pos_webc_disp_ind%TYPE,
  r_user_id                 ssbwlsc.ssbwlsc_user_id%TYPE,
  r_deadline_notify         ssbwlsc.ssbwlsc_deadline_notify%TYPE,
  r_data_origin             ssbwlsc.ssbwlsc_data_origin%TYPE,
  r_max_resend_hrs          ssbwlsc.ssbwlsc_max_resend_hrs%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

wl_section_ctrl_ref

TYPE wl_section_ctrl_ref IS REF CURSOR RETURN wl_section_ctrl_rec;

Entity cursor variable type

wl_section_ctrl_tab

TYPE wl_section_ctrl_tab IS TABLE OF wl_section_ctrl_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_term_code ssbwlsc.ssbwlsc_term_code%TYPE,
                  p_crn       ssbwlsc.ssbwlsc_crn%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) 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_section_ctrl_rec,
                   rec_two wl_section_ctrl_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_section_ctrl_rec Required
	rec_two	The second record to compare. Type wl_section_ctrl_rec Required

Returns

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

f_query_all

Function f_query_all(p_term_code ssbwlsc.ssbwlsc_term_code%TYPE,
                     p_crn       ssbwlsc.ssbwlsc_crn%TYPE)
  RETURN wl_section_ctrl_ref

Selects all records for the entity.

Parameters

	p_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_term_code ssbwlsc.ssbwlsc_term_code%TYPE,
                     p_crn       ssbwlsc.ssbwlsc_crn%TYPE)
  RETURN wl_section_ctrl_ref

Selects one record using the key.

Parameters

	p_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) 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_section_ctrl_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_term_code ssbwlsc.ssbwlsc_term_code%TYPE,
                          p_crn       ssbwlsc.ssbwlsc_crn%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN wl_section_ctrl_ref

Selects one record and locks it.

Parameters

	p_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) 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            ssbwlsc.ssbwlsc_term_code%TYPE,
                   p_crn                  ssbwlsc.ssbwlsc_crn%TYPE,
                   p_auto_notify_ind      ssbwlsc.ssbwlsc_auto_notify_ind%TYPE,
                   p_wl_reg_check_ind     ssbwlsc.ssbwlsc_wl_reg_check_ind%TYPE,
                   p_wl_pos_webc_disp_ind ssbwlsc.ssbwlsc_wl_pos_webc_disp_ind%TYPE,
                   p_user_id              ssbwlsc.ssbwlsc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_deadline_notify      ssbwlsc.ssbwlsc_deadline_notify%TYPE DEFAULT NULL,
                   p_data_origin          ssbwlsc.ssbwlsc_data_origin%TYPE DEFAULT NULL,
                   p_max_resend_hrs       ssbwlsc.ssbwlsc_max_resend_hrs%TYPE DEFAULT NULL,
                   p_rowid_out            OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) Required Key
	p_auto_notify_ind	Indicator for whether the automatic waitlist notification functionality is active for the term and section. Valid values are Y and N. VARCHAR2(1) Required
	p_wl_reg_check_ind	Indicator for whether the all the registration error checking will be performed when registering a section into waitlist. VARCHAR2(1) Required
	p_wl_pos_webc_disp_ind	Indicator for whether the student's position in the waitlist will be displayed on self-service. Valid values Y and N. VARCHAR2(1) Required
	p_user_id	ID of the user who inserted or last updated the data. VARCHAR2(30) Required
	p_deadline_notify	Number of hours the student has to register for a course after receiving the available seats notification. NUMBER(4)
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_max_resend_hrs	Number of hours to attempt to resend failed email messages. NUMBER(4)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_term_code ssbwlsc.ssbwlsc_term_code%TYPE,
                   p_crn       ssbwlsc.ssbwlsc_crn%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_term_code   ssbwlsc.ssbwlsc_term_code%TYPE,
                 p_crn         ssbwlsc.ssbwlsc_crn%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_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_term_code            ssbwlsc.ssbwlsc_term_code%TYPE,
                   p_crn                  ssbwlsc.ssbwlsc_crn%TYPE,
                   p_auto_notify_ind      ssbwlsc.ssbwlsc_auto_notify_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_wl_reg_check_ind     ssbwlsc.ssbwlsc_wl_reg_check_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_wl_pos_webc_disp_ind ssbwlsc.ssbwlsc_wl_pos_webc_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id              ssbwlsc.ssbwlsc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_deadline_notify      ssbwlsc.ssbwlsc_deadline_notify%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin          ssbwlsc.ssbwlsc_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_max_resend_hrs       ssbwlsc.ssbwlsc_max_resend_hrs%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rowid                gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_term_code	Term code associated with the entries on the Waitlist Automation Section Control Form (SSAWLSC). VARCHAR2(6) Required Key
	p_crn	Course reference number for section waitlist control. VARCHAR2(5) Required Key
	p_auto_notify_ind	Indicator for whether the automatic waitlist notification functionality is active for the term and section. Valid values are Y and N. VARCHAR2(1) Required
	p_wl_reg_check_ind	Indicator for whether the all the registration error checking will be performed when registering a section into waitlist. VARCHAR2(1) Required
	p_wl_pos_webc_disp_ind	Indicator for whether the student's position in the waitlist will be displayed on self-service. Valid values Y and N. VARCHAR2(1) Required
	p_user_id	ID of the user who inserted or last updated the data. VARCHAR2(30) Required
	p_deadline_notify	Number of hours the student has to register for a course after receiving the available seats notification. NUMBER(4)
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_max_resend_hrs	Number of hours to attempt to resend failed email messages. NUMBER(4)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)