index

Package sb_learner

This package provides the Common Business interface for the Learner API (sb_learner).
The learner record is created at admissions and is required for registration.  Once the student registers for courses,  data that impacts fee assessment, course prerequisits or restrictions can be updated only on the registration page.
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 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 record.


Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if a learner exists for the internal personal identification number (PIDM) and effective term.
f_isequal   Compares two learner records for equality.
f_query_all   Selects all records for the learner.
f_query_one   Selects one record for the internal personal identification number (PIDM) and effective term.
f_query_by_rowid   Selects one learner using the ROWID.
f_query_current   Selects the learner record current for the input effective term.
f_query_end   Selects the end term for a learner record.
f_query_one_lock   Locks a learner record.
f_eligible_to_register   Queries for the current learner record.
p_copy_learner   Copies an existing learner record with a new effective term.
p_create   Creates a learner record.
p_delete   Deletes a learner record.
p_lock   Locks a learner record.
p_update   Updates a learner record.

Types
learner_rec   Learner record type.
learner_ref   Learner cursor variable type.
learner_tab   Learner table type.

Constants
M_ENTITY_NAME   Business Entity Name.


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(7) := 'LEARNER';

Business Entity Name.


learner_rec

TYPE learner_rec IS RECORD (
   r_pidm                    sgbstdn.sgbstdn_pidm%TYPE,
   r_term_code_eff           sgbstdn.sgbstdn_term_code_eff%TYPE,
   r_stst_code               sgbstdn.sgbstdn_stst_code%TYPE,
   r_levl_code               sgbstdn.sgbstdn_levl_code%TYPE,
   r_styp_code               sgbstdn.sgbstdn_styp_code%TYPE,
   r_term_code_matric        sgbstdn.sgbstdn_term_code_matric%TYPE,
   r_term_code_admit         sgbstdn.sgbstdn_term_code_admit%TYPE,
   r_exp_grad_date           sgbstdn.sgbstdn_exp_grad_date%TYPE,
   r_camp_code               sgbstdn.sgbstdn_camp_code%TYPE,
   r_full_part_ind           sgbstdn.sgbstdn_full_part_ind%TYPE,
   r_sess_code               sgbstdn.sgbstdn_sess_code%TYPE,
   r_resd_code               sgbstdn.sgbstdn_resd_code%TYPE,
   r_coll_code_1             sgbstdn.sgbstdn_coll_code_1%TYPE,
   r_degc_code_1             sgbstdn.sgbstdn_degc_code_1%TYPE,
   r_majr_code_1             sgbstdn.sgbstdn_majr_code_1%TYPE,
   r_majr_code_minr_1        sgbstdn.sgbstdn_majr_code_minr_1%TYPE,
   r_majr_code_minr_1_2      sgbstdn.sgbstdn_majr_code_minr_1_2%TYPE,
   r_majr_code_conc_1        sgbstdn.sgbstdn_majr_code_conc_1%TYPE,
   r_majr_code_conc_1_2      sgbstdn.sgbstdn_majr_code_conc_1_2%TYPE,
   r_majr_code_conc_1_3      sgbstdn.sgbstdn_majr_code_conc_1_3%TYPE,
   r_coll_code_2             sgbstdn.sgbstdn_coll_code_2%TYPE,
   r_degc_code_2             sgbstdn.sgbstdn_degc_code_2%TYPE,
   r_majr_code_2             sgbstdn.sgbstdn_majr_code_2%TYPE,
   r_majr_code_minr_2        sgbstdn.sgbstdn_majr_code_minr_2%TYPE,
   r_majr_code_minr_2_2      sgbstdn.sgbstdn_majr_code_minr_2_2%TYPE,
   r_majr_code_conc_2        sgbstdn.sgbstdn_majr_code_conc_2%TYPE,
   r_majr_code_conc_2_2      sgbstdn.sgbstdn_majr_code_conc_2_2%TYPE,
   r_majr_code_conc_2_3      sgbstdn.sgbstdn_majr_code_conc_2_3%TYPE,
   r_orsn_code               sgbstdn.sgbstdn_orsn_code%TYPE,
   r_prac_code               sgbstdn.sgbstdn_prac_code%TYPE,
   r_advr_pidm               sgbstdn.sgbstdn_advr_pidm%TYPE,
   r_grad_credit_appr_ind    sgbstdn.sgbstdn_grad_credit_appr_ind%TYPE,
   r_capl_code               sgbstdn.sgbstdn_capl_code%TYPE,
   r_leav_code               sgbstdn.sgbstdn_leav_code%TYPE,
   r_leav_from_date          sgbstdn.sgbstdn_leav_from_date%TYPE,
   r_leav_to_date            sgbstdn.sgbstdn_leav_to_date%TYPE,
   r_astd_code               sgbstdn.sgbstdn_astd_code%TYPE,
   r_term_code_astd          sgbstdn.sgbstdn_term_code_astd%TYPE,
   r_rate_code               sgbstdn.sgbstdn_rate_code%TYPE,
   r_majr_code_1_2           sgbstdn.sgbstdn_majr_code_1_2%TYPE,
   r_majr_code_2_2           sgbstdn.sgbstdn_majr_code_2_2%TYPE,
   r_edlv_code               sgbstdn.sgbstdn_edlv_code%TYPE,
   r_incm_code               sgbstdn.sgbstdn_incm_code%TYPE,
   r_admt_code               sgbstdn.sgbstdn_admt_code%TYPE,
   r_emex_code               sgbstdn.sgbstdn_emex_code%TYPE,
   r_aprn_code               sgbstdn.sgbstdn_aprn_code%TYPE,
   r_trcn_code               sgbstdn.sgbstdn_trcn_code%TYPE,
   r_gain_code               sgbstdn.sgbstdn_gain_code%TYPE,
   r_voed_code               sgbstdn.sgbstdn_voed_code%TYPE,
   r_blck_code               sgbstdn.sgbstdn_blck_code%TYPE,
   r_term_code_grad          sgbstdn.sgbstdn_term_code_grad%TYPE,
   r_acyr_code               sgbstdn.sgbstdn_acyr_code%TYPE,
   r_dept_code               sgbstdn.sgbstdn_dept_code%TYPE,
   r_site_code               sgbstdn.sgbstdn_site_code%TYPE,
   r_dept_code_2             sgbstdn.sgbstdn_dept_code_2%TYPE,
   r_egol_code               sgbstdn.sgbstdn_egol_code%TYPE,
   r_degc_code_dual          sgbstdn.sgbstdn_degc_code_dual%TYPE,
   r_levl_code_dual          sgbstdn.sgbstdn_levl_code_dual%TYPE,
   r_dept_code_dual          sgbstdn.sgbstdn_dept_code_dual%TYPE,
   r_coll_code_dual          sgbstdn.sgbstdn_coll_code_dual%TYPE,
   r_majr_code_dual          sgbstdn.sgbstdn_majr_code_dual%TYPE,
   r_bskl_code               sgbstdn.sgbstdn_bskl_code%TYPE,
   r_prim_roll_ind           sgbstdn.sgbstdn_prim_roll_ind%TYPE,
   r_program_1               sgbstdn.sgbstdn_program_1%TYPE,
   r_term_code_ctlg_1        sgbstdn.sgbstdn_term_code_ctlg_1%TYPE,
   r_dept_code_1_2           sgbstdn.sgbstdn_dept_code_1_2%TYPE,
   r_majr_code_conc_121      sgbstdn.sgbstdn_majr_code_conc_121%TYPE,
   r_majr_code_conc_122      sgbstdn.sgbstdn_majr_code_conc_122%TYPE,
   r_majr_code_conc_123      sgbstdn.sgbstdn_majr_code_conc_123%TYPE,
   r_secd_roll_ind           sgbstdn.sgbstdn_secd_roll_ind%TYPE,
   r_term_code_admit_2       sgbstdn.sgbstdn_term_code_admit_2%TYPE,
   r_admt_code_2             sgbstdn.sgbstdn_admt_code_2%TYPE,
   r_program_2               sgbstdn.sgbstdn_program_2%TYPE,
   r_term_code_ctlg_2        sgbstdn.sgbstdn_term_code_ctlg_2%TYPE,
   r_levl_code_2             sgbstdn.sgbstdn_levl_code_2%TYPE,
   r_camp_code_2             sgbstdn.sgbstdn_camp_code_2%TYPE,
   r_dept_code_2_2           sgbstdn.sgbstdn_dept_code_2_2%TYPE,
   r_majr_code_conc_221      sgbstdn.sgbstdn_majr_code_conc_221%TYPE,
   r_majr_code_conc_222      sgbstdn.sgbstdn_majr_code_conc_222%TYPE,
   r_majr_code_conc_223      sgbstdn.sgbstdn_majr_code_conc_223%TYPE,
   r_curr_rule_1             sgbstdn.sgbstdn_curr_rule_1%TYPE,
   r_cmjr_rule_1_1           sgbstdn.sgbstdn_cmjr_rule_1_1%TYPE,
   r_ccon_rule_11_1          sgbstdn.sgbstdn_ccon_rule_11_1%TYPE,
   r_ccon_rule_11_2          sgbstdn.sgbstdn_ccon_rule_11_2%TYPE,
   r_ccon_rule_11_3          sgbstdn.sgbstdn_ccon_rule_11_3%TYPE,
   r_cmjr_rule_1_2           sgbstdn.sgbstdn_cmjr_rule_1_2%TYPE,
   r_ccon_rule_12_1          sgbstdn.sgbstdn_ccon_rule_12_1%TYPE,
   r_ccon_rule_12_2          sgbstdn.sgbstdn_ccon_rule_12_2%TYPE,
   r_ccon_rule_12_3          sgbstdn.sgbstdn_ccon_rule_12_3%TYPE,
   r_cmnr_rule_1_1           sgbstdn.sgbstdn_cmnr_rule_1_1%TYPE,
   r_cmnr_rule_1_2           sgbstdn.sgbstdn_cmnr_rule_1_2%TYPE,
   r_curr_rule_2             sgbstdn.sgbstdn_curr_rule_2%TYPE,
   r_cmjr_rule_2_1           sgbstdn.sgbstdn_cmjr_rule_2_1%TYPE,
   r_ccon_rule_21_1          sgbstdn.sgbstdn_ccon_rule_21_1%TYPE,
   r_ccon_rule_21_2          sgbstdn.sgbstdn_ccon_rule_21_2%TYPE,
   r_ccon_rule_21_3          sgbstdn.sgbstdn_ccon_rule_21_3%TYPE,
   r_cmjr_rule_2_2           sgbstdn.sgbstdn_cmjr_rule_2_2%TYPE,
   r_ccon_rule_22_1          sgbstdn.sgbstdn_ccon_rule_22_1%TYPE,
   r_ccon_rule_22_2          sgbstdn.sgbstdn_ccon_rule_22_2%TYPE,
   r_ccon_rule_22_3          sgbstdn.sgbstdn_ccon_rule_22_3%TYPE,
   r_cmnr_rule_2_1           sgbstdn.sgbstdn_cmnr_rule_2_1%TYPE,
   r_cmnr_rule_2_2           sgbstdn.sgbstdn_cmnr_rule_2_2%TYPE,
   r_prev_code               sgbstdn.sgbstdn_prev_code%TYPE,
   r_term_code_prev          sgbstdn.sgbstdn_term_code_prev%TYPE,
   r_cast_code               sgbstdn.sgbstdn_cast_code%TYPE,
   r_term_code_cast          sgbstdn.sgbstdn_term_code_cast%TYPE,
   r_user_id                 sgbstdn.sgbstdn_user_id%TYPE,
   r_data_origin             sgbstdn.sgbstdn_data_origin%TYPE,
   r_scpc_code                       sgbstdn.sgbstdn_scpc_code%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type
    );

