index

Package sb_studypath

Common Business interface for the Study Path API (sb_studypath).
 
Study Paths is an umbrella entity for learner curriculum so they can be grouped together on registration, fee assessment and academic history.  The study path is created for each application, or for each curriculum added through the quick admit process and for each curriculum added on the learner curriculum tab.
 
Study Paths is enabled by checking the enable indicator on SOACTRL, and specifically for each curriculum on SOACURR.

Program units
f_api_version   Returns the API version number.
f_exists   Checks if a record exists.
f_isequal   Compares two records for equality.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using the key.
f_query_current_active   Validates that the most current study path is active
f_query_current   Selects the most current effective term
f_query_by_rowid   Selects one record using the ROWID.
f_query_one_lock   Selects one record and locks it.
f_reg_eligible   Determines if student's study path is eligible for registration
f_end_term   Returns the end term for the study path
f_degree_exists   Determines if study path is remaining study path on a sought or pending degree
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
studypath_rec   Business Entity record type
studypath_ref   Entity cursor variable type
studypath_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name
M_BASE_TABLE_NAME   Base table name

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(9) := 'STUDYPATH';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

studypath_rec 

TYPE studypath_rec IS RECORD (
  r_pidm                    sgrstsp.sgrstsp_pidm%TYPE,
  r_term_code_eff           sgrstsp.sgrstsp_term_code_eff%TYPE,
  r_key_seqno               sgrstsp.sgrstsp_key_seqno%TYPE,
  r_stsp_code               sgrstsp.sgrstsp_stsp_code%TYPE,
  r_data_origin             sgrstsp.sgrstsp_data_origin%TYPE,
  r_user_id                 sgrstsp.sgrstsp_user_id%TYPE,
  r_full_part_ind           sgrstsp.sgrstsp_full_part_ind%TYPE,
  r_sess_code               sgrstsp.sgrstsp_sess_code%TYPE,
  r_resd_code               sgrstsp.sgrstsp_resd_code%TYPE,
  r_orsn_code               sgrstsp.sgrstsp_orsn_code%TYPE,
  r_prac_code               sgrstsp.sgrstsp_prac_code%TYPE,
  r_capl_code               sgrstsp.sgrstsp_capl_code%TYPE,
     r_edlv_code               sgrstsp.sgrstsp_edlv_code%TYPE,
  r_incm_code               sgrstsp.sgrstsp_incm_code%TYPE,
  r_emex_code               sgrstsp.sgrstsp_emex_code%TYPE,
  r_aprn_code               sgrstsp.sgrstsp_aprn_code%TYPE,
  r_trcn_code               sgrstsp.sgrstsp_trcn_code%TYPE,
  r_gain_code               sgrstsp.sgrstsp_gain_code%TYPE,
  r_voed_code               sgrstsp.sgrstsp_voed_code%TYPE,
  r_blck_code               sgrstsp.sgrstsp_blck_code%TYPE,
   r_egol_code               sgrstsp.sgrstsp_egol_code%TYPE,
  r_bskl_code               sgrstsp.sgrstsp_bskl_code%TYPE,
  r_astd_code               sgrstsp.sgrstsp_astd_code%TYPE,
  r_prev_code               sgrstsp.sgrstsp_prev_code%TYPE,
  r_cast_code               sgrstsp.sgrstsp_cast_code%TYPE,
    r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

studypath_ref 

TYPE studypath_ref IS REF CURSOR RETURN studypath_rec;

Entity cursor variable type

studypath_tab 

TYPE studypath_tab IS TABLE OF studypath_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          sgrstsp.sgrstsp_pidm%TYPE,
                  p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                  p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE,
                  p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) 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 studypath_rec, rec_two studypath_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 studypath_rec Required
rec_two   The second record to compare. Type studypath_rec Required

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

f_query_all 

Function f_query_all(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                     p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE default null,
                     p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE default null)
  RETURN studypath_ref

Selects all records for the entity.

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Optional Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Optional Key

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

f_query_one 

Function f_query_one(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                     p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                     p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE)
  RETURN studypath_ref

Selects one record using the key.

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_current_active 

Function f_query_current_active(p_pidm      sgrstsp.sgrstsp_pidm%TYPE,
                                p_key_seqno sgrstsp.sgrstsp_key_seqno%TYPE)
  RETURN VARCHAR2

Validates that the most current study path is active

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key

Returns
A Y or N value to signify the study path is active

f_query_current 

Function f_query_current(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                         p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                         p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE)
  RETURN VARCHAR2

Selects the most current effective term

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key

Returns
The term code for the maximum term less than the input term

