Package sb_edi

Package sb_edi_test

This package provides the Common Business Interface for the EDI Test API (sb_edi_test).
This API is responsible for accessing the SHRTEST table, which holds test records of imported 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_test_rec	Business Entity record type
edi_test_ref	Entity cursor variable type
edi_test_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(8) := 'EDI_TEST';

Business Entity Name

edi_test_rec

TYPE edi_test_rec IS RECORD (
  r_dcmt_seqno              shrtest.shrtest_dcmt_seqno%TYPE,
  r_seqno                   shrtest.shrtest_seqno%TYPE,
  r_test_code               shrtest.shrtest_test_code%TYPE,
  r_testname                shrtest.shrtest_testname%TYPE,
  r_date_type               shrtest.shrtest_date_type%TYPE,
  r_date_value              shrtest.shrtest_date_value%TYPE,
  r_levl_code               shrtest.shrtest_levl_code%TYPE,
  r_message                 shrtest.shrtest_message%TYPE,
  r_user_id                 shrtest.shrtest_user_id%TYPE,
  r_data_origin             shrtest.shrtest_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_test_ref

TYPE edi_test_ref IS REF CURSOR RETURN edi_test_rec;

Entity cursor variable type

edi_test_tab

TYPE edi_test_tab IS TABLE OF edi_test_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 shrtest.shrtest_dcmt_seqno%TYPE,
                  p_seqno      shrtest.shrtest_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_seqno	Sequence number for this test 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_test_rec,
                   rec_two edi_test_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_test_rec Required.
	rec_two	The second record to compare. Type edi_test_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 shrtest.shrtest_dcmt_seqno%TYPE,
                     p_seqno      shrtest.shrtest_seqno%TYPE)
   RETURN edi_test_ref;

Selects all records for the entity.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_seqno	Sequence number for this test 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 shrtest.shrtest_dcmt_seqno%TYPE,
                     p_seqno      shrtest.shrtest_seqno%TYPE)
   RETURN edi_test_ref;

Selects one record using the key.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_seqno	Sequence number for this test 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_test_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 shrtest.shrtest_dcmt_seqno%TYPE,
                          p_seqno      shrtest.shrtest_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_test_ref;

Selects one record and locks it.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_seqno	Sequence number for this test 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  shrtest.shrtest_dcmt_seqno%TYPE,
                   p_seqno       shrtest.shrtest_seqno%TYPE,
                   p_test_code   shrtest.shrtest_test_code%TYPE,
                   p_testname    shrtest.shrtest_testname%TYPE DEFAULT NULL,
                   p_date_type   shrtest.shrtest_date_type%TYPE DEFAULT NULL,
                   p_date_value  shrtest.shrtest_date_value%TYPE DEFAULT NULL,
                   p_levl_code   shrtest.shrtest_levl_code%TYPE DEFAULT NULL,
                   p_message     shrtest.shrtest_message%TYPE DEFAULT NULL,
                   p_user_id     shrtest.shrtest_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin shrtest.shrtest_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_seqno	Sequence number for this test from the transcript. NUMBER(8) Required Key.
	p_test_code	Test code for this test. VARCHAR2(8) Required.
	p_testname	Test name element from the XML transcript. VARCHAR2(60).
	p_date_type	Date when a standardized test was administered to the person. Values are TestDate, TestyearMonth, Testyear. VARCHAR2(20).
	p_date_value	Must contain a value if DATE_TYPE contains a value. VARCHAR2(20).
	p_levl_code	Level code of the student. VARCHAR2(2).
	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 shrtest.shrtest_dcmt_seqno%TYPE,
                   p_seqno      shrtest.shrtest_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_seqno	Sequence number for this test 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  shrtest.shrtest_dcmt_seqno%TYPE,
                 p_seqno       shrtest.shrtest_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_seqno	Sequence number for this test 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  shrtest.shrtest_dcmt_seqno%TYPE,
                   p_seqno       shrtest.shrtest_seqno%TYPE,
                   p_test_code   shrtest.shrtest_test_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_testname    shrtest.shrtest_testname%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_date_type   shrtest.shrtest_date_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_date_value  shrtest.shrtest_date_value%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_levl_code   shrtest.shrtest_levl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_message     shrtest.shrtest_message%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     shrtest.shrtest_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin shrtest.shrtest_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_seqno	Sequence number for this test from the transcript. NUMBER(8) Required Key.
	p_test_code	Test code for this test. VARCHAR2(8) Required.
	p_testname	Test name element from the XML transcript. VARCHAR2(60).
	p_date_type	Date when a standardized test was administered to the person. Values are TestDate, TestyearMonth, Testyear. VARCHAR2(20).
	p_date_value	Must contain a value if DATE_TYPE contains a value. VARCHAR2(20).
	p_levl_code	Level code of the student. VARCHAR2(2).
	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	Database ROWID of the record to be updated. VARCHAR2(18).