Learner record type. Includes curriculum fields, which are back-filled from curriculum and field of study tables SORLCUR and SORLFOS. There are no direct updates to those data columns.  The backfilled data remains available for query only from the learner API.


learner_ref

TYPE learner_ref IS REF CURSOR RETURN learner_rec;

Learner cursor variable type.


learner_tab

TYPE learner_tab IS TABLE OF learner_rec INDEX BY BINARY_INTEGER;

Learner 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          sgbstdn.sgbstdn_pidm%TYPE,
                  p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE,
                  p_rowid         VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a learner exists for the internal personal identification number (PIDM) and effective term.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8)  Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record.  VARCHAR2(6)  Required Key.

Returns
TRUE if found, otherwise FALSE.


f_isequal

Function f_isequal(rec_one learner_rec, rec_two learner_rec)
  RETURN VARCHAR2

Compares two learner records for equality.

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


f_query_all

Function f_query_all(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                     p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE DEFAULT NULL)
  RETURN learner_REF

Selects all 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_term_code   EFF TERM: Effective term of the learner record.  VARCHAR2(6)   Optional Key.

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


f_query_one

Function f_query_one(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                     p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE)
  RETURN learner_REF

Selects one record for the internal personal identification number (PIDM) and effective term.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8)  Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record.  VARCHAR2(6)  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 learner_ref

