index

Package sb_learneroutcome

This package provides the Common Business interface for the Learner Outcome API (sb_learneroutcome).
The learner outcome record is created when courses are rolled to academic history after begin graded. Starting with Banner 7.0,  the roll to academic history indicator has been moved from the learner record (SGBSTDN) to the curriculum base table (SORLCUR).
New outcome records are created for a learner if the college, degree, level and program are different on the outcome curriculum or the outcome has been awarded.
 
Starting with Banner 7.0, all curriculum and field of study data is maintained on the tables SORLCUR and SORLFOS (sb_curriculum API and sb_fieldofstudy API).  When a learner outcome record is created, a primary curriculum and primary major field of study must also be created. At the conclusion of the curriculum and field of study insert, the primary and secondary curriculum data is backfilled to the curriculum on the learner outcome record.


Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if an outcome record exists.
f_isequal   Compares two records for equality.
f_query_all   Selects all outcome records for the learner.
f_query_one   Selects one learner outcome record.
f_query_by_rowid   Selects one learner outcome record by ROWID.
f_query_one_lock   Locks the learner outcome record.
p_create   Creates a learner outcome record.
p_delete   Deletes a learner outcome record.
p_lock   Locks a learner outcome record.
p_update   Updates a learner outcome record.

Types
learneroutcome_rec   Entity record type.
learneroutcome_ref   Entity cursor variable type.
learneroutcome_tab   Entity table type.

Constants
M_ENTITY_NAME   Business Entity name.


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(14) := 'LEARNEROUTCOME';

Business Entity name.


learneroutcome_rec

