Package sb_testscore

This package provides the Common Business interface for the Test Score API (sb_testscore). Test score records are created by unique internal identifier (PIDM), test score code and test date taken. To create a new test score record, the person must exist in the person identification/name table (SPRIDEN). The test score code must exist in the test score code validation table (STVTESC). The test date taken must be prior to or the same as the the current date.

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_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

testscore_rec	Business Entity record type
testscore_ref	Entity cursor variable type
testscore_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) := 'TESTSCORE';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

testscore_rec

TYPE testscore_rec IS RECORD (
  r_pidm                    sortest.sortest_pidm%TYPE,
  r_tesc_code               sortest.sortest_tesc_code%TYPE,
  r_test_date               sortest.sortest_test_date%TYPE,
  r_test_score              sortest.sortest_test_score%TYPE,
  r_tsrc_code               sortest.sortest_tsrc_code%TYPE,
  r_tadm_code               sortest.sortest_tadm_code%TYPE,
  r_admr_code               sortest.sortest_admr_code%TYPE,
  r_tein_code               sortest.sortest_tein_code%TYPE,
  r_tefr_code               sortest.sortest_tefr_code%TYPE,
  r_teac_code               sortest.sortest_teac_code%TYPE,
  r_tepr_code               sortest.sortest_tepr_code%TYPE,
  r_rcrv_ind                sortest.sortest_rcrv_ind%TYPE,
  r_sat_orig_score          sortest.sortest_sat_orig_score%TYPE,
  r_term_code_entry         sortest.sortest_term_code_entry%TYPE,
  r_appl_no                 sortest.sortest_appl_no%TYPE,
  r_instr_id                sortest.sortest_instr_id%TYPE,
  r_release_ind             sortest.sortest_release_ind%TYPE,
  r_equiv_ind               sortest.sortest_equiv_ind%TYPE,
  r_sat_essay_id            sortest.sortest_sat_essay_id%TYPE,
  r_user_id                 sortest.sortest_user_id%TYPE,
  r_data_origin             sortest.sortest_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

testscore_ref

TYPE testscore_ref IS REF CURSOR RETURN testscore_rec;

Entity cursor variable type

testscore_tab

TYPE testscore_tab IS TABLE OF testscore_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      sortest.sortest_pidm%TYPE,
                  p_tesc_code sortest.sortest_tesc_code%TYPE,
                  p_test_date sortest.sortest_test_date%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, such as SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE 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 testscore_rec, rec_two testscore_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 testscore_rec Required
	rec_two	The second record to compare. Type testscore_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 sortest.sortest_pidm%TYPE) RETURN testscore_ref

Selects all records for the entity.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, such as SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm      sortest.sortest_pidm%TYPE,
                     p_tesc_code sortest.sortest_tesc_code%TYPE,
                     p_test_date sortest.sortest_test_date%TYPE)
  RETURN testscore_ref