Selects one learner using the ROWID.

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

Returns
A cursor variable that will fetch exactly one record.


f_query_current

Function f_query_current(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                         p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE)
  RETURN varchar2

Selects the learner record current for the input effective term.  This will always be the learner record with the maximum effective term that is less than or equal to the input effective term.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8)  Required Key.
p_term_code_eff   TERM EFF: Effective term of the learner record.  VARCHAR2(6)  Required Key.

Returns
Effective term code for the current learner record.


f_query_end

Function f_query_end(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                     p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE)
  RETURN varchar2

Selects the end term for a learner record.  The end term is set to 999999 if no other learner records exist for the person or that have a higher effective term.  Otherwise, it is the next effective term code for the learner.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8)  Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record.  VARCHAR2(6)  Required Key.

Returns
Term code that marks the end of the current SGBSTDN row for the input term and PIDM.


f_query_one_lock

Function f_query_one_lock(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                          p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE,
                          p_rowid         VARCHAR2 DEFAULT NULL)
  RETURN learner_REF

Locks a learner record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8)  Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record.  VARCHAR2(6)  Required Key.

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


f_eligible_to_register

Function f_eligible_to_register(p_pidm      sgbstdn.sgbstdn_pidm%TYPE,
                                p_term_code sgbstdn.sgbstdn_term_code_eff%TYPE)
  RETURN VARCHAR2

