index

Package sb_learnermodule

This package provides the Common Business interface for the Learner Module API (sb_learnermodule).
 
SOBLMOD:  The Learner Module table is used to store the number of curricula by module (Recruiting, Admissions, Student, Academic History) that are allowed to be entered.  The number of fields of study are maintained in the the table SORLMFS, Number of Fields of Study Allowed.
 
Seed data is delivered with the existing limitations that this table can be updated, but the Bridge API will still only backfill the student curriculum data based the delivered maximums in the initial release.

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
learnermodule_rec  
learnermodule_ref  
learnermodule_tab  

Constants
M_ENTITY_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(13) := 'LEARNERMODULE';

Business Entity name

learnermodule_rec 

TYPE learnermodule_rec IS RECORD (
   r_lmod_code               soblmod.soblmod_lmod_code%TYPE,
   r_sys_req_ind             soblmod.soblmod_sys_req_ind%TYPE,
   r_max_curricula           soblmod.soblmod_max_curricula%TYPE,
   r_max_majors              soblmod.soblmod_max_majors%TYPE,
   r_max_minors              soblmod.soblmod_max_minors%TYPE,
   r_max_concentrations      soblmod.soblmod_max_concentrations%TYPE,
   r_user_id                 soblmod.soblmod_user_id%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

learnermodule_ref 

TYPE learnermodule_ref IS REF CURSOR RETURN learnermodule_rec;

Entity cursor variable type

learnermodule_tab 

TYPE learnermodule_tab IS TABLE OF learnermodule_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_lmod_code                 soblmod.soblmod_lmod_code%TYPE,
      p_rowid                     VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_lmod_code   Banner learner module.  VARCHAR2(15)  Required Key

Returns
Y if found, otherwise N.

f_isequal 

Function f_isequal(
      rec_one                     learnermodule_rec,
      rec_two                     learnermodule_rec) RETURN VARCHAR2

Compares two records for equality.

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

f_query_all 

Function f_query_all(
      p_lmod_code                 soblmod.soblmod_lmod_code%TYPE) RETURN learnermodule_ref

Selects all records for the entity.

Parameters
p_lmod_code   Banner learner module code. Wild card (%) may be used with p_lmod_code. VARCHAR2(15)  Required Key

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

f_query_one 

Function f_query_one(
      p_lmod_code                 soblmod.soblmod_lmod_code%TYPE) RETURN learnermodule_ref

Selects one record using the key.

Parameters
p_lmod_code   Banner learner module code.  VARCHAR2(15)  Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_rowid 

Function f_query_by_rowid(
      p_rowid                     VARCHAR2) RETURN learnermodule_ref

Selects one record using the ROWID.

Parameters
p_rowid   Database ROWID of record to select.  VARCHAR2(18) Required

Returns
A cursor variable that will fetch exactly one record.

f_query_one_lock 

Function f_query_one_lock(
      p_lmod_code                 soblmod.soblmod_lmod_code%TYPE,
      p_rowid                     VARCHAR2 DEFAULT NULL) RETURN learnermodule_ref

Selects one record and locks it.

Parameters
p_lmod_code   Banner learner module code.  VARCHAR2(15)  Required Key
p_rowid   Database ROWID of record to be selected.  VARCHAR2(18) Required

Returns
A cursor variable for one record, locking the record.

p_create 

Procedure p_create(
      p_lmod_code                 soblmod.soblmod_lmod_code%TYPE,
      p_sys_req_ind               soblmod.soblmod_sys_req_ind%TYPE      
        DEFAULT 'N',
      p_max_curricula             soblmod.soblmod_max_curricula%TYPE,
      p_max_majors                soblmod.soblmod_max_majors%TYPE,
      p_max_minors                soblmod.soblmod_max_minors%TYPE,
      p_max_concentrations        soblmod.soblmod_max_concentrations%TYPE,
      p_user_id                   soblmod.soblmod_user_id%TYPE 
        DEFAULT gb_common.f_sct_user,
      p_activity_date             soblmod.soblmod_activity_date%TYPE,
      p_rowid_out              OUT VARCHAR2)

Creates a record.

Parameters
p_lmod_code   Banner learner module code.  VARCHAR2(15)  Required Key
p_sys_req_ind   Curriculum module system-required indicator. VARCHAR2(1) Required
Y   Data is required for the system.
N   Data is not required for the system.

p_max_curricula   Count of curriculum allowed per module.  Must be a valid integer greater than 0.  NUMBER(8) Required
p_max_majors   Number moved to Number of Field of Study Allowed (SORLMFS).  NUMBER(8)
p_max_minors   Number moved to Number of Field of Study Allowed (SORLMFS)S.  NUMBER(8)
p_max_concentrations   Number moved to Number of Field of Study Allowed (SORLMFS).  NUMBER(8)
p_user_id   Oracle ID of the most recent user to create or update a record.  VARCHAR2(30)  Required
p_rowid_out   Database ROWID of record to be created.  VARCHAR2(18) Required

p_delete 

Procedure p_delete(
      p_lmod_code                 soblmod.soblmod_lmod_code%TYPE,
      p_rowid                     VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters
p_lmod_code   Banner learner module code.  VARCHAR2(15) Required
p_rowid   Database ROWID of the record to be deleted.  VARCHAR2(18) Required

p_lock 

Procedure p_lock(
      p_lmod_code               soblmod.soblmod_lmod_code%TYPE,
      p_rowid_inout      IN OUT VARCHAR2)

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_lmod_code   Banner learner module code.  VARCHAR2(15) Required Key
p_rowid_inout   Database ROWID of record to be locked.  VARCHAR2(18) Required

p_update 

Procedure p_update(
      p_lmod_code                 soblmod.soblmod_lmod_code%TYPE,
      p_sys_req_ind               soblmod.soblmod_sys_req_ind%TYPE 
        DEFAULT dml_common.f_unspecified_string,
      p_max_curricula             soblmod.soblmod_max_curricula%TYPE 
        DEFAULT dml_common.f_unspecified_number,
      p_max_majors                soblmod.soblmod_max_majors%TYPE 
        DEFAULT dml_common.f_unspecified_number,
      p_max_minors                soblmod.soblmod_max_minors%TYPE 
        DEFAULT dml_common.f_unspecified_number,
      p_max_concentrations        soblmod.soblmod_max_concentrations%TYPE 
        DEFAULT dml_common.f_unspecified_number,
      p_user_id                   soblmod.soblmod_user_id%TYPE 
        DEFAULT gb_common.f_sct_user,
      p_activity_date             soblmod.soblmod_activity_date%TYPE,
      p_rowid                      VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters
p_lmod_code   Banner learner module code.  VARCHAR2(15)  Required Key
p_sys_req_ind   Curriculum module system-required indicator. VARCHAR2(1) Required
Y   Data is required for the system.
N   Data is not required for the system.

p_max_curricula   Count of curriculum allowed per module.  Must be a valid integer greater than 0.  NUMBER(8) Required
p_max_majors   Number moved to Number of Field of Study Allowed (SORLMFS).  NUMBER(8)
p_max_minors   Number moved to Number of Field of Study Allowed (SORLMFS).  NUMBER(8)
p_max_concentrations   Number moved to Number of Field of Study Allowed (SORLMFS).  NUMBER(8)
p_user_id   Oracle ID of the most recent user to create or update a record.  VARCHAR2(30) Required
p_rowid_out   Database ROWID of record to be created.  VARCHAR2(18) Required