index

Package sb_datafile_test_score

Common Business interface for the Datafile Test Score API (sb_datafile_test_score).
 
Certain test score tapes store the date the test was taken only once for each given group of tests (i.e., SAT tests).
In order to facilitate clients being able to use the SRTLOAD process to load non-SunGard supported tapes, the SRRTPTS table was created so that the 'date taken' could be easily determined. For each given test code, the table identifies the test code which contains the 'date taken'. For example, the date taken for the SAT Verbal, Math, Reading tests, etc., is contained in the SAT Verbal test record (S01).


Program units
f_api_version  
f_exists  
f_sys_req  
f_isequal  
f_query_all  
f_query_one  
f_query_by_rowid  
f_query_one_lock  
p_create  
p_delete  
p_lock  
p_update  

Types
datafile_test_score_rec  
datafile_test_score_ref  
datafile_test_score_tab  

Constants
M_ENTITY_NAME  


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(19) := 'DATAFILE_TEST_SCORE';

Business Entity Name


datafile_test_score_rec

TYPE datafile_test_score_rec IS RECORD (
  r_tesc_code               srrtpts.srrtpts_tesc_code%TYPE,
  r_tesc_code_date_origin   srrtpts.srrtpts_tesc_code_date_origin%TYPE,
  r_user_id                 srrtpts.srrtpts_user_id%TYPE,
  r_sys_req_ind             srrtpts.srrtpts_sys_req_ind%TYPE,
  r_data_origin             srrtpts.srrtpts_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


datafile_test_score_ref

TYPE datafile_test_score_ref IS REF CURSOR RETURN datafile_test_score_rec;

Entity cursor variable type


datafile_test_score_tab

TYPE datafile_test_score_tab IS TABLE OF datafile_test_score_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_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE,
    p_rowid                        gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_tesc_code   Test Code for which the date origin will established. VARCHAR2(4) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.


f_sys_req

Function f_sys_req(
    p_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE,
    p_rowid                        gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record is system required.

Parameters
p_tesc_code   Test Code for which the date origin will established. VARCHAR2(4) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if required, otherwise N.


f_isequal

Function f_isequal(
    rec_one                     datafile_test_score_rec,
    rec_two                     datafile_test_score_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 datafile_test_score_rec Required
rec_two   The second record to compare. Type datafile_test_score_rec Required

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


f_query_all

Function f_query_all(
    p_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE) RETURN datafile_test_score_ref

Selects all records for the entity.

Parameters
p_tesc_code   Test Code for which the date origin will be established. VARCHAR2(4) Required Key

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


f_query_one

Function f_query_one(
    p_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE) RETURN datafile_test_score_ref

Selects one record using the key.

Parameters
p_tesc_code   Test Code for which the date origin will be established. VARCHAR2(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 datafile_test_score_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_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE,
    p_rowid                        gb_common.internal_record_id_type DEFAULT NULL) RETURN datafile_test_score_ref

Selects one record and locks it.

Parameters
p_tesc_code   Test Code for which the date origin will established. VARCHAR2(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_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE,
    p_tesc_code_date_origin        srrtpts.srrtpts_tesc_code_date_origin%TYPE,
    p_user_id                      srrtpts.srrtpts_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_sys_req_ind                  srrtpts.srrtpts_sys_req_ind%TYPE,
    p_data_origin                  srrtpts.srrtpts_data_origin%TYPE DEFAULT NULL,
    p_rowid_out                OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_tesc_code   Test Code for which the date origin will established. VARCHAR2(4) Required Key
p_tesc_code_date_origin   Test date origin for the data file. VARCHAR2(4) Required
p_user_id   Unique identification of the user. VARCHAR2(30) Required
p_sys_req_ind   This field indicates that a record is delivered by SunGard and is required by the system. VARCHAR2(1) Required
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_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE,
    p_rowid                        gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_tesc_code   Test Code for which the date origin will be established. VARCHAR2(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

Procedure p_lock(
    p_tesc_code                    srrtpts.srrtpts_tesc_code%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_tesc_code   Test Code for which the date origin will established. VARCHAR2(4) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

Procedure p_update(
    p_tesc_code                    srrtpts.srrtpts_tesc_code%TYPE,
    p_tesc_code_date_origin        srrtpts.srrtpts_tesc_code_date_origin%TYPE DEFAULT dml_common.f_unspecified_string,
    p_user_id                      srrtpts.srrtpts_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_sys_req_ind                  srrtpts.srrtpts_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_data_origin                  srrtpts.srrtpts_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
    p_rowid                        gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_tesc_code   Test Code for which the date origin will be established. VARCHAR2(4) Required Key
p_tesc_code_date_origin   Test date origin for the data file. VARCHAR2(4) Required
p_user_id   Unique identification of the user. VARCHAR2(30) Required
p_sys_req_ind   This field indicates that a record is delivered by SunGard and is required by the system. VARCHAR2(1) Required
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)