index

Package sb_curriculum_archive

This package provides the Common Business interface for the Curriculum Archive API (sb_curriculum_archive).

Program units
f_api_version   Returns the API version number.
f_exists   Checks to see 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_by_rowid   Selects one record using the ROWID.
f_query_one_lock   Selects one record and locks it.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.
p_archive_curriculum   Procedure called by the PRO*C program to create records in the SORHCUR and SORHFOS tables.

Types
curriculum_archive_rec   Business Entity record type
curriculum_archive_ref   Entity cursor variable type
curriculum_archive_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(18) := 'CURRICULUM_ARCHIVE';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

curriculum_archive_rec 

TYPE curriculum_archive_rec IS RECORD (
  r_pidm                    sorhcur.sorhcur_pidm%TYPE,
  r_seqno                   sorhcur.sorhcur_seqno%TYPE,
  r_lmod_cde                sorhcur.sorhcur_lmod_cde%TYPE,
  r_term_cde                sorhcur.sorhcur_term_cde%TYPE,
  r_key_seqno               sorhcur.sorhcur_key_seqno%TYPE,
  r_priority_no             sorhcur.sorhcur_priority_no%TYPE,
  r_roll_ind                sorhcur.sorhcur_roll_ind%TYPE,
  r_cact_cde                sorhcur.sorhcur_cact_cde%TYPE,
  r_user_id                 sorhcur.sorhcur_user_id%TYPE,
  r_data_origin             sorhcur.sorhcur_data_origin%TYPE,
  r_levl_cde                sorhcur.sorhcur_levl_cde%TYPE,
  r_coll_cde                sorhcur.sorhcur_coll_cde%TYPE,
  r_degc_cde                sorhcur.sorhcur_degc_cde%TYPE,
  r_term_cde_ctlg           sorhcur.sorhcur_term_cde_ctlg%TYPE,
  r_term_cde_end            sorhcur.sorhcur_term_cde_end%TYPE,
  r_term_cde_matric         sorhcur.sorhcur_term_cde_matric%TYPE,
  r_term_cde_admit          sorhcur.sorhcur_term_cde_admit%TYPE,
  r_admt_cde                sorhcur.sorhcur_admt_cde%TYPE,
  r_camp_cde                sorhcur.sorhcur_camp_cde%TYPE,
  r_program                 sorhcur.sorhcur_program%TYPE,
  r_start_date              sorhcur.sorhcur_start_date%TYPE,
  r_end_date                sorhcur.sorhcur_end_date%TYPE,
  r_curr_rule               sorhcur.sorhcur_curr_rule%TYPE,
  r_rolled_seqno            sorhcur.sorhcur_rolled_seqno%TYPE,
  r_styp_cde                sorhcur.sorhcur_styp_cde%TYPE,
  r_rate_cde                sorhcur.sorhcur_rate_cde%TYPE,
  r_leav_cde                sorhcur.sorhcur_leav_cde%TYPE,
  r_leav_from_date          sorhcur.sorhcur_leav_from_date%TYPE,
  r_leav_to_date            sorhcur.sorhcur_leav_to_date%TYPE,
  r_exp_grad_date           sorhcur.sorhcur_exp_grad_date%TYPE,
  r_term_cde_grad           sorhcur.sorhcur_term_cde_grad%TYPE,
  r_acyr_cde                sorhcur.sorhcur_acyr_cde%TYPE,
  r_site_cde                sorhcur.sorhcur_site_cde%TYPE,
  r_appl_seqno              sorhcur.sorhcur_appl_seqno%TYPE,
  r_appl_key_seqno          sorhcur.sorhcur_appl_key_seqno%TYPE,
  r_key_seqno_rolled        sorhcur.sorhcur_key_seqno_rolled%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

curriculum_archive_ref 

TYPE curriculum_archive_ref IS REF CURSOR RETURN curriculum_archive_rec;

Entity cursor variable type

curriculum_archive_tab 

TYPE curriculum_archive_tab IS TABLE OF curriculum_archive_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  sorhcur.sorhcur_pidm%TYPE,
                  p_seqno sorhcur.sorhcur_seqno%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) 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 curriculum_archive_rec,
                   rec_two curriculum_archive_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 curriculum_archive_rec Required
