index

Package sb_wl_collector

This package provides the Common Business interface for the Waitlist Collector API (sb_wl_collector).
 
This has the sections with one or more new seats available that a student on a waitlist can use to register in the course in count enrollment status.
The key to the waitlist collector table is the term code and the course reference 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_collector_rec  
wl_collector_ref  
wl_collector_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

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

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

wl_collector_rec 

TYPE wl_collector_rec IS RECORD (
  r_term_code               sfrcolw.sfrcolw_term_code%TYPE,
  r_crn                     sfrcolw.sfrcolw_crn%TYPE,
  r_user_id                 sfrcolw.sfrcolw_user_id%TYPE,
  r_data_origin             sfrcolw.sfrcolw_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

wl_collector_ref 

TYPE wl_collector_ref IS REF CURSOR RETURN wl_collector_rec;

Entity cursor variable type

wl_collector_tab 

TYPE wl_collector_tab IS TABLE OF wl_collector_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 sfrcolw.sfrcolw_term_code%TYPE,
                  p_crn       sfrcolw.sfrcolw_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 for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. 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_collector_rec, rec_two wl_collector_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_collector_rec Required
rec_two   The second record to compare. Type wl_collector_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 sfrcolw.sfrcolw_term_code%TYPE,
                     p_crn       sfrcolw.sfrcolw_crn%TYPE)
  RETURN wl_collector_ref

Selects all records for the entity.

Parameters
p_term_code   Term code for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. 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 sfrcolw.sfrcolw_term_code%TYPE,
                     p_crn       sfrcolw.sfrcolw_crn%TYPE)
  RETURN wl_collector_ref

Selects one record using key.

Parameters
p_term_code   Term code for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. 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_collector_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_term_code sfrcolw.sfrcolw_term_code%TYPE,
                          p_crn       sfrcolw.sfrcolw_crn%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN wl_collector_ref

Selects one record and locks it.

Parameters
p_term_code   Term code for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. 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   sfrcolw.sfrcolw_term_code%TYPE,
                   p_crn         sfrcolw.sfrcolw_crn%TYPE,
                   p_user_id     sfrcolw.sfrcolw_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin sfrcolw.sfrcolw_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_term_code   Term code for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. VARCHAR2(5) Required Key
p_user_id   ID of the user who inserted or last updated the data. VARCHAR2(30) Required
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_term_code sfrcolw.sfrcolw_term_code%TYPE,
                   p_crn       sfrcolw.sfrcolw_crn%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_term_code   Term code for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. VARCHAR2(5) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_term_code   sfrcolw.sfrcolw_term_code%TYPE,
                 p_crn         sfrcolw.sfrcolw_crn%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_term_code   Term code for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. 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   sfrcolw.sfrcolw_term_code%TYPE,
                   p_crn         sfrcolw.sfrcolw_crn%TYPE,
                   p_user_id     sfrcolw.sfrcolw_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin sfrcolw.sfrcolw_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_term_code   Term code for the section that has new seat(s) available. VARCHAR2(6) Required Key
p_crn   Course reference number for which the new seat is available. VARCHAR2(5) Required Key
p_user_id   ID of the user who inserted or last updated the data. VARCHAR2(30) Required
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)