Package sb_fieldofstudy

Package sb_fieldofstudy_archive

Common Business interface for the Field of Study Archive API (sb_fieldofstudy_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.

Types

fieldofstudy_archive_rec	Business Entity record type
fieldofstudy_archive_ref	Entity cursor variable type
fieldofstudy_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(20) := 'FIELDOFSTUDY_ARCHIVE';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

fieldofstudy_archive_rec

TYPE fieldofstudy_archive_rec IS RECORD (
  r_pidm                    sorhfos.sorhfos_pidm%TYPE,
  r_lcur_seqno              sorhfos.sorhfos_lcur_seqno%TYPE,
  r_seqno                   sorhfos.sorhfos_seqno%TYPE,
  r_lfst_cde                sorhfos.sorhfos_lfst_cde%TYPE,
  r_term_cde                sorhfos.sorhfos_term_cde%TYPE,
  r_priority_no             sorhfos.sorhfos_priority_no%TYPE,
  r_csts_cde                sorhfos.sorhfos_csts_cde%TYPE,
  r_cact_cde                sorhfos.sorhfos_cact_cde%TYPE,
  r_data_origin             sorhfos.sorhfos_data_origin%TYPE,
  r_user_id                 sorhfos.sorhfos_user_id%TYPE,
  r_majr_cde                sorhfos.sorhfos_majr_cde%TYPE,
  r_term_cde_ctlg           sorhfos.sorhfos_term_cde_ctlg%TYPE,
  r_term_cde_end            sorhfos.sorhfos_term_cde_end%TYPE,
  r_dept_cde                sorhfos.sorhfos_dept_cde%TYPE,
  r_lfos_rule               sorhfos.sorhfos_lfos_rule%TYPE,
  r_conc_attach_rule        sorhfos.sorhfos_conc_attach_rule%TYPE,
  r_start_date              sorhfos.sorhfos_start_date%TYPE,
  r_end_date                sorhfos.sorhfos_end_date%TYPE,
  r_tmst_cde                sorhfos.sorhfos_tmst_cde%TYPE,
  r_rolled_seqno            sorhfos.sorhfos_rolled_seqno%TYPE,
  r_majr_cde_attach         sorhfos.sorhfos_majr_cde_attach%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

fieldofstudy_archive_ref

TYPE fieldofstudy_archive_ref IS REF CURSOR RETURN fieldofstudy_archive_rec;

Entity cursor variable type

fieldofstudy_archive_tab

TYPE fieldofstudy_archive_tab IS TABLE OF fieldofstudy_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       sorhfos.sorhfos_pidm%TYPE,
                  p_lcur_seqno sorhfos.sorhfos_lcur_seqno%TYPE,
                  p_seqno      sorhfos.sorhfos_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_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. 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 fieldofstudy_archive_rec,
                   rec_two fieldofstudy_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 fieldofstudy_archive_rec Required
	rec_two	The second record to compare. Type fieldofstudy_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       sorhfos.sorhfos_pidm%TYPE,
                     p_lcur_seqno sorhfos.sorhfos_lcur_seqno%TYPE,
                     p_seqno      sorhfos.sorhfos_seqno%TYPE DEFAULT NULL)
  RETURN fieldofstudy_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_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. NUMBER(4) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm       sorhfos.sorhfos_pidm%TYPE,
                     p_lcur_seqno sorhfos.sorhfos_lcur_seqno%TYPE,
                     p_seqno      sorhfos.sorhfos_seqno%TYPE)
  RETURN fieldofstudy_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_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. 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 fieldofstudy_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       sorhfos.sorhfos_pidm%TYPE,
                          p_lcur_seqno sorhfos.sorhfos_lcur_seqno%TYPE,
                          p_seqno      sorhfos.sorhfos_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN fieldofstudy_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_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. 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             sorhfos.sorhfos_pidm%TYPE,
                   p_lcur_seqno       sorhfos.sorhfos_lcur_seqno%TYPE,
                   p_seqno            sorhfos.sorhfos_seqno%TYPE,
                   p_lfst_cde         sorhfos.sorhfos_lfst_cde%TYPE,
                   p_term_cde         sorhfos.sorhfos_term_cde%TYPE,
                   p_priority_no      sorhfos.sorhfos_priority_no%TYPE,
                   p_csts_cde         sorhfos.sorhfos_csts_cde%TYPE,
                   p_cact_cde         sorhfos.sorhfos_cact_cde%TYPE,
                   p_data_origin      sorhfos.sorhfos_data_origin%TYPE,
                   p_user_id          sorhfos.sorhfos_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_majr_cde         sorhfos.sorhfos_majr_cde%TYPE,
                   p_term_cde_ctlg    sorhfos.sorhfos_term_cde_ctlg%TYPE DEFAULT NULL,
                   p_term_cde_end     sorhfos.sorhfos_term_cde_end%TYPE DEFAULT NULL,
                   p_dept_cde         sorhfos.sorhfos_dept_cde%TYPE DEFAULT NULL,
                   p_lfos_rule        sorhfos.sorhfos_lfos_rule%TYPE DEFAULT NULL,
                   p_conc_attach_rule sorhfos.sorhfos_conc_attach_rule%TYPE DEFAULT NULL,
                   p_start_date       sorhfos.sorhfos_start_date%TYPE DEFAULT NULL,
                   p_end_date         sorhfos.sorhfos_end_date%TYPE DEFAULT NULL,
                   p_tmst_cde         sorhfos.sorhfos_tmst_cde%TYPE DEFAULT NULL,
                   p_rolled_seqno     sorhfos.sorhfos_rolled_seqno%TYPE DEFAULT NULL,
                   p_majr_cde_attach  sorhfos.sorhfos_majr_cde_attach%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_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. NUMBER(4) Required Key
	p_lfst_cde	Field of study type code, for example MAJOR, MINOR, CONC. VARCHAR2(15) Required
	p_term_cde	Term code for which the field of study is active. VARCHAR2(6) Required
	p_priority_no	Priority number, or ranking, of the field of study. NUMBER(4) Required
	p_csts_cde	Status of the curriculum. VARCHAR2(15) Required
	p_cact_cde	Curriculum activity status. VARCHAR2(15) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30) Required
	p_user_id	Most recent user to create or update the record. VARCHAR2(30) Required
	p_majr_cde	Major code for the field of study. VARCHAR2(4) Required
	p_term_cde_ctlg	Term code identifying the catalog for the curriculum. VARCHAR2(6)
	p_term_cde_end	End term code for which the curriculum is active. VARCHAR2(6)
	p_dept_cde	Department code associated with the major field of study. VARCHAR2(4)
	p_lfos_rule	Curriculum rule from the curriculum table. NUMBER(8)
	p_conc_attach_rule	Major curriculum rule from the SORCCMN table for concentrations attached to a major. NUMBER(8)
	p_start_date	Start date of the field of study. DATE
	p_end_date	End date of the field of study. DATE
	p_tmst_cde	Time status code to indicate the intent of the student's pursuit of the field of study. VARCHAR2(2)
	p_rolled_seqno	Outcome sequence number that was created from the history roll process. NUMBER(4)
	p_majr_cde_attach	Major code to which the concentration is attached. VARCHAR2(4)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm       sorhfos.sorhfos_pidm%TYPE,
                   p_lcur_seqno sorhfos.sorhfos_lcur_seqno%TYPE,
                   p_seqno      sorhfos.sorhfos_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_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        sorhfos.sorhfos_pidm%TYPE,
                 p_lcur_seqno  sorhfos.sorhfos_lcur_seqno%TYPE,
                 p_seqno       sorhfos.sorhfos_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_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. 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             sorhfos.sorhfos_pidm%TYPE,
                   p_lcur_seqno       sorhfos.sorhfos_lcur_seqno%TYPE,
                   p_seqno            sorhfos.sorhfos_seqno%TYPE,
                   p_lfst_cde         sorhfos.sorhfos_lfst_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde         sorhfos.sorhfos_term_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_priority_no      sorhfos.sorhfos_priority_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_csts_cde         sorhfos.sorhfos_csts_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cact_cde         sorhfos.sorhfos_cact_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin      sorhfos.sorhfos_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id          sorhfos.sorhfos_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_majr_cde         sorhfos.sorhfos_majr_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde_ctlg    sorhfos.sorhfos_term_cde_ctlg%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_cde_end     sorhfos.sorhfos_term_cde_end%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dept_cde         sorhfos.sorhfos_dept_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lfos_rule        sorhfos.sorhfos_lfos_rule%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_conc_attach_rule sorhfos.sorhfos_conc_attach_rule%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_start_date       sorhfos.sorhfos_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_end_date         sorhfos.sorhfos_end_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_tmst_cde         sorhfos.sorhfos_tmst_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rolled_seqno     sorhfos.sorhfos_rolled_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_majr_cde_attach  sorhfos.sorhfos_majr_cde_attach%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 an individual who has records in the system. NUMBER(8) Required Key
	p_lcur_seqno	Sequence number of the parent learner curriculum base record. NUMBER(4) Required Key
	p_seqno	Sequence number of the learner field of study. NUMBER(4) Required Key
	p_lfst_cde	Field of study type code, for example MAJOR, MINOR, CONC. VARCHAR2(15) Required
	p_term_cde	Term code for which the field of study is active. VARCHAR2(6) Required
	p_priority_no	Priority number, or ranking, of the field of study. NUMBER(4) Required
	p_csts_cde	Status of the curriculum. VARCHAR2(15) Required
	p_cact_cde	Curriculum activity status. VARCHAR2(15) Required
	p_data_origin	Source system that generated the data. VARCHAR2(30) Required
	p_user_id	Most recent user to create or update the record. VARCHAR2(30) Required
	p_majr_cde	Major code for the field of study. VARCHAR2(4) Required
	p_term_cde_ctlg	Term code identifying the catalog for the curriculum. VARCHAR2(6)
	p_term_cde_end	End term code for which the curriculum is active. VARCHAR2(6)
	p_dept_cde	Department code associated with the major field of study. VARCHAR2(4)
	p_lfos_rule	Curriculum rule from the curriculum table. NUMBER(8)
	p_conc_attach_rule	Major curriculum rule from the SORCCMN table for concentrations attached to a major. NUMBER(8)
	p_start_date	Start date of the field of study. DATE
	p_end_date	End date of the field of study. DATE
	p_tmst_cde	Time status code to indicate the intent of the student's pursuit of the field of study. VARCHAR2(2)
	p_rolled_seqno	Outcome sequence number that was created from the history roll process. NUMBER(4)
	p_majr_cde_attach	Major code to which the concentration is attached. VARCHAR2(4)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)