rec_two   The second record to compare. Type curriculum_archive_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  sorhcur.sorhcur_pidm%TYPE,
                     p_seqno sorhcur.sorhcur_seqno%TYPE DEFAULT NULL)
  RETURN curriculum_archive_ref

Selects all records for the entity.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) Required Key

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

f_query_one 

Function f_query_one(p_pidm  sorhcur.sorhcur_pidm%TYPE,
                     p_seqno sorhcur.sorhcur_seqno%TYPE)
  RETURN curriculum_archive_ref

Selects one record using the key.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) 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 curriculum_archive_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  sorhcur.sorhcur_pidm%TYPE,
                          p_seqno sorhcur.sorhcur_seqno%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN curriculum_archive_ref

Selects one record and locks it.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) 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_pidm             sorhcur.sorhcur_pidm%TYPE,
                   p_seqno            sorhcur.sorhcur_seqno%TYPE,
                   p_lmod_cde         sorhcur.sorhcur_lmod_cde%TYPE,
                   p_term_cde         sorhcur.sorhcur_term_cde%TYPE,
                   p_key_seqno        sorhcur.sorhcur_key_seqno%TYPE,
                   p_priority_no      sorhcur.sorhcur_priority_no%TYPE,
                   p_roll_ind         sorhcur.sorhcur_roll_ind%TYPE,
                   p_cact_cde         sorhcur.sorhcur_cact_cde%TYPE,
                   p_user_id          sorhcur.sorhcur_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin      sorhcur.sorhcur_data_origin%TYPE,
                   p_levl_cde         sorhcur.sorhcur_levl_cde%TYPE,
                   p_coll_cde         sorhcur.sorhcur_coll_cde%TYPE,
                   p_degc_cde         sorhcur.sorhcur_degc_cde%TYPE,
                   p_term_cde_ctlg    sorhcur.sorhcur_term_cde_ctlg%TYPE DEFAULT NULL,
                   p_term_cde_end     sorhcur.sorhcur_term_cde_end%TYPE DEFAULT NULL,
                   p_term_cde_matric  sorhcur.sorhcur_term_cde_matric%TYPE DEFAULT NULL,
                   p_term_cde_admit   sorhcur.sorhcur_term_cde_admit%TYPE DEFAULT NULL,
                   p_admt_cde         sorhcur.sorhcur_admt_cde%TYPE DEFAULT NULL,
                   p_camp_cde         sorhcur.sorhcur_camp_cde%TYPE DEFAULT NULL,
                   p_program          sorhcur.sorhcur_program%TYPE DEFAULT NULL,
                   p_start_date       sorhcur.sorhcur_start_date%TYPE DEFAULT NULL,
                   p_end_date         sorhcur.sorhcur_end_date%TYPE DEFAULT NULL,
                   p_curr_rule        sorhcur.sorhcur_curr_rule%TYPE DEFAULT NULL,
                   p_rolled_seqno     sorhcur.sorhcur_rolled_seqno%TYPE DEFAULT NULL,
                   p_styp_cde         sorhcur.sorhcur_styp_cde%TYPE DEFAULT NULL,
                   p_rate_cde         sorhcur.sorhcur_rate_cde%TYPE DEFAULT NULL,
                   p_leav_cde         sorhcur.sorhcur_leav_cde%TYPE DEFAULT NULL,
                   p_leav_from_date   sorhcur.sorhcur_leav_from_date%TYPE DEFAULT NULL,
                   p_leav_to_date     sorhcur.sorhcur_leav_to_date%TYPE DEFAULT NULL,
                   p_exp_grad_date    sorhcur.sorhcur_exp_grad_date%TYPE DEFAULT NULL,
                   p_term_cde_grad    sorhcur.sorhcur_term_cde_grad%TYPE DEFAULT NULL,
                   p_acyr_cde         sorhcur.sorhcur_acyr_cde%TYPE DEFAULT NULL,
                   p_site_cde         sorhcur.sorhcur_site_cde%TYPE DEFAULT NULL,
                   p_appl_seqno       sorhcur.sorhcur_appl_seqno%TYPE DEFAULT NULL,
                   p_appl_key_seqno   sorhcur.sorhcur_appl_key_seqno%TYPE DEFAULT NULL,
                   p_key_seqno_rolled sorhcur.sorhcur_key_seqno_rolled%TYPE DEFAULT NULL,
                   p_rowid_out        OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) Required Key