Selects one record using the key.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, such as SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE 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 testscore_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      sortest.sortest_pidm%TYPE,
                          p_tesc_code sortest.sortest_tesc_code%TYPE,
                          p_test_date sortest.sortest_test_date%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN testscore_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, such as SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE 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            sortest.sortest_pidm%TYPE,
                   p_tesc_code       sortest.sortest_tesc_code%TYPE,
                   p_test_date       sortest.sortest_test_date%TYPE,
                   p_test_score      sortest.sortest_test_score%TYPE,
                   p_tsrc_code       sortest.sortest_tsrc_code%TYPE DEFAULT NULL,
                   p_tadm_code       sortest.sortest_tadm_code%TYPE DEFAULT NULL,
                   p_admr_code       sortest.sortest_admr_code%TYPE DEFAULT NULL,
                   p_tein_code       sortest.sortest_tein_code%TYPE DEFAULT NULL,
                   p_tefr_code       sortest.sortest_tefr_code%TYPE DEFAULT NULL,
                   p_teac_code       sortest.sortest_teac_code%TYPE DEFAULT NULL,
                   p_tepr_code       sortest.sortest_tepr_code%TYPE DEFAULT NULL,
                   p_rcrv_ind        sortest.sortest_rcrv_ind%TYPE DEFAULT NULL,
                   p_sat_orig_score  sortest.sortest_sat_orig_score%TYPE DEFAULT NULL,
                   p_term_code_entry sortest.sortest_term_code_entry%TYPE DEFAULT NULL,
                   p_appl_no         sortest.sortest_appl_no%TYPE DEFAULT NULL,
                   p_instr_id        sortest.sortest_instr_id%TYPE DEFAULT NULL,
                   p_release_ind     sortest.sortest_release_ind%TYPE DEFAULT NULL,
                   p_equiv_ind       sortest.sortest_equiv_ind%TYPE,
                   p_sat_essay_id    sortest.sortest_sat_essay_id%TYPE DEFAULT NULL,
                   p_user_id         sortest.sortest_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     sortest.sortest_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out       OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, such as SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE Required Key
	p_test_score	Test score. VARCHAR2(5) Required
	p_tsrc_code	Source, or how the test score was entered, such as magnetic tape, self-reported. VARCHAR2(4)
	p_tadm_code	Administrative type of a particular test, such as locally or nationally administered. VARCHAR2(2)
	p_admr_code	Admissions checklist item code which is cross referenced to this table. VARCHAR2(4)
	p_tein_code	Test instrument code. VARCHAR2(6)
	p_tefr_code	Test form code. VARCHAR2(2)
	p_teac_code	Test accommodation code. VARCHAR2(4)
	p_tepr_code	Test purpose code. VARCHAR2(2)
	p_rcrv_ind	Indicator for whether the SAT score has been recentered and/or revised. VARCHAR2(1)
	p_sat_orig_score	Original SAT score. VARCHAR2(5)
	p_term_code_entry	Term code of the application associated with this test. VARCHAR2(6)
	p_appl_no	Application number associated with this test. NUMBER(2)
	p_instr_id	Instrument ID. VARCHAR2(10)
	p_release_ind	Indicator for whether or not release of test information is authorized. Values are "Y" or "N". VARCHAR2(1)
	p_equiv_ind	Indicator to show if the test score is an equivalency for the actual test taken. VARCHAR2(1) Required
	p_sat_essay_id	SAT essay ID to view the prospect's essay on the SAT website. VARCHAR2(10)
	p_user_id	Oracle ID of the user who inserted or last updated the data. VARCHAR2(30)
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm      sortest.sortest_pidm%TYPE,
                   p_tesc_code sortest.sortest_tesc_code%TYPE,
                   p_test_date sortest.sortest_test_date%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, that is SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        sortest.sortest_pidm%TYPE,
                 p_tesc_code   sortest.sortest_tesc_code%TYPE,
                 p_test_date   sortest.sortest_test_date%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 p_rowid_inout.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, such as SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_pidm            sortest.sortest_pidm%TYPE,
                   p_tesc_code       sortest.sortest_tesc_code%TYPE,
                   p_test_date       sortest.sortest_test_date%TYPE,
                   p_test_score      sortest.sortest_test_score%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tsrc_code       sortest.sortest_tsrc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tadm_code       sortest.sortest_tadm_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_admr_code       sortest.sortest_admr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tein_code       sortest.sortest_tein_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tefr_code       sortest.sortest_tefr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_teac_code       sortest.sortest_teac_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tepr_code       sortest.sortest_tepr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rcrv_ind        sortest.sortest_rcrv_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sat_orig_score  sortest.sortest_sat_orig_score%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_entry sortest.sortest_term_code_entry%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_appl_no         sortest.sortest_appl_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_instr_id        sortest.sortest_instr_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_release_ind     sortest.sortest_release_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_equiv_ind       sortest.sortest_equiv_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sat_essay_id    sortest.sortest_sat_essay_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         sortest.sortest_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     sortest.sortest_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_pidm	Internal identification number of the student. NUMBER(8) Required Key
	p_tesc_code	Test score code associated with various tests, such as SAT, ACT, placement scores. VARCHAR2(4) Required Key
	p_test_date	Date the test was taken. DATE Required Key
	p_test_score	Test score. VARCHAR2(5) Required
	p_tsrc_code	Source, or how the test score was entered, such as magnetic tape, self-reported. VARCHAR2(4)
	p_tadm_code	Administrative type of a particular test, such as locally or nationally administered. VARCHAR2(2)
	p_admr_code	Admissions checklist item code which is cross referenced to this table. VARCHAR2(4)
	p_tein_code	Test instrument code. VARCHAR2(6)
	p_tefr_code	Test form code. VARCHAR2(2)
	p_teac_code	Test accommodation code. VARCHAR2(4)
	p_tepr_code	Test purpose code. VARCHAR2(2)
	p_rcrv_ind	Indicator for whether SAT score has been recentered and/or revised. VARCHAR2(1)
	p_sat_orig_score	Original SAT score. VARCHAR2(5)
	p_term_code_entry	Term code of the application associated with this test. VARCHAR2(6)
	p_appl_no	Application number associated with this test. NUMBER(2)
	p_instr_id	Instrument ID. VARCHAR2(10)
	p_release_ind	Indicator for whether or not release of test information is authorized. Values are "Y" or "N". VARCHAR2(1)
	p_equiv_ind	Indicator to show if the test score is an equivalency for the actual test taken. VARCHAR2(1) Required
	p_sat_essay_id	SAT essay ID to view the prospect's essay on the SAT website. VARCHAR2(10)
	p_user_id	Oracle ID of the user who inserted or last updated the data. VARCHAR2(30)
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)