index

Package sb_edi_subtest

This package provides the Common Business Interface for the EDI Subtest API (sb_edi_subtest).
This API accesses the SHRSTST table, which holds subtest records for 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_rec   Business Entity record type
edi_subtest_ref   Entity cursor variable type
edi_subtest_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(11) := 'EDI_SUBTEST';

Business Entity Name

edi_subtest_rec 

TYPE edi_subtest_rec IS RECORD (
  r_dcmt_seqno              shrstst.shrstst_dcmt_seqno%TYPE,
  r_test_seqno              shrstst.shrstst_test_seqno%TYPE,
  r_seqno                   shrstst.shrstst_seqno%TYPE,
  r_tesc_code               shrstst.shrstst_tesc_code%TYPE,
  r_subtestname             shrstst.shrstst_subtestname%TYPE,
  r_message                 shrstst.shrstst_message%TYPE,
  r_user_id                 shrstst.shrstst_user_id%TYPE,
  r_data_origin             shrstst.shrstst_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_subtest_ref 

TYPE edi_subtest_ref IS REF CURSOR RETURN edi_subtest_rec;

Entity cursor variable type

edi_subtest_tab 

TYPE edi_subtest_tab IS TABLE OF edi_subtest_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 shrstst.shrstst_dcmt_seqno%TYPE,
                  p_test_seqno shrstst.shrstst_test_seqno%TYPE,
                  p_seqno      shrstst.shrstst_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_seqno   Sequence number for this subtest 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_rec,
                   rec_two edi_subtest_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_rec Required.
rec_two   The second record to compare. Type edi_subtest_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 shrstst.shrstst_dcmt_seqno%TYPE,
                     p_test_seqno shrstst.shrstst_test_seqno%TYPE,
                     p_seqno      shrstst.shrstst_seqno%TYPE)
   RETURN edi_subtest_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_seqno   Sequence number for this subtest 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 shrstst.shrstst_dcmt_seqno%TYPE,
                     p_test_seqno shrstst.shrstst_test_seqno%TYPE,
                     p_seqno      shrstst.shrstst_seqno%TYPE)
   RETURN edi_subtest_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_seqno   Sequence number for this subtest 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_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 shrstst.shrstst_dcmt_seqno%TYPE,
                          p_test_seqno shrstst.shrstst_test_seqno%TYPE,
                          p_seqno      shrstst.shrstst_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_subtest_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_seqno   Sequence number for this subtest 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  shrstst.shrstst_dcmt_seqno%TYPE,
                   p_test_seqno  shrstst.shrstst_test_seqno%TYPE,
                   p_seqno       shrstst.shrstst_seqno%TYPE,
                   p_tesc_code   shrstst.shrstst_tesc_code%TYPE,
                   p_subtestname shrstst.shrstst_subtestname%TYPE DEFAULT NULL,
                   p_message     shrstst.shrstst_message%TYPE DEFAULT NULL,
                   p_user_id     shrstst.shrstst_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin shrstst.shrstst_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_seqno   Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
p_tesc_code   Test code for this test. VARCHAR2(4) Required.
p_subtestname   Sub test name element from the XML transcript. VARCHAR2(60).
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 shrstst.shrstst_dcmt_seqno%TYPE,
                   p_test_seqno shrstst.shrstst_test_seqno%TYPE,
                   p_seqno      shrstst.shrstst_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_seqno   Sequence number for this subtest 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  shrstst.shrstst_dcmt_seqno%TYPE,
                 p_test_seqno  shrstst.shrstst_test_seqno%TYPE,
                 p_seqno       shrstst.shrstst_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_seqno   Sequence number for this subtest 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  shrstst.shrstst_dcmt_seqno%TYPE,
                   p_test_seqno  shrstst.shrstst_test_seqno%TYPE,
                   p_seqno       shrstst.shrstst_seqno%TYPE,
                   p_tesc_code   shrstst.shrstst_tesc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_subtestname shrstst.shrstst_subtestname%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_message     shrstst.shrstst_message%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     shrstst.shrstst_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin shrstst.shrstst_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_seqno   Sequence number for this subtest from the transcript. NUMBER(8) Required Key.
p_tesc_code   Test code for this test. VARCHAR2(4) Required.
p_subtestname   Sub test name element from the XML transcript. VARCHAR2(60).
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)