TYPE learneroutcome_rec IS RECORD (
   r_pidm                    shrdgmr.shrdgmr_pidm%TYPE,
   r_seq_no                  shrdgmr.shrdgmr_seq_no%TYPE,
   r_degc_code               shrdgmr.shrdgmr_degc_code%TYPE,
   r_degs_code               shrdgmr.shrdgmr_degs_code%TYPE,
   r_levl_code               shrdgmr.shrdgmr_levl_code%TYPE,
   r_coll_code_1             shrdgmr.shrdgmr_coll_code_1%TYPE,
   r_majr_code_1             shrdgmr.shrdgmr_majr_code_1%TYPE,
   r_majr_code_minr_1        shrdgmr.shrdgmr_majr_code_minr_1%TYPE,
   r_majr_code_conc_1        shrdgmr.shrdgmr_majr_code_conc_1%TYPE,
   r_coll_code_2             shrdgmr.shrdgmr_coll_code_2%TYPE,
   r_majr_code_2             shrdgmr.shrdgmr_majr_code_2%TYPE,
   r_majr_code_minr_2        shrdgmr.shrdgmr_majr_code_minr_2%TYPE,
   r_majr_code_conc_2        shrdgmr.shrdgmr_majr_code_conc_2%TYPE,
   r_appl_date               shrdgmr.shrdgmr_appl_date%TYPE,
   r_grad_date               shrdgmr.shrdgmr_grad_date%TYPE,
   r_acyr_code_bulletin      shrdgmr.shrdgmr_acyr_code_bulletin%TYPE,
   r_majr_code_minr_1_2      shrdgmr.shrdgmr_majr_code_minr_1_2%TYPE,
   r_majr_code_conc_1_2      shrdgmr.shrdgmr_majr_code_conc_1_2%TYPE,
   r_majr_code_conc_1_3      shrdgmr.shrdgmr_majr_code_conc_1_3%TYPE,
   r_majr_code_minr_2_2      shrdgmr.shrdgmr_majr_code_minr_2_2%TYPE,
   r_majr_code_conc_2_2      shrdgmr.shrdgmr_majr_code_conc_2_2%TYPE,
   r_majr_code_conc_2_3      shrdgmr.shrdgmr_majr_code_conc_2_3%TYPE,
   r_term_code_sturec        shrdgmr.shrdgmr_term_code_sturec%TYPE,
   r_majr_code_1_2           shrdgmr.shrdgmr_majr_code_1_2%TYPE,
   r_majr_code_2_2           shrdgmr.shrdgmr_majr_code_2_2%TYPE,
   r_camp_code               shrdgmr.shrdgmr_camp_code%TYPE,
   r_term_code_grad          shrdgmr.shrdgmr_term_code_grad%TYPE,
   r_acyr_code               shrdgmr.shrdgmr_acyr_code%TYPE,
   r_grst_code               shrdgmr.shrdgmr_grst_code%TYPE,
   r_fee_ind                 shrdgmr.shrdgmr_fee_ind%TYPE,
   r_fee_date                shrdgmr.shrdgmr_fee_date%TYPE,
   r_authorized              shrdgmr.shrdgmr_authorized%TYPE,
   r_term_code_completed     shrdgmr.shrdgmr_term_code_completed%TYPE,
   r_degc_code_dual          shrdgmr.shrdgmr_degc_code_dual%TYPE,
   r_levl_code_dual          shrdgmr.shrdgmr_levl_code_dual%TYPE,
   r_dept_code_dual          shrdgmr.shrdgmr_dept_code_dual%TYPE,
   r_coll_code_dual          shrdgmr.shrdgmr_coll_code_dual%TYPE,
   r_majr_code_dual          shrdgmr.shrdgmr_majr_code_dual%TYPE,
   r_dept_code               shrdgmr.shrdgmr_dept_code%TYPE,
   r_dept_code_2             shrdgmr.shrdgmr_dept_code_2%TYPE,
   r_program                 shrdgmr.shrdgmr_program%TYPE,
   r_term_code_ctlg_1        shrdgmr.shrdgmr_term_code_ctlg_1%TYPE,
   r_dept_code_1_2           shrdgmr.shrdgmr_dept_code_1_2%TYPE,
   r_dept_code_2_2           shrdgmr.shrdgmr_dept_code_2_2%TYPE,
   r_majr_code_conc_121      shrdgmr.shrdgmr_majr_code_conc_121%TYPE,
   r_majr_code_conc_122      shrdgmr.shrdgmr_majr_code_conc_122%TYPE,
   r_majr_code_conc_123      shrdgmr.shrdgmr_majr_code_conc_123%TYPE,
   r_term_code_ctlg_2        shrdgmr.shrdgmr_term_code_ctlg_2%TYPE,
   r_camp_code_2             shrdgmr.shrdgmr_camp_code_2%TYPE,
   r_majr_code_conc_221      shrdgmr.shrdgmr_majr_code_conc_221%TYPE,
   r_majr_code_conc_222      shrdgmr.shrdgmr_majr_code_conc_222%TYPE,
   r_majr_code_conc_223      shrdgmr.shrdgmr_majr_code_conc_223%TYPE,
   r_curr_rule_1             shrdgmr.shrdgmr_curr_rule_1%TYPE,
   r_cmjr_rule_1_1           shrdgmr.shrdgmr_cmjr_rule_1_1%TYPE,
   r_ccon_rule_11_1          shrdgmr.shrdgmr_ccon_rule_11_1%TYPE,
   r_ccon_rule_11_2          shrdgmr.shrdgmr_ccon_rule_11_2%TYPE,
   r_ccon_rule_11_3          shrdgmr.shrdgmr_ccon_rule_11_3%TYPE,
   r_cmjr_rule_1_2           shrdgmr.shrdgmr_cmjr_rule_1_2%TYPE,
   r_ccon_rule_12_1          shrdgmr.shrdgmr_ccon_rule_12_1%TYPE,
   r_ccon_rule_12_2          shrdgmr.shrdgmr_ccon_rule_12_2%TYPE,
   r_ccon_rule_12_3          shrdgmr.shrdgmr_ccon_rule_12_3%TYPE,
   r_cmnr_rule_1_1           shrdgmr.shrdgmr_cmnr_rule_1_1%TYPE,
   r_cmnr_rule_1_2           shrdgmr.shrdgmr_cmnr_rule_1_2%TYPE,
   r_curr_rule_2             shrdgmr.shrdgmr_curr_rule_2%TYPE,
   r_cmjr_rule_2_1           shrdgmr.shrdgmr_cmjr_rule_2_1%TYPE,
   r_ccon_rule_21_1          shrdgmr.shrdgmr_ccon_rule_21_1%TYPE,
   r_ccon_rule_21_2          shrdgmr.shrdgmr_ccon_rule_21_2%TYPE,
   r_ccon_rule_21_3          shrdgmr.shrdgmr_ccon_rule_21_3%TYPE,
   r_cmjr_rule_2_2           shrdgmr.shrdgmr_cmjr_rule_2_2%TYPE,
   r_ccon_rule_22_1          shrdgmr.shrdgmr_ccon_rule_22_1%TYPE,
   r_ccon_rule_22_2          shrdgmr.shrdgmr_ccon_rule_22_2%TYPE,
   r_ccon_rule_22_3          shrdgmr.shrdgmr_ccon_rule_22_3%TYPE,
   r_cmnr_rule_2_1           shrdgmr.shrdgmr_cmnr_rule_2_1%TYPE,
   r_cmnr_rule_2_2           shrdgmr.shrdgmr_cmnr_rule_2_2%TYPE,
   r_user_id                 shrdgmr.shrdgmr_user_id%TYPE,
   r_data_origin             shrdgmr.shrdgmr_data_origin%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type,
    r_stsp_key_sequence  shrdgmr.shrdgmr_stsp_key_sequence%TYPE );

