Package sb_crse_select

Package sb_crse_select_pri

This package provides the Common Business interface for the Waitlist Course Selection Priority API (sb_crse_select_pri).

This has priority rules to be applied in the waitlist course selection criteria.
The key to the waitlist course selection criteria 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

crse_select_pri_rec

crse_select_pri_ref

crse_select_pri_tab

Constants

M_ENTITY_NAME

M_BASE_TABLE_NAME

M_ENTITY_NAME

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

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

crse_select_pri_rec

TYPE crse_select_pri_rec IS RECORD (
  r_primary_key             sobcspr.sobcspr_primary_key%TYPE,
  r_term_code               sobcspr.sobcspr_term_code%TYPE,
  r_user_id                 sobcspr.sobcspr_user_id%TYPE,
  r_coll_code               sobcspr.sobcspr_coll_code%TYPE,
  r_subj_code               sobcspr.sobcspr_subj_code%TYPE,
  r_crse_numb               sobcspr.sobcspr_crse_numb%TYPE,
  r_crn                     sobcspr.sobcspr_crn%TYPE,
  r_attr_code               sobcspr.sobcspr_attr_code%TYPE,
  r_data_origin             sobcspr.sobcspr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

crse_select_pri_ref

TYPE crse_select_pri_ref IS REF CURSOR RETURN crse_select_pri_rec;

Entity cursor variable type

crse_select_pri_tab

TYPE crse_select_pri_tab IS TABLE OF crse_select_pri_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 sobcspr.sobcspr_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 course 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 crse_select_pri_rec,
                   rec_two crse_select_pri_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 crse_select_pri_rec Required
	rec_two	The second record to compare. Type crse_select_pri_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 sobcspr.sobcspr_primary_key%TYPE)
  RETURN crse_select_pri_ref

Selects all records for the entity.

Parameters

p_primary_key

Unique sequence number to identify course 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 sobcspr.sobcspr_primary_key%TYPE)
  RETURN crse_select_pri_ref

Selects one record using the key.

Parameters

p_primary_key

Unique sequence number to identify course 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 crse_select_pri_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_primary_key sobcspr.sobcspr_primary_key%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN crse_select_pri_ref

Selects one record and locks it.

Parameters

	p_primary_key	Unique sequence number to identify course 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   sobcspr.sobcspr_term_code%TYPE,
                   p_user_id     sobcspr.sobcspr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_coll_code   sobcspr.sobcspr_coll_code%TYPE DEFAULT NULL,
                   p_subj_code   sobcspr.sobcspr_subj_code%TYPE DEFAULT NULL,
                   p_crse_numb   sobcspr.sobcspr_crse_numb%TYPE DEFAULT NULL,
                   p_crn         sobcspr.sobcspr_crn%TYPE DEFAULT NULL,
                   p_attr_code   sobcspr.sobcspr_attr_code%TYPE DEFAULT NULL,
                   p_data_origin sobcspr.sobcspr_data_origin%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 Automated Waitlist Term Control Form (SOAWLTC). VARCHAR2(6) Required
	p_user_id	ID of the user who inserted or last updated the data. VARCHAR2(30) Required
	p_coll_code	College code of the course to be used in the course selection rule. VARCHAR2(2)
	p_subj_code	Subject code of the course to be used in the course selection rule. VARCHAR2(4)
	p_crse_numb	Course number of the course to be used in the course selection rule. VARCHAR2(5)
	p_crn	Section course reference number of the section to be used in the course selection rule. VARCHAR2(5)
	p_attr_code	Attribute code of the course to be used in the course selection rule. VARCHAR2(4)
	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 sobcspr.sobcspr_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 course 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 sobcspr.sobcspr_primary_key%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_primary_key	Unique sequence number to identify course 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 sobcspr.sobcspr_primary_key%TYPE,
                   p_term_code   sobcspr.sobcspr_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     sobcspr.sobcspr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_coll_code   sobcspr.sobcspr_coll_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_subj_code   sobcspr.sobcspr_subj_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_crse_numb   sobcspr.sobcspr_crse_numb%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_crn         sobcspr.sobcspr_crn%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_code   sobcspr.sobcspr_attr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin sobcspr.sobcspr_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 course rule. NUMBER(9) Required Key
	p_term_code	Term code associated with the entries on the Automated Waitlist Term Control Form (SOAWLTC). VARCHAR2(6) Required
	p_user_id	ID of the user who inserted or last updated the data. VARCHAR2(30) Required
	p_coll_code	College code of the course to be used in the course selection rule. VARCHAR2(2)
	p_subj_code	Subject code of the course to be used in the course selection rule. VARCHAR2(4)
	p_crse_numb	Course number of the course to be used in the course selection rule. VARCHAR2(5)
	p_crn	Section course reference number of the section to be used in the course selection rule. VARCHAR2(5)
	p_attr_code	Attribute code of the course to be used in the course selection rule. VARCHAR2(4)
	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)