Package sb_edi_subtest

Package sb_edi_subtest_score

This package provides the Common Business Interface for the EDI Subtest Score API (sb_edi_subtest_score).
This API is responsible for accessing the SHRSTSC table, which holds records of subtest scores of imported electronic transcripts. For use with internal processing to produce the XML transcript.

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

edi_subtest_score_rec	Business Entity record type
edi_subtest_score_ref	Entity cursor variable type
edi_subtest_score_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(17) := 'EDI_SUBTEST_SCORE';

Business Entity Name

edi_subtest_score_rec

TYPE edi_subtest_score_rec IS RECORD (
  r_dcmt_seqno              shrstsc.shrstsc_dcmt_seqno%TYPE,
  r_test_seqno              shrstsc.shrstsc_test_seqno%TYPE,
  r_stst_seqno              shrstsc.shrstsc_stst_seqno%TYPE,
  r_seqno                   shrstsc.shrstsc_seqno%TYPE,
  r_score                   shrstsc.shrstsc_score%TYPE,
  r_tefr_code               shrstsc.shrstsc_tefr_code%TYPE,
  r_score_revised_ind       shrstsc.shrstsc_score_revised_ind%TYPE,
  r_score_invalidated_ind   shrstsc.shrstsc_score_invalidated_ind%TYPE,
  r_score_selfreported_ind  shrstsc.shrstsc_score_selfreported_ind%TYPE,
  r_message                 shrstsc.shrstsc_message%TYPE,
  r_user_id                 shrstsc.shrstsc_user_id%TYPE,
  r_data_origin             shrstsc.shrstsc_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_subtest_score_ref

TYPE edi_subtest_score_ref IS REF CURSOR RETURN edi_subtest_score_rec;

Entity cursor variable type

edi_subtest_score_tab

TYPE edi_subtest_score_tab IS TABLE OF edi_subtest_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_dcmt_seqno shrstsc.shrstsc_dcmt_seqno%TYPE,
                  p_test_seqno shrstsc.shrstsc_test_seqno%TYPE,
                  p_stst_seqno shrstsc.shrstsc_stst_seqno%TYPE,
                  p_seqno      shrstsc.shrstsc_seqno%TYPE,
                  p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN VARCHAR2;

Checks to see if a record exists.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) 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 edi_subtest_score_rec,
                   rec_two edi_subtest_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 edi_subtest_score_rec Required.
	rec_two	The second record to compare. type edi_subtest_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_dcmt_seqno shrstsc.shrstsc_dcmt_seqno%TYPE,
                     p_test_seqno shrstsc.shrstsc_test_seqno%TYPE,
                     p_stst_seqno shrstsc.shrstsc_stst_seqno%TYPE,
                     p_seqno      shrstsc.shrstsc_seqno%TYPE)
   RETURN edi_subtest_score_ref;

Selects all records for the entity.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) Required Key.

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_dcmt_seqno shrstsc.shrstsc_dcmt_seqno%TYPE,
                     p_test_seqno shrstsc.shrstsc_test_seqno%TYPE,
                     p_stst_seqno shrstsc.shrstsc_stst_seqno%TYPE,
                     p_seqno      shrstsc.shrstsc_seqno%TYPE)
   RETURN edi_subtest_score_ref;

Selects one record using the key.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) 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 edi_subtest_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_dcmt_seqno shrstsc.shrstsc_dcmt_seqno%TYPE,
                          p_test_seqno shrstsc.shrstsc_test_seqno%TYPE,
                          p_stst_seqno shrstsc.shrstsc_stst_seqno%TYPE,
                          p_seqno      shrstsc.shrstsc_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_subtest_score_ref;