Entity record type.


learneroutcome_ref

TYPE learneroutcome_ref IS REF CURSOR RETURN learneroutcome_rec;

Entity cursor variable type.


learneroutcome_tab

TYPE learneroutcome_tab IS TABLE OF learneroutcome_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_pidm   shrdgmr.shrdgmr_pidm%TYPE,
                  p_seq_no shrdgmr.shrdgmr_seq_no%TYPE,
                  p_rowid  VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if an outcome record exists.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8) Required Key.
p_seq_no   Degree Sequence Number:  Number assigned to each of the learner's outcome records.  NUMBER(2)  Required Key.

Returns
TRUE if found, otherwise FALSE.


f_isequal

Function f_isequal(rec_one learneroutcome_rec, rec_two learneroutcome_rec)
  RETURN VARCHAR2

Compares two records for equality.

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


f_query_all

Function f_query_all(p_pidm   shrdgmr.shrdgmr_pidm%TYPE,
                     p_seq_no shrdgmr.shrdgmr_seq_no%TYPE DEFAULT NULL)
  RETURN learneroutcome_REF

Selects all outcome records for the learner.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8)  Required Key.
p_seq_no   Degree Sequence Number: Number assigned to each of the learner's outcome records. NUMBER(2)  Optional Key.

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


f_query_one

Function f_query_one(p_pidm   shrdgmr.shrdgmr_pidm%TYPE,
                     p_seq_no shrdgmr.shrdgmr_seq_no%TYPE)
  RETURN learneroutcome_REF

Selects one learner outcome record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8)  Required Key.
p_seq_no   Degree Sequence Number: Number assigned to each of the learner's outcome records. NUMBER(2)  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 learneroutcome_ref

Selects one learner outcome record by ROWID.

Parameters
p_rowid   Database ROWID of the record to be selected.  VARCHAR2(18).

Returns
A cursor variable that will fetch exactly one record.


f_query_one_lock

Function f_query_one_lock(p_pidm   shrdgmr.shrdgmr_pidm%TYPE,
                          p_seq_no shrdgmr.shrdgmr_seq_no%TYPE,
                          p_rowid  VARCHAR2 DEFAULT NULL)
  RETURN learneroutcome_REF

Locks the learner outcome record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8)  Required Key.
p_seq_no   Degree Sequence Number: Number assigned to each of the learner's outcome records. NUMBER(2)  Required Key.

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


p_create

Procedure p_create(p_pidm                shrdgmr.shrdgmr_pidm%TYPE,
                   p_seq_no              shrdgmr.shrdgmr_seq_no%TYPE,
                   p_degs_code           shrdgmr.shrdgmr_degs_code%TYPE,
                   p_appl_date           shrdgmr.shrdgmr_appl_date%TYPE DEFAULT NULL,
                   p_grad_date           shrdgmr.shrdgmr_grad_date%TYPE DEFAULT NULL,
                   p_acyr_code_bulletin  shrdgmr.shrdgmr_acyr_code_bulletin%TYPE DEFAULT NULL,
                   p_term_code_sturec    shrdgmr.shrdgmr_term_code_sturec%TYPE,
                   p_term_code_grad      shrdgmr.shrdgmr_term_code_grad%TYPE DEFAULT NULL,
                   p_acyr_code           shrdgmr.shrdgmr_acyr_code%TYPE DEFAULT NULL,
                   p_grst_code           shrdgmr.shrdgmr_grst_code%TYPE DEFAULT NULL,
                   p_fee_ind             shrdgmr.shrdgmr_fee_ind%TYPE DEFAULT NULL,
                   p_fee_date            shrdgmr.shrdgmr_fee_date%TYPE DEFAULT NULL,
                   p_authorized          shrdgmr.shrdgmr_authorized%TYPE DEFAULT NULL,
                   p_term_code_completed shrdgmr.shrdgmr_term_code_completed%TYPE DEFAULT NULL,
                   p_degc_code_dual      shrdgmr.shrdgmr_degc_code_dual%TYPE DEFAULT NULL,
                   p_levl_code_dual      shrdgmr.shrdgmr_levl_code_dual%TYPE DEFAULT NULL,
                   p_dept_code_dual      shrdgmr.shrdgmr_dept_code_dual%TYPE DEFAULT NULL,
                   p_coll_code_dual      shrdgmr.shrdgmr_coll_code_dual%TYPE DEFAULT NULL,
                   p_majr_code_dual      shrdgmr.shrdgmr_majr_code_dual%TYPE DEFAULT NULL,
                   p_user_id             shrdgmr.shrdgmr_user_id%TYPE DEFAULT NULL,
                   p_data_origin         shrdgmr.shrdgmr_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out           OUT VARCHAR2,
                   p_stsp_key_sequence   shrdgmr.shrdgmr_stsp_key_sequence%TYPE DEFAULT NULL)