f_query_by_rowid 

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN studypath_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_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                          p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                          p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE,
                          p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN studypath_ref

Selects one record and locks it.

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

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

f_reg_eligible 

Function f_reg_eligible(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                        p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                        p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE)
  RETURN VARCHAR2

Determines if student's study path is eligible for registration

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number ofthe Study Path. NUMBER(2) Required Key

Returns
Y if eligibile to register, otherwise a value indicating the reason for ineligibility.

f_end_term 

Function f_end_term(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                    p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                    p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE)
  RETURN VARCHAR2

Returns the end term for the study path

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number ofthe Study Path. NUMBER(2) Required Key

Returns
Term code when the study path ends.  If there is no end, 999999 is returned.

f_degree_exists 

Function f_degree_exists(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                         p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                         p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE)
  RETURN VARCHAR2

Determines if study path is remaining study path on a sought or pending degree

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number ofthe Study Path. NUMBER(2) Required Key

Returns
Y if a degree exists and the study path is the remaining study path attached to the degree

p_create 

Procedure p_create(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                   p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                   p_key_seqno     IN OUT sgrstsp.sgrstsp_key_seqno%TYPE,
                   p_stsp_code     sgrstsp.sgrstsp_stsp_code%TYPE,
                   p_data_origin   sgrstsp.sgrstsp_data_origin%TYPE,
                   p_user_id       sgrstsp.sgrstsp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_full_part_ind sgrstsp.sgrstsp_full_part_ind%TYPE DEFAULT NULL,
                   p_sess_code     sgrstsp.sgrstsp_sess_code%TYPE DEFAULT NULL,
                   p_resd_code     sgrstsp.sgrstsp_resd_code%TYPE DEFAULT NULL,
                   p_orsn_code     sgrstsp.sgrstsp_orsn_code%TYPE DEFAULT NULL,
                   p_prac_code     sgrstsp.sgrstsp_prac_code%TYPE DEFAULT NULL,
                   p_capl_code     sgrstsp.sgrstsp_capl_code%TYPE DEFAULT NULL,
                   p_edlv_code     sgrstsp.sgrstsp_edlv_code%TYPE DEFAULT NULL,
                   p_incm_code     sgrstsp.sgrstsp_incm_code%TYPE DEFAULT NULL,
                   p_emex_code     sgrstsp.sgrstsp_emex_code%TYPE DEFAULT NULL,
                   p_aprn_code     sgrstsp.sgrstsp_aprn_code%TYPE DEFAULT NULL,
                   p_trcn_code     sgrstsp.sgrstsp_trcn_code%TYPE DEFAULT NULL,
                   p_gain_code     sgrstsp.sgrstsp_gain_code%TYPE DEFAULT NULL,
                   p_voed_code     sgrstsp.sgrstsp_voed_code%TYPE DEFAULT NULL,
                   p_blck_code     sgrstsp.sgrstsp_blck_code%TYPE DEFAULT NULL,
                   p_egol_code     sgrstsp.sgrstsp_egol_code%TYPE DEFAULT NULL,
                   p_bskl_code     sgrstsp.sgrstsp_bskl_code%TYPE DEFAULT NULL,
                   p_astd_code     sgrstsp.sgrstsp_astd_code%TYPE DEFAULT NULL,
                   p_prev_code     sgrstsp.sgrstsp_prev_code%TYPE DEFAULT NULL,
                   p_cast_code     sgrstsp.sgrstsp_cast_code%TYPE DEFAULT NULL,
                   p_rowid_out     OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key
p_stsp_code   Students study path status for the effective term. VARCHAR2(16) Required
p_data_origin   Source system that generated the data. VARCHAR2(120) Required
p_user_id   The most recent user to update a record. VARCHAR2(120) Required
p_full_part_ind   This field identifies whether the student is a full or part-time student. VARCHAR2(4)
p_sess_code   Session student is attending for the effective term. VARCHAR2(4)
p_resd_code   Residency status of the student for the effective term. VARCHAR2(4)
p_orsn_code   Orientation session assigned to the student for the Effective term. VARCHAR2(4)
p_prac_code   Practical training experience of the student for the  effective term. VARCHAR2(8)
p_capl_code   This field identifies career plan of the student for the effective term. VARCHAR2(8)
p_edlv_code   A two position alphanumeric field which indicate the highest level of the education that the student completed. VARCHAR2(12)
p_incm_code   A two position alphanumeric field which indicate the income range of the student. VARCHAR2(8)
p_emex_code   General Student Employment Expectation Code. VARCHAR2(8)
p_aprn_code   General Student Apprenticeship Code. VARCHAR2(8)
p_trcn_code   General Student Transfer Center Code. VARCHAR2(8)
p_gain_code   Employment and training code of the student for the effective term. VARCHAR2(8)
p_voed_code   General Student Vocation Education Status Code. VARCHAR2(8)
p_blck_code   Block Schedule Code. VARCHAR2(40)
p_site_code   This describes the site of student. VARCHAR2(12)
p_egol_code   Educational Goal code. VARCHAR2(8)
p_bskl_code   Student Basic Skills Code. VARCHAR2(8)
p_astd_code   Academic standing override for a student for the effective term. VARCHAR2(8)
p_prev_code   General Student record Progress Evaluation code. VARCHAR2(8)
p_cast_code   General Student record Combined Academic Standing code. VARCHAR2(8)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                   p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                   p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                 p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                 p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE,
                 p_rowid_inout   IN OUT NOCOPY 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_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_pidm          sgrstsp.sgrstsp_pidm%TYPE,
                   p_term_code_eff sgrstsp.sgrstsp_term_code_eff%TYPE,
                   p_key_seqno     sgrstsp.sgrstsp_key_seqno%TYPE,
                   p_stsp_code     sgrstsp.sgrstsp_stsp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin   sgrstsp.sgrstsp_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id       sgrstsp.sgrstsp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_full_part_ind sgrstsp.sgrstsp_full_part_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sess_code     sgrstsp.sgrstsp_sess_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_resd_code     sgrstsp.sgrstsp_resd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_orsn_code     sgrstsp.sgrstsp_orsn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prac_code     sgrstsp.sgrstsp_prac_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_capl_code     sgrstsp.sgrstsp_capl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_edlv_code     sgrstsp.sgrstsp_edlv_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_incm_code     sgrstsp.sgrstsp_incm_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_emex_code     sgrstsp.sgrstsp_emex_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_aprn_code     sgrstsp.sgrstsp_aprn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trcn_code     sgrstsp.sgrstsp_trcn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_gain_code     sgrstsp.sgrstsp_gain_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_voed_code     sgrstsp.sgrstsp_voed_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_blck_code     sgrstsp.sgrstsp_blck_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_egol_code     sgrstsp.sgrstsp_egol_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bskl_code     sgrstsp.sgrstsp_bskl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_astd_code     sgrstsp.sgrstsp_astd_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_prev_code     sgrstsp.sgrstsp_prev_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cast_code     sgrstsp.sgrstsp_cast_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_pidm   Unique internal ID for individual who has records in the system. NUMBER(8) Required Key
p_term_code_eff   This is the term the student record is effective. VARCHAR2(24) Required Key
p_key_seqno   This is the sequence number of  the Study Path. NUMBER(2) Required Key
p_stsp_code   Students study path status for the effective term. VARCHAR2(16) Required
p_data_origin   Source system that generated the data. VARCHAR2(120) Required
p_user_id   The most recent user to update a record. VARCHAR2(120) Required
p_full_part_ind   This field identifies whether the student is a full or part-time student. VARCHAR2(4)
p_sess_code   Session student is attending for the effective term. VARCHAR2(4)
p_resd_code   Residency status of the student for the effective term. VARCHAR2(4)
p_orsn_code   Orientation session assigned to the student for the Effective term. VARCHAR2(4)
p_prac_code   Practical training experience of the student for the  effective term. VARCHAR2(8)
p_capl_code   This field identifies career plan of the student for the effective term. VARCHAR2(8)
p_edlv_code   A two position alphanumeric field which indicate the highest level of the education that the student completed. VARCHAR2(12)
p_incm_code   A two position alphanumeric field which indicate the income range of the student. VARCHAR2(8)
p_emex_code   General Student Employment Expectation Code. VARCHAR2(8)
p_aprn_code   General Student Apprenticeship Code. VARCHAR2(8)
p_trcn_code   General Student Transfer Center Code. VARCHAR2(8)
p_gain_code   Employment and training code of the student for the effective term. VARCHAR2(8)
p_voed_code   General Student Vocation Education Status Code. VARCHAR2(8)
p_blck_code   Block Schedule Code. VARCHAR2(40)
p_egol_code   Educational Goal code. VARCHAR2(8)
p_bskl_code   Student Basic Skills Code. VARCHAR2(8)
p_astd_code   Academic standing override for a student for the effective term. VARCHAR2(8)
p_prev_code   General Student record Progress Evaluation code. VARCHAR2(8)
p_cast_code   General Student record Combined Academic Standing code. VARCHAR2(8)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)