Queries for the current learner record.  The current learner record is always the one with the maximum effective term that is less than or equal to the input term code.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system.  NUMBER(8)  Required Key.
p_term_code   EFF TERM: Term code for which the learner is requesting registration.  VARCHAR2(6)  Required Key.

Returns
N if the learner does not have student record.
R if the learner record exists but the student status does not allow registration.
A if the learner record exists but the student academic standing does not allow registration
C if the learner record exists but the student combined academic standing does not allow registration
Y if the learner record exists and the student status, academic status and combined academic standing status allows registration.


p_copy_learner

Procedure p_copy_learner(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                         p_term_code_old sgbstdn.sgbstdn_term_code_eff%TYPE,
                         p_term_code_new sgbstdn.sgbstdn_term_code_eff%TYPE)

Copies an existing learner record with a new effective term.
All columns are copied with the exception of the progress evaluation, academic standing override and combined academic standing code and the associated term codes.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8)  Required Key.
p_term_code_old   OLD EFF TERM: Effective term associated with student record that is to be copied. VARCHAR2(6)  Required Key.
p_term_code_new   NEW EFF TERM: Effective term associated with student record that will be on the newly duplicated record. VARCHAR2(6)  Required Key.


p_create

Procedure p_create(p_pidm                 sgbstdn.sgbstdn_pidm%TYPE,
                   p_term_code_eff        sgbstdn.sgbstdn_term_code_eff%TYPE,
                   p_stst_code            sgbstdn.sgbstdn_stst_code%TYPE,
                   p_styp_code            sgbstdn.sgbstdn_styp_code%TYPE,
                   p_exp_grad_date        sgbstdn.sgbstdn_exp_grad_date%TYPE DEFAULT NULL,
                   p_full_part_ind        sgbstdn.sgbstdn_full_part_ind%TYPE DEFAULT NULL,
                   p_sess_code            sgbstdn.sgbstdn_sess_code%TYPE DEFAULT NULL,
                   p_resd_code            sgbstdn.sgbstdn_resd_code%TYPE DEFAULT NULL,
                   p_orsn_code            sgbstdn.sgbstdn_orsn_code%TYPE DEFAULT NULL,
                   p_prac_code            sgbstdn.sgbstdn_prac_code%TYPE DEFAULT NULL,
                   p_advr_pidm            sgbstdn.sgbstdn_advr_pidm%TYPE DEFAULT NULL,
                   p_grad_credit_appr_ind sgbstdn.sgbstdn_grad_credit_appr_ind%TYPE DEFAULT NULL,
                   p_capl_code            sgbstdn.sgbstdn_capl_code%TYPE DEFAULT NULL,
                   p_leav_code            sgbstdn.sgbstdn_leav_code%TYPE DEFAULT NULL,
                   p_leav_from_date       sgbstdn.sgbstdn_leav_from_date%TYPE DEFAULT NULL,
                   p_leav_to_date         sgbstdn.sgbstdn_leav_to_date%TYPE DEFAULT NULL,
                   p_astd_code            sgbstdn.sgbstdn_astd_code%TYPE DEFAULT NULL,
                   p_term_code_astd       sgbstdn.sgbstdn_term_code_astd%TYPE DEFAULT NULL,
                   p_rate_code            sgbstdn.sgbstdn_rate_code%TYPE DEFAULT NULL,
                   p_edlv_code            sgbstdn.sgbstdn_edlv_code%TYPE DEFAULT NULL,
                   p_incm_code            sgbstdn.sgbstdn_incm_code%TYPE DEFAULT NULL,
                   p_emex_code            sgbstdn.sgbstdn_emex_code%TYPE DEFAULT NULL,
                   p_aprn_code            sgbstdn.sgbstdn_aprn_code%TYPE DEFAULT NULL,
                   p_trcn_code            sgbstdn.sgbstdn_trcn_code%TYPE DEFAULT NULL,
                   p_gain_code            sgbstdn.sgbstdn_gain_code%TYPE DEFAULT NULL,
                   p_voed_code            sgbstdn.sgbstdn_voed_code%TYPE DEFAULT NULL,
                   p_blck_code            sgbstdn.sgbstdn_blck_code%TYPE DEFAULT NULL,
                   p_term_code_grad       sgbstdn.sgbstdn_term_code_grad%TYPE DEFAULT NULL,
                   p_acyr_code            sgbstdn.sgbstdn_acyr_code%TYPE DEFAULT NULL,
                   p_site_code            sgbstdn.sgbstdn_site_code%TYPE DEFAULT NULL,
                   p_egol_code            sgbstdn.sgbstdn_egol_code%TYPE DEFAULT NULL,
                   p_degc_code_dual       sgbstdn.sgbstdn_degc_code_dual%TYPE DEFAULT NULL,
                   p_levl_code_dual       sgbstdn.sgbstdn_levl_code_dual%TYPE DEFAULT NULL,
                   p_dept_code_dual       sgbstdn.sgbstdn_dept_code_dual%TYPE DEFAULT NULL,
                   p_coll_code_dual       sgbstdn.sgbstdn_coll_code_dual%TYPE DEFAULT NULL,
                   p_majr_code_dual       sgbstdn.sgbstdn_majr_code_dual%TYPE DEFAULT NULL,
                   p_bskl_code            sgbstdn.sgbstdn_bskl_code%TYPE DEFAULT NULL,
                   p_prev_code            sgbstdn.sgbstdn_prev_code%TYPE DEFAULT NULL,
                   p_term_code_prev       sgbstdn.sgbstdn_term_code_prev%TYPE DEFAULT NULL,
                   p_cast_code            sgbstdn.sgbstdn_cast_code%TYPE DEFAULT NULL,
                   p_term_code_cast       sgbstdn.sgbstdn_term_code_cast%TYPE DEFAULT NULL,
                   p_user_id              sgbstdn.sgbstdn_user_id%TYPE DEFAULT NULL,
                   p_data_origin          sgbstdn.sgbstdn_data_origin%TYPE DEFAULT NULL,
                   p_scpc_code            sgbstdn.sgbstdn_scpc_code%TYPE DEFAULT NULL,
                   p_rowid_out            OUT VARCHAR2)