Creates a learner outcome record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key.
p_seq_no   Degree Sequence Number: Number assigned to each of the learner's outcome records.  NUMBER(2)  Required Key.
p_degs_code   Degree Status Code: Status of the learner's degree, for example sought, awarded, etc. VARCHAR2(6) Required Key.
p_appl_date   Degree Application Date: Date of the degree application. Defaults to the current date on entry of the degree. DATE  Required Key.
p_grad_date   Graduation Date: Graduation date of the learner.  DATE  Required Key.
p_acyr_code_bulletin   Degree Bulletin Year: Year of the  bulletin or catalog under which the degree is being offered. VARCHAR2(4)  Required Key.
p_term_code_grad   Graduation Term: Term in which the learner graduates.  VARCHAR2(6)  Required Key.
p_term_code_sturec   Learner Effective Term: Term from which the learner record outcome record is rolled. VARCHAR2(6) Required Key.
p_acyr_code   Academic Year: Year in which the learner graduates.  VARCHAR2(4)  Required Key.
p_grst_code   Graduation status.  Status code of the graduation record.  VARCHAR2(3)  Required Key.
p_fee_ind   Fee Indicator: Identifies whether a graduation fee was assessed.  VARCHAR2(1)  Required Key.
p_fee_date   Fee Date: Date the graduation fee was assessed.  DaTE  Required Key.
p_authorized   Authorized User: Oracle user ID and the graduation status joined together to identify the person who authorized graduation adds or changes.  VARCHAR2(33)  Required Key.
p_term_code_completed   Term Completed: Term designated as the term in which graduate work must be completed.  VARCHAR2(6) Required Key.
p_degc_code_dual   Dual Degree: Degree code for a dual degree. VARCHAR2(6)  Required Key.
p_levl_code_dual   Dual Degree Level: Level code for a dual degree. VARCHAR2(2)  Required Key.
p_dept_code_dual   Dual Degree Department: Department code for a dual degree.  VARCHAR2(4)  Required Key.
p_coll_code_dual   Dual Degree College: College code for a dual degree. VARCHAR2(2)  Required Key.
p_majr_code_dual   Dual Degree Major: Major code for a dual degree.  VARCHAR2(4)  Required Key.
p_user_id   User: Oracle ID of the user who last updated or inserted the row. VARCHAR2(30)Required Key.
p_data_origin   Data Origin: Origin of where the data was entered.  VARCHAR2(18)  Required Key.
p_rowid_out   Database ROWID of the record to be created.  VARCHAR2(18).
p_stsp_key_sequence   Study Path Sequence:  The Study Path sequence from the learner curriculum rolled to the outcome.


p_delete

Procedure p_delete(p_pidm   shrdgmr.shrdgmr_pidm%TYPE,
                   p_seq_no shrdgmr.shrdgmr_seq_no%TYPE,
                   p_rowid  VARCHAR2 DEFAULT NULL)

Deletes a learner outcome record.
The other records deleted for the learner outcome include:


Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8)  Required Key.
p_seq_no   Degree Sequence Number: Number assigned to each of the learner's outcome records. NUMBER(2)  Required Key.
p_rowid   Database ROWID of the record to be deleted.


p_lock

Procedure p_lock(p_pidm        shrdgmr.shrdgmr_pidm%TYPE,
                 p_seq_no      shrdgmr.shrdgmr_seq_no%TYPE,
                 p_rowid_inout IN OUT VARCHAR2)