p_lmod_cde   Learner module code. VARCHAR2(15) Required
p_term_cde   Term code. VARCHAR2(6) Required
p_key_seqno   Sequence number of the key record. NUMBER(2) Required
p_priority_no   Priority of the curriculum within the module. NUMBER(4) Required
p_roll_ind   Y/N indicator for whether the learner curriculum should roll to academic history when courses are rolled. VARCHAR2(1) Required
p_cact_cde   Activity status code for the curriculum. VARCHAR2(15) Required
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_data_origin   Source system that generated the data. VARCHAR2(30) Required
p_levl_cde   Level code of the curriculum. VARCHAR2(2) Required
p_coll_cde   College code of the curriculum. VARCHAR2(2) Required
p_degc_cde   Degree code of the curriculum. VARCHAR2(6) Required
p_term_cde_ctlg   Catalog term code of the curriculum. VARCHAR2(6)
p_term_cde_end   End term code of the curriculum. VARCHAR2(6)
p_term_cde_matric   Term code in which the learner matriculated into the curriculum. VARCHAR2(6)
p_term_cde_admit   Term code in which the learner was admitted to the curriculum. VARCHAR2(6)
p_admt_cde   Admit code for the learner's admission to the curriculum. VARCHAR2(2)
p_camp_cde   Campus code of the curriculum. VARCHAR2(3)
p_program   Program of the curriculum. VARCHAR2(12)
p_start_date   Date on which the curriculum starts. DATE
p_end_date   Date on which the curriculum ends. DATE
p_curr_rule   Rule number of the curriculum. NUMBER(8)
p_rolled_seqno   Sequence number of the outcome created during the grade roll. NUMBER(4)
p_styp_cde   Type of student. VARCHAR2(1)
p_rate_cde   Fee assessment rate code. VARCHAR2(5)
p_leav_cde   Reason for the leave of absence. VARCHAR2(1)
p_leav_from_date   End date of the leave. DATE
p_leav_to_date   Start date of the leave. DATE
p_exp_grad_date   Date on which the learner is expected to graduate from the curriculum. DATE
p_term_cde_grad   Expected term the learner will graduate. VARCHAR2(6)
p_acyr_cde   Academic year for the graduation. VARCHAR2(4)
p_site_cde   Site of the student. VARCHAR2(3)
p_appl_seqno   Sequence number of the application curriculum from which the learner curriculum was created. NUMBER(4)
p_appl_key_seqno   Application number from which the learner curriculum was created. NUMBER(2)
p_key_seqno_rolled   Sequence number of the application curriculum from which the history was rolled. NUMBER(2)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_pidm  sorhcur.sorhcur_pidm%TYPE,
                   p_seqno sorhcur.sorhcur_seqno%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_pidm        sorhcur.sorhcur_pidm%TYPE,
                 p_seqno       sorhcur.sorhcur_seqno%TYPE,
                 p_rowid_inout IN OUT 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 the p_rowid_inout.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_pidm             sorhcur.sorhcur_pidm%TYPE,
                   p_seqno            sorhcur.sorhcur_seqno%TYPE,
                   p_lmod_cde         sorhcur.sorhcur_lmod_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde         sorhcur.sorhcur_term_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_key_seqno        sorhcur.sorhcur_key_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_priority_no      sorhcur.sorhcur_priority_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_roll_ind         sorhcur.sorhcur_roll_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cact_cde         sorhcur.sorhcur_cact_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id          sorhcur.sorhcur_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin      sorhcur.sorhcur_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_levl_cde         sorhcur.sorhcur_levl_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_cde         sorhcur.sorhcur_coll_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_degc_cde         sorhcur.sorhcur_degc_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde_ctlg    sorhcur.sorhcur_term_cde_ctlg%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde_end     sorhcur.sorhcur_term_cde_end%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde_matric  sorhcur.sorhcur_term_cde_matric%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde_admit   sorhcur.sorhcur_term_cde_admit%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_admt_cde         sorhcur.sorhcur_admt_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_camp_cde         sorhcur.sorhcur_camp_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_program          sorhcur.sorhcur_program%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_start_date       sorhcur.sorhcur_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_end_date         sorhcur.sorhcur_end_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_curr_rule        sorhcur.sorhcur_curr_rule%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rolled_seqno     sorhcur.sorhcur_rolled_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_styp_cde         sorhcur.sorhcur_styp_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rate_cde         sorhcur.sorhcur_rate_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_leav_cde         sorhcur.sorhcur_leav_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_leav_from_date   sorhcur.sorhcur_leav_from_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_leav_to_date     sorhcur.sorhcur_leav_to_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_exp_grad_date    sorhcur.sorhcur_exp_grad_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_term_cde_grad    sorhcur.sorhcur_term_cde_grad%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_acyr_cde         sorhcur.sorhcur_acyr_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_site_cde         sorhcur.sorhcur_site_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_appl_seqno       sorhcur.sorhcur_appl_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_appl_key_seqno   sorhcur.sorhcur_appl_key_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_key_seqno_rolled sorhcur.sorhcur_key_seqno_rolled%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rowid            gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) Required Key