Creates a learner record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8)  Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record. VARCHAR2(6)  Required Key.
p_stst_code   STATUS: Student's status for the effective term.  VARCHAR2(2)  Required Key.
p_styp_code   STUDENT TYPE: Student type for the effective term.  VARCHAR2(1)  Required Key.
p_exp_grad_date   EXPECTED GRAD: Expected graduation date.  DATE  Optional Key.
p_full_part_ind   FULL PART: Specifies whether the student is a full- or part-time student.  VARCHAR2(1)  Optional Key.
p_sess_code   SESSION: Session that the student is attending for the effective term.  VARCHAR2(6)  Optional Key.
p_resd_code   RESIDENCE: Residency status of the student for the effective term.  VARCHAR2(1)  Optional Key.
p_orsn_code   ORIENTATION: Orientation session assigned to the student for the effective term.  VARCHAR2(1)  Optional Key.
p_prac_code   PRAC TRAINING: Practical training experience of the student for the  effective term.  VARCHAR2(2)  Optional Key.
p_advr_pidm   ADVISOR: Internal identification number for the advisor assigned to the student for the effective term.  NUMBER(8)  Optional Key.
p_grad_credit_appr_ind   GRAD CREDIT:  Eligibility of the student to take graduate courses for credit for the effective term. Valid values are Y or blank only.  VARCHAR2(1)  Optional Key.
p_capl_code   CAREER: Career plan of the student for the effective term.  VARCHAR2(2)  Optional Key.
p_leav_code   LEAVE: Reason for the student's leave of absence for the effective term.  VARCHAR2(1)  Optional Key.
p_leav_from_date   LEAVE FROM DATE: Begin date for the student's leave of absence for the effective term.  DATE  Optional Key.
p_leav_to_date   LEAVE TO DATE: End date for the student's leave of absence for the effective term.  DATE  Optional Key.
p_astd_code   ACAD STAND: Academic standing override for the student for the effective term.  VARCHAR2(2)  Optional Key.
p_term_code_astd   ACAD STAND TERM: Term associated with the academic standing override.  VARCHAR2(6)  Optional Key.
p_rate_code   RATE: Specific assessment rate of the student for the effective term. VARCHAR2(5)   Optional Key.
p_edlv_code   EDUCATION LEVEL: Two-position alphanumeric field used to indicate the highest level of education that the student completed.  VARCHAR2(3) Optional Key.
p_incm_code   INCOME: Two-position alphanumeric field used to indicate the income range of the student.  VARCHAR2(2)  Optional Key.
p_admt_code   ADMISSIONS: Admissions type from the admissions application.  VARCHAR2(2)  Optional Key.
p_emex_code   EMPLOY EXPEPT: General Student Employment Expectation Code.  VARCHAR2(2)  Optional Key.
p_aprn_code   APPRENTICESHIP: General Student Apprenticeship Code.  VARCHAR2(2)  Optional Key.
p_trcn_code   TRANSFER: General Student Transfer Center Code.  VARCHAR2(2)  Optional Key.
p_gain_code   EMPLOY TRAINING: Employment and training code of the student for the effective term.  VARCHAR2(2)  Optional Key.
p_voed_code   VOCATIONAL: General Student Vocation Education Status Code  VARCHAR2(2) Optional Key.
p_blck_code   BLOCK: Block Schedule Code.  VARCHAR2(10)  Optional Key.
p_term_code_grad   GRAD TERM: Term that the student intends to graduate.  VARCHAR2(6)  Optional Key.
p_acyr_code   GRAD YEAR: Year that the student intends to graduate.  VARCHAR2(4)  Optional Key.
p_site_code   SITE: Site Code.  VARCHAR2(3)  Optional Key.
p_egol_code   EDUC LEVEL: Educational Goal code. VARCHAR2(2)  Optional Key.
p_degc_code_dual   DUAL DEGREE: Degree code for a dual degree. VARCHAR2(6)  Optional Key.
p_levl_code_dual   DUAL LEVEL: Level code for a dual degree. VARCHAR2(2)  Optional Key.
p_dept_code_dual   DUAL DEPARTMENT: Department code for a dual degree. VARCHAR2(4)  Optional Key.
p_coll_code_dual   DUAL COLLEGE: College code for a dual degree. VARCHAR2(2)  Optional Key.
p_majr_code_dual   DUAL MAJOR: Major code for a dual degree. VARCHAR2(4)  Optional Key.
p_bskl_code   BASIC SKILLS: Student Basic Skills Code.  VARCHAR2(2)  Optional Key.
p_prev_code   PROG EVAL: General Student record Progress Evaluation code.  This code overrides the code in table SHRTTRM.  VARCHAR2(2)  Optional Key.
p_term_code_prev   PROG EVAL TERM: General Student record Progress Evaluation term.  This is the term for which the progress evaluation code override becomes effective.  VARCHAR2(6)  Optional Key.
p_cast_code   COMBINED ACAD STAND: General Student record Combined Academic Standing code.  This code overrides the code in table SHRTTRM.  VARCHAR2(2)  Optional Key.
p_term_code_cast   COMBINED ACAD STAND TERM: General Student record Combined Academic Standing term.  This is the term for which the combined academic standing code override becomes effective.  VARCHAR2(6)  Optional Key.
p_user_id   USER: Oracle ID of the person who updated the record.  VARCHAR2(30)  Required Key.
p_data_origin   DATA ORIGIN: Origination of the data.  VARCHAR2(30)  Required Key.
p_rowid_out   Database ROWID of the record to be created.    VARCHAR2(18)
p_scpc_code   STUDENT CENTRIC PERIOD CYCLE: Cycle Code for the student centric semester. Varchar2(6) Optional key.