Selects one record and locks it.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) 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_dcmt_seqno             shrstsc.shrstsc_dcmt_seqno%TYPE,
                   p_test_seqno             shrstsc.shrstsc_test_seqno%TYPE,
                   p_stst_seqno             shrstsc.shrstsc_stst_seqno%TYPE,
                   p_seqno                  shrstsc.shrstsc_seqno%TYPE,
                   p_score                  shrstsc.shrstsc_score%TYPE,
                   p_tefr_code              shrstsc.shrstsc_tefr_code%TYPE DEFAULT NULL,
                   p_score_revised_ind      shrstsc.shrstsc_score_revised_ind%TYPE DEFAULT NULL,
                   p_score_invalidated_ind  shrstsc.shrstsc_score_invalidated_ind%TYPE DEFAULT NULL,
                   p_score_selfreported_ind shrstsc.shrstsc_score_selfreported_ind%TYPE DEFAULT NULL,
                   p_message                shrstsc.shrstsc_message%TYPE DEFAULT NULL,
                   p_user_id                shrstsc.shrstsc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin            shrstsc.shrstsc_data_origin%TYPE,
                   p_rowid_out              OUT gb_common.internal_record_id_type);

Creates a record.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) Required Key.
	p_score	Test code for this test. VARCHAR2(80) Required.
	p_tefr_code	Test score method from the XML transcript. VARCHAR2(2).
	p_score_revised_ind	Y if the score reported can differ from previous score reported for this test and test date. VARCHAR2(1).
	p_score_invalidated_ind	Y if the score previously reported for this test and test date is not valid. VARCHAR2(1).
	p_score_selfreported_ind	Y if the score has been asserted by the student but has not been confirmed by the testing agency. VARCHAR2(1).
	p_message	Message for the test from the transcript. VARCHAR2(1000).
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30) Required.
	p_data_origin	Source system that created or updated the row. VARCHAR2(30) Required.
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required.

p_delete

PROCEDURE p_delete(p_dcmt_seqno shrstsc.shrstsc_dcmt_seqno%TYPE,
                   p_test_seqno shrstsc.shrstsc_test_seqno%TYPE,
                   p_stst_seqno shrstsc.shrstsc_stst_seqno%TYPE,
                   p_seqno      shrstsc.shrstsc_seqno%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

PROCEDURE p_lock(p_dcmt_seqno  shrstsc.shrstsc_dcmt_seqno%TYPE,
                 p_test_seqno  shrstsc.shrstsc_test_seqno%TYPE,
                 p_stst_seqno  shrstsc.shrstsc_stst_seqno%TYPE,
                 p_seqno       shrstsc.shrstsc_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 p_rowid_inout.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update

PROCEDURE p_update(p_dcmt_seqno             shrstsc.shrstsc_dcmt_seqno%TYPE,
                   p_test_seqno             shrstsc.shrstsc_test_seqno%TYPE,
                   p_stst_seqno             shrstsc.shrstsc_stst_seqno%TYPE,
                   p_seqno                  shrstsc.shrstsc_seqno%TYPE,
                   p_score                  shrstsc.shrstsc_score%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tefr_code              shrstsc.shrstsc_tefr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_score_revised_ind      shrstsc.shrstsc_score_revised_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_score_invalidated_ind  shrstsc.shrstsc_score_invalidated_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_score_selfreported_ind shrstsc.shrstsc_score_selfreported_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_message                shrstsc.shrstsc_message%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id                shrstsc.shrstsc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin            shrstsc.shrstsc_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                  gb_common.internal_record_id_type DEFAULT NULL);

Updates a record.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_test_seqno	Sequence number for the main test from the transcript. NUMBER(8) Required Key.
	p_stst_seqno	Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
	p_seqno	Sequence number for this subtest score from the transcript. NUMBER(8) Required Key.
	p_score	Test code for this test. VARCHAR2(80) Required.
	p_tefr_code	Test score method from XML transcript. VARCHAR2(2).
	p_score_revised_ind	Y if the score reported can differ from a previous score reported for this test and test date. VARCHAR2(1).
	p_score_invalidated_ind	Y if the score previously reported for this test and test date is not valid. VARCHAR2(1).
	p_score_selfreported_ind	Y if the score has been asserted by the student but has not been confirmed by testing agency. VARCHAR2(1).
	p_message	Message for test from transcript. VARCHAR2(1000).
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30) Required.
	p_data_origin	Source system that created or updated the row. VARCHAR2(30) Required.
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18).