p_lmod_cde   Learner module code. VARCHAR2(15) Required
p_term_cde   Term code. VARCHAR2(6) Required
p_key_seqno   Sequence number of the key record. NUMBER(2) Required
p_priority_no   Priority of the curriculum within the module. NUMBER(4) Required
p_roll_ind   Y/N indicator for whether the learner curriculum should roll to academic history when courses are rolled. VARCHAR2(1) Required
p_cact_cde   Activity status code for the curriculum. VARCHAR2(15) Required
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_data_origin   Source system that generated the data. VARCHAR2(30) Required
p_levl_cde   Level code of the curriculum. VARCHAR2(2) Required
p_coll_cde   College code of the curriculum. VARCHAR2(2) Required
p_degc_cde   Degree code of the curriculum. VARCHAR2(6) Required
p_term_cde_ctlg   Catalog term code of the curriculum. VARCHAR2(6)
p_term_cde_end   End term code of the curriculum. VARCHAR2(6)
p_term_cde_matric   Term code in which the learner matriculated into the curriculum. VARCHAR2(6)
p_term_cde_admit   Term code in which the learner was admitted to the curriculum. VARCHAR2(6)
p_admt_cde   Admit code for the learner's admission to the curriculum. VARCHAR2(2)
p_camp_cde   Campus code of the curriculum. VARCHAR2(3)
p_program   Program of the curriculum. VARCHAR2(12)
p_start_date   Date on which the curriculum starts. DATE
p_end_date   Date on which the curriculum ends. DATE
p_curr_rule   Rule number of the curriculum. NUMBER(8)
p_rolled_seqno   Sequence number of the outcome created during the grade roll. NUMBER(4)
p_styp_cde   Type of student. VARCHAR2(1)
p_rate_cde   Fee assessment rate code. VARCHAR2(5)
p_leav_cde   Reason for the leave of absence. VARCHAR2(1)
p_leav_from_date   End date of the leave. DATE
p_leav_to_date   Start date of the leave. DATE
p_exp_grad_date   Date on which the learner is expected to graduate from the curriculum. DATE
p_term_cde_grad   Expected term the learner will graduate. VARCHAR2(6)
p_acyr_cde   Academic year for the graduation. VARCHAR2(4)
p_site_cde   Site of the student. VARCHAR2(3)
p_appl_seqno   Sequence number of the application curriculum from which the learner curriculum was created. NUMBER(4)
p_appl_key_seqno   Application number from which the learner curriculum was created. NUMBER(2)
p_key_seqno_rolled   Sequence number of the application curriculum from which the history was rolled. NUMBER(2)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)

p_archive_curriculum 

Procedure p_archive_curriculum(p_pidm  sorlcur.sorlcur_pidm%TYPE,
                               p_seqno sorlcur.sorlcur_seqno%TYPE)

Procedure called by the PRO*C program to create records in the SORHCUR and SORHFOS tables.

Parameters
p_pidm   Unique internal ID for an individual who has records in the system. NUMBER(8) Required Key
p_seqno   One-up number to define the row. NUMBER(4) Required Key