p_delete

Procedure p_delete(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                   p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE,
                   p_rowid         VARCHAR2 DEFAULT NULL)

Deletes a learner record. This will also delete all learner curriculum and field of study if the learner record being deleted is the last for the learner.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record.  Required Key.
p_rowid   Database ROWID of the record to deleted.  Optional Key.


p_lock

Procedure p_lock(p_pidm          sgbstdn.sgbstdn_pidm%TYPE,
                 p_term_code_eff sgbstdn.sgbstdn_term_code_eff%TYPE,
                 p_rowid_inout   IN OUT VARCHAR2)

Locks a learner record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. Required Key.  Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record.  Required Key.


p_update

Procedure p_update(p_pidm                 sgbstdn.sgbstdn_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_term_code_eff        sgbstdn.sgbstdn_term_code_eff%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stst_code            sgbstdn.sgbstdn_stst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_styp_code            sgbstdn.sgbstdn_styp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_exp_grad_date        sgbstdn.sgbstdn_exp_grad_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_full_part_ind        sgbstdn.sgbstdn_full_part_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sess_code            sgbstdn.sgbstdn_sess_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_resd_code            sgbstdn.sgbstdn_resd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orsn_code            sgbstdn.sgbstdn_orsn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prac_code            sgbstdn.sgbstdn_prac_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_advr_pidm            sgbstdn.sgbstdn_advr_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_grad_credit_appr_ind sgbstdn.sgbstdn_grad_credit_appr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_capl_code            sgbstdn.sgbstdn_capl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_leav_code            sgbstdn.sgbstdn_leav_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_leav_from_date       sgbstdn.sgbstdn_leav_from_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_leav_to_date         sgbstdn.sgbstdn_leav_to_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_astd_code            sgbstdn.sgbstdn_astd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_astd       sgbstdn.sgbstdn_term_code_astd%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rate_code            sgbstdn.sgbstdn_rate_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_edlv_code            sgbstdn.sgbstdn_edlv_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_incm_code            sgbstdn.sgbstdn_incm_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_emex_code            sgbstdn.sgbstdn_emex_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_aprn_code            sgbstdn.sgbstdn_aprn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trcn_code            sgbstdn.sgbstdn_trcn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_gain_code            sgbstdn.sgbstdn_gain_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_voed_code            sgbstdn.sgbstdn_voed_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_blck_code            sgbstdn.sgbstdn_blck_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_grad       sgbstdn.sgbstdn_term_code_grad%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acyr_code            sgbstdn.sgbstdn_acyr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_site_code            sgbstdn.sgbstdn_site_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_egol_code            sgbstdn.sgbstdn_egol_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_degc_code_dual       sgbstdn.sgbstdn_degc_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_levl_code_dual       sgbstdn.sgbstdn_levl_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dept_code_dual       sgbstdn.sgbstdn_dept_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_code_dual       sgbstdn.sgbstdn_coll_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_majr_code_dual       sgbstdn.sgbstdn_majr_code_dual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bskl_code            sgbstdn.sgbstdn_bskl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prev_code            sgbstdn.sgbstdn_prev_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_prev       sgbstdn.sgbstdn_term_code_prev%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cast_code            sgbstdn.sgbstdn_cast_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_cast       sgbstdn.sgbstdn_term_code_cast%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id              sgbstdn.sgbstdn_user_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin          sgbstdn.sgbstdn_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_scpc_code            sgbstdn.sgbstdn_scpc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                VARCHAR2 DEFAULT NULL)