Locks a learner outcome record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8)  Required Key.
p_seq_no   Degree Sequence Number: Number assigned to each of the learner's outcome records. NUMBER(2)  Required Key.


p_update

Procedure p_update(p_pidm                shrdgmr.shrdgmr_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_seq_no              shrdgmr.shrdgmr_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_degs_code           shrdgmr.shrdgmr_degs_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_appl_date           shrdgmr.shrdgmr_appl_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_grad_date           shrdgmr.shrdgmr_grad_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_acyr_code_bulletin  shrdgmr.shrdgmr_acyr_code_bulletin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_sturec    shrdgmr.shrdgmr_term_code_sturec%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_grad      shrdgmr.shrdgmr_term_code_grad%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acyr_code           shrdgmr.shrdgmr_acyr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_grst_code           shrdgmr.shrdgmr_grst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fee_ind             shrdgmr.shrdgmr_fee_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fee_date            shrdgmr.shrdgmr_fee_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_authorized          shrdgmr.shrdgmr_authorized%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_completed shrdgmr.shrdgmr_term_code_completed%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_degc_code_dual      shrdgmr.shrdgmr_degc_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_levl_code_dual      shrdgmr.shrdgmr_levl_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dept_code_dual      shrdgmr.shrdgmr_dept_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_code_dual      shrdgmr.shrdgmr_coll_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_majr_code_dual      shrdgmr.shrdgmr_majr_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id             shrdgmr.shrdgmr_user_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin         shrdgmr.shrdgmr_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid               VARCHAR2 DEFAULT NULL,
                   p_stsp_key_sequence   shrdgmr.shrdgmr_stsp_key_sequence%TYPE DEFAULT dml_common.f_unspecified_number)

Updates a learner outcome record.
This signature registers all the parameters.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key.
p_seq_no   Degree Sequence Number: Number assigned to each of the learner's outcome records.  NUMBER(2)  Required Key.
p_degs_code   Degree Status Code: Status of the learner's degree, for example sought, awarded, etc. VARCHAR2(6) Required Key.
p_appl_date   Degree Application Date: Date of the degree application. Defaults to the current date on entry of the degree.
p_grad_date   Graduation Date: Graduation date of the learner.  DATE  Required Key.
p_acyr_code_bulletin   Degree Bulletin Year: Year of the  bulletin or catalog under which the degree is being offered. VARCHAR2(4)  Required Key.
p_term_code_grad   Graduation Term: Term in which the learner graduates.  VARCHAR2(6)  Required Key.
p_term_code_sturec   Learner Effective Term: Term from which the learner record outcome record is rolled. VARCHAR2(6) Required Key.
p_acyr_code   Academic Year: Year in which the learner graduates.  VARCHAR2(4)  Required Key.
p_grst_code   Graduation status.  Status code of the graduation record.  VARCHAR2(3)  Required Key.
p_fee_ind   Fee Indicator: Identifies whether a graduation fee was assessed.  VARCHAR2(1)  Required Key.
p_fee_date   Fee Date: Date the graduation fee was assessed.  DaTE  Required Key.
p_authorized   Authorized User: Oracle user ID and the graduation status joined together to identify the person who authorized graduation adds or changes.  VARCHAR2(33)  Required Key.
p_term_code_completed   Term Completed: Term designated as the term in which graduate work must be completed.  VARCHAR2(6) Required Key.
p_degc_code_dual   Dual Degree: Degree code for a dual degree. VARCHAR2(6)  Required Key.
p_levl_code_dual   Dual Degree Level: Level code for a dual degree. VARCHAR2(2)  Required Key.
p_dept_code_dual   Dual Degree Department: Department code for a dual degree.  VARCHAR2(4)  Required Key.
p_coll_code_dual   Dual Degree College: College code for a dual degree. VARCHAR2(2)  Required Key.
p_majr_code_dual   Dual Degree Major: Major code for a dual degree.  VARCHAR2(4)  Required Key.
p_user_id   User: Oracle ID of the user who last updated or inserted the row. VARCHAR2(30)Required Key.
p_data_origin   Data Origin: Origin of where the data was entered.  VARCHAR2(18)  Required Key.
p_rowid   Database ROWID of the record to be updated.  VARCHAR2(18).
p_stsp_key_sequence   Study Path Sequence:  The Study Path sequence from the learner curriculum rolled to the outcome.