index

Package sb_test_percentile

This package provides the Common Business interface for the Test Percentile API (sb_test_percentile).
 
It supports the Test Percentile table (SORTSCP) which contains percentile details for the master test table (SORTEST).
The unique identifier (PIDM), test score code and test date must match those in the SORTEST table, and then multiple percentile types (TSPT codes) can be entered for each master test record.
 
The suggested use of the table is to record national, state and local percentiles for a given learner, applicant or recruit's test record.  Percentile information can come from a test tape or be entered on a Banner form.

Program units
f_api_version  
f_exists  
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
test_percentile_rec  
test_percentile_ref  
test_percentile_tab  

Constants
M_ENTITY_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(15) := 'TEST_PERCENTILE';

Business Entity Name

test_percentile_rec 

TYPE test_percentile_rec IS RECORD (
  r_pidm                    sortspc.sortspc_pidm%TYPE,
  r_tesc_code               sortspc.sortspc_tesc_code%TYPE,
  r_test_date               sortspc.sortspc_test_date%TYPE,
  r_tspt_code               sortspc.sortspc_tspt_code%TYPE,
  r_percentile              sortspc.sortspc_percentile%TYPE,
  r_user_id                 sortspc.sortspc_user_id%TYPE,
  r_data_origin             sortspc.sortspc_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

test_percentile_ref 

TYPE test_percentile_ref IS REF CURSOR RETURN test_percentile_rec;

Entity cursor variable type

test_percentile_tab 

TYPE test_percentile_tab IS TABLE OF test_percentile_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                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_pidm   Internal Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) 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                     test_percentile_rec,
    rec_two                     test_percentile_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 test_percentile_rec Required
rec_two   The second record to compare. Type test_percentile_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                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE) RETURN test_percentile_ref

Selects all records for the entity.

Parameters
p_pidm   Internal Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) Required Key

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

f_query_one 

Function f_query_one(
    p_pidm                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE) RETURN test_percentile_ref

Selects one record using the key.

Parameters
p_pidm   Internal Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) 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 test_percentile_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                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN test_percentile_ref

Selects one record and locks it.

Parameters
p_pidm   Internal Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) 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                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE,
    p_percentile                sortspc.sortspc_percentile%TYPE,
    p_user_id                   sortspc.sortspc_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_data_origin               sortspc.sortspc_data_origin%TYPE DEFAULT NULL,
    p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Internal Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) Required Key
p_percentile   Percentile associated with the test code and type. VARCHAR2(10) Required
p_user_id   Unique identification of the user. VARCHAR2(30) 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_pidm                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Internal Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(
    p_pidm                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE,
    p_rowid_inout        IN OUT gb_common.internal_record_id_type)

Locks a record.
If 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 Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(
    p_pidm                      sortspc.sortspc_pidm%TYPE,
    p_tesc_code                 sortspc.sortspc_tesc_code%TYPE,
    p_test_date                 sortspc.sortspc_test_date%TYPE,
    p_tspt_code                 sortspc.sortspc_tspt_code%TYPE,
    p_percentile                sortspc.sortspc_percentile%TYPE DEFAULT dml_common.f_unspecified_string,
    p_user_id                   sortspc.sortspc_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_data_origin               sortspc.sortspc_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 Banner ID for which the percentiles are being reported. NUMBER(8) Required Key
p_tesc_code   Test code for which the percentiles are being reported. VARCHAR2(4) Required Key
p_test_date   Date that the test was taken. DATE Required Key
p_tspt_code   Type of percentile being reported. VARCHAR2(10) Required Key
p_percentile   Percentile associated with the test code and type. VARCHAR2(10) Required
p_user_id   Unique identification of the user. VARCHAR2(30) 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)