Updates a learner record.

Parameters
p_pidm   PIDM: Unique internal ID for an individual who has records in the system. NUMBER(8)  Required Key.
p_term_code_eff   EFF TERM: Effective term of the learner record. VARCHAR2(6)  Required Key.
p_stst_code   STATUS: Student's status for the effective term.  VARCHAR2(2)  Required Key.
p_styp_code   STUDENT TYPE: Student type for the effective term.  VARCHAR2(1)  Required Key.
p_exp_grad_date   EXPECTED GRAD: Expected graduation date.  DATE  Optional Key.
p_full_part_ind   FULL PART: Specifies whether the student is a full- or part-time student.  VARCHAR2(1)  Optional Key.
p_sess_code   SESSION: Session that the student is attending for the effective term.  VARCHAR2(6)  Optional Key.
p_resd_code   RESIDENCE: Residency status of the student for the effective term.  VARCHAR2(1)  Optional Key.
p_orsn_code   ORIENTATION: Orientation session assigned to the student for the effective term.  VARCHAR2(1)  Optional Key.
p_prac_code   PRAC TRAINING: Practical training experience of the student for the  effective term.  VARCHAR2(2)  Optional Key.
p_advr_pidm   ADVISOR: Internal identification number for the advisor assigned to the student for the effective term.  NUMBER(8)  Optional Key.
p_grad_credit_appr_ind   GRAD CREDIT:  Eligibility of the student to take graduate courses for credit for the effective term. Valid values are Y or blank only.  VARCHAR2(1)  Optional Key.
p_capl_code   CAREER: Career plan of the student for the effective term.  VARCHAR2(2)  Optional Key.
p_leav_code   LEAVE: Reason for the student's leave of absence for the effective term.  VARCHAR2(1)  Optional Key.
p_leav_from_date   LEAVE FROM DATE: Begin date for the student's leave of absence for the effective term.  DATE  Optional Key.
p_leav_to_date   LEAVE TO DATE: End date for the student's leave of absence for the effective term.  DATE  Optional Key.
p_astd_code   ACAD STAND: Academic standing override for the student for the effective term.  VARCHAR2(2)  Optional Key.
p_term_code_astd   ACAD STAND TERM: Term associated with the academic standing override.  VARCHAR2(6)  Optional Key.
p_rate_code   RATE: Specific assessment rate of the student for the effective term. VARCHAR2(5)   Optional Key.
p_edlv_code   EDUCATION LEVEL: Two-position alphanumeric field used to indicate the highest level of education that the student completed.  VARCHAR2(3) Optional Key.
p_incm_code   INCOME: Two-position alphanumeric field used to indicate the income range of the student.  VARCHAR2(2)  Optional Key.
p_admt_code   ADMISSIONS: Admissions type from the admissions application.  VARCHAR2(2)  Optional Key.
p_emex_code   EMPLOY EXPEPT: General Student Employment Expectation Code.  VARCHAR2(2)  Optional Key.
p_aprn_code   APPRENTICESHIP: General Student Apprenticeship Code.  VARCHAR2(2)  Optional Key.
p_trcn_code   TRANSFER: General Student Transfer Center Code.  VARCHAR2(2)  Optional Key.
p_gain_code   EMPLOY TRAINING: Employment and training code of the student for the effective term.  VARCHAR2(2)  Optional Key.
p_voed_code   VOCATIONAL: General Student Vocation Education Status Code  VARCHAR2(2) Optional Key.
p_blck_code   BLOCK: Block Schedule Code.  VARCHAR2(10)  Optional Key.
p_term_code_grad   GRAD TERM: Term that the student intends to graduate.  VARCHAR2(6)  Optional Key.
p_acyr_code   GRAD YEAR: Year that the student intends to graduate.  VARCHAR2(4)  Optional Key.
p_site_code   SITE: Site Code.  VARCHAR2(3)  Optional Key.
p_egol_code   EDUC LEVEL: Educational Goal code. VARCHAR2(2)  Optional Key.
p_degc_code_dual   DUAL DEGREE: Degree code for a dual degree. VARCHAR2(6)  Optional Key.
p_levl_code_dual   DUAL LEVEL: Level code for a dual degree. VARCHAR2(2)  Optional Key.
p_dept_code_dual   DUAL DEPARTMENT: Department code for a dual degree. VARCHAR2(4)  Optional Key.
p_coll_code_dual   DUAL COLLEGE: College code for a dual degree. VARCHAR2(2)  Optional Key.
p_majr_code_dual   DUAL MAJOR: Major code for a dual degree. VARCHAR2(4)  Optional Key.
p_bskl_code   BASIC SKILLS: Student Basic Skills Code.  VARCHAR2(2)  Optional Key.
p_prev_code   PROG EVAL: General Student record Progress Evaluation code.  This code overrides the code in table SHRTTRM.  VARCHAR2(2)  Optional Key.
p_term_code_prev   PROG EVAL TERM: General Student record Progress Evaluation term.  This is the term for which the progress evaluation code override becomes effective.  VARCHAR2(6)  Optional Key.
p_cast_code   COMBINED ACAD STAND: General Student record Combined Academic Standing code.  This code overrides the code in table SHRTTRM.  VARCHAR2(2)  Optional Key.
p_term_code_cast   COMBINED ACAD STAND TERM: General Student record Combined Academic Standing term.  This is the term for which the combined academic standing code override becomes effective.  VARCHAR2(6)  Optional Key.
p_user_id   USER: Oracle ID of the person who updated the record.  VARCHAR2(30)  Required Key.
p_data_origin   DATA ORIGIN: Origination of the data.  VARCHAR2(30)  Required Key.
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)  Optional Key.
p_scpc_code   STUDENT CENTRIC PERIOD CYCLE: Cycle Code for the student centric semester. Varchar2(6) Optional key.