Package sb_edi_doc

Package sb_edi_doc_header

This package provides the Common Business Interface for the EDI document Header API (sb_edi_doc_header).
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_doc_header_rec	Business Entity record type
edi_doc_header_ref	Entity cursor variable type
edi_doc_header_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(14) := 'EDI_DOC_HEADER';

Business Entity Name

edi_doc_header_rec

TYPE edi_doc_header_rec IS RECORD (
  r_dcmt_seqno              shrhdr4.shrhdr4_dcmt_seqno%TYPE,
  r_enty_code               shrhdr4.shrhdr4_enty_code%TYPE,
  r_enty_name_1             shrhdr4.shrhdr4_enty_name_1%TYPE,
  r_inql_code               shrhdr4.shrhdr4_inql_code%TYPE,
  r_inst_code               shrhdr4.shrhdr4_inst_code%TYPE,
  r_enty_name_2             shrhdr4.shrhdr4_enty_name_2%TYPE,
  r_enty_name_3             shrhdr4.shrhdr4_enty_name_3%TYPE,
  r_street_line1            shrhdr4.shrhdr4_street_line1%TYPE,
  r_street_line2            shrhdr4.shrhdr4_street_line2%TYPE,
  r_city                    shrhdr4.shrhdr4_city%TYPE,
  r_stat_code               shrhdr4.shrhdr4_stat_code%TYPE,
  r_zip                     shrhdr4.shrhdr4_zip%TYPE,
  r_natn_code               shrhdr4.shrhdr4_natn_code%TYPE,
  r_ctfn_code               shrhdr4.shrhdr4_ctfn_code%TYPE,
  r_contact_name            shrhdr4.shrhdr4_contact_name%TYPE,
  r_coql_code               shrhdr4.shrhdr4_coql_code%TYPE,
  r_comm_no                 shrhdr4.shrhdr4_comm_no%TYPE,
  r_domestic_addr_ind       shrhdr4.shrhdr4_domestic_addr_ind%TYPE,
  r_street_line3            shrhdr4.shrhdr4_street_line3%TYPE,
  r_stateprovince           shrhdr4.shrhdr4_stateprovince%TYPE,
  r_data_origin             shrhdr4.shrhdr4_data_origin%TYPE,
  r_user_id                 shrhdr4.shrhdr4_user_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_doc_header_ref

TYPE edi_doc_header_ref IS REF CURSOR RETURN edi_doc_header_rec;

Entity cursor variable type

edi_doc_header_tab

TYPE edi_doc_header_tab IS TABLE OF edi_doc_header_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 shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                  p_enty_code  shrhdr4.shrhdr4_enty_code%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 ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) 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_doc_header_rec,
                   rec_two edi_doc_header_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_doc_header_rec Required.
	rec_two	The second record to compare. type edi_doc_header_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 shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                     p_enty_code  shrhdr4.shrhdr4_enty_code%TYPE)
   RETURN edi_doc_header_ref;

Selects all records for the entity.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) Required Key.

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_dcmt_seqno shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                     p_enty_code  shrhdr4.shrhdr4_enty_code%TYPE)
   RETURN edi_doc_header_ref;

Selects one record using the key.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) 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_doc_header_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 shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                          p_enty_code  shrhdr4.shrhdr4_enty_code%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_doc_header_ref;

Selects one record and locks it.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) 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        shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                   p_enty_code         shrhdr4.shrhdr4_enty_code%TYPE,
                   p_enty_name_1       shrhdr4.shrhdr4_enty_name_1%TYPE DEFAULT NULL,
                   p_inql_code         shrhdr4.shrhdr4_inql_code%TYPE DEFAULT NULL,
                   p_inst_code         shrhdr4.shrhdr4_inst_code%TYPE DEFAULT NULL,
                   p_enty_name_2       shrhdr4.shrhdr4_enty_name_2%TYPE DEFAULT NULL,
                   p_enty_name_3       shrhdr4.shrhdr4_enty_name_3%TYPE DEFAULT NULL,
                   p_street_line1      shrhdr4.shrhdr4_street_line1%TYPE DEFAULT NULL,
                   p_street_line2      shrhdr4.shrhdr4_street_line2%TYPE DEFAULT NULL,
                   p_city              shrhdr4.shrhdr4_city%TYPE DEFAULT NULL,
                   p_stat_code         shrhdr4.shrhdr4_stat_code%TYPE DEFAULT NULL,
                   p_zip               shrhdr4.shrhdr4_zip%TYPE DEFAULT NULL,
                   p_natn_code         shrhdr4.shrhdr4_natn_code%TYPE DEFAULT NULL,
                   p_ctfn_code         shrhdr4.shrhdr4_ctfn_code%TYPE DEFAULT NULL,
                   p_contact_name      shrhdr4.shrhdr4_contact_name%TYPE DEFAULT NULL,
                   p_coql_code         shrhdr4.shrhdr4_coql_code%TYPE DEFAULT NULL,
                   p_comm_no           shrhdr4.shrhdr4_comm_no%TYPE DEFAULT NULL,
                   p_domestic_addr_ind shrhdr4.shrhdr4_domestic_addr_ind%TYPE DEFAULT NULL,
                   p_street_line3      shrhdr4.shrhdr4_street_line3%TYPE DEFAULT NULL,
                   p_stateprovince     shrhdr4.shrhdr4_stateprovince%TYPE DEFAULT NULL,
                   p_data_origin       shrhdr4.shrhdr4_data_origin%TYPE DEFAULT NULL,
                   p_user_id           shrhdr4.shrhdr4_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out         OUT gb_common.internal_record_id_type);

Creates a record.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) Required Key.
	p_enty_name_1	EDI institutional/agency name. VARCHAR2(35).
	p_inql_code	EDI institutional code qualifier. VARCHAR2(2).
	p_inst_code	EDI institutional code. VARCHAR2(20).
	p_enty_name_2	EDI continuation of name. VARCHAR2(35).
	p_enty_name_3	EDI continuation of name. VARCHAR2(35).
	p_street_line1	EDI institution address. VARCHAR2(35).
	p_street_line2	EDI institution address. VARCHAR2(35).
	p_city	EDI institution address. VARCHAR2(30).
	p_stat_code	EDI institution address. VARCHAR2(2).
	p_zip	EDI institution address. VARCHAR2(9).
	p_natn_code	EDI institution address. VARCHAR2(3).
	p_ctfn_code	EDI contact function code. VARCHAR2(2).
	p_contact_name	EDI contact name. VARCHAR2(35).
	p_coql_code	EDI communication number qualifier. VARCHAR2(2).
	p_comm_no	EDI communication number. VARCHAR2(80).
	p_domestic_addr_ind	Y if address is domestic. For PESCXML. VARCHAR2(1).
	p_street_line3	Third address line. For PESCXML. VARCHAR2(35).
	p_stateprovince	State or province name for an international address. For PESCXML. VARCHAR2(60).
	p_data_origin	source system that created or updated the row. VARCHAR2(30).
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30).
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required.

p_delete

PROCEDURE p_delete(p_dcmt_seqno shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                   p_enty_code  shrhdr4.shrhdr4_enty_code%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

PROCEDURE p_lock(p_dcmt_seqno  shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                 p_enty_code   shrhdr4.shrhdr4_enty_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 p_rowid_inout.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update

PROCEDURE p_update(p_dcmt_seqno        shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                   p_enty_code         shrhdr4.shrhdr4_enty_code%TYPE,
                   p_enty_name_1       shrhdr4.shrhdr4_enty_name_1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_inql_code         shrhdr4.shrhdr4_inql_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_inst_code         shrhdr4.shrhdr4_inst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_enty_name_2       shrhdr4.shrhdr4_enty_name_2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_enty_name_3       shrhdr4.shrhdr4_enty_name_3%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line1      shrhdr4.shrhdr4_street_line1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line2      shrhdr4.shrhdr4_street_line2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_city              shrhdr4.shrhdr4_city%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stat_code         shrhdr4.shrhdr4_stat_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_zip               shrhdr4.shrhdr4_zip%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_natn_code         shrhdr4.shrhdr4_natn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ctfn_code         shrhdr4.shrhdr4_ctfn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_contact_name      shrhdr4.shrhdr4_contact_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coql_code         shrhdr4.shrhdr4_coql_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_comm_no           shrhdr4.shrhdr4_comm_no%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_domestic_addr_ind shrhdr4.shrhdr4_domestic_addr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line3      shrhdr4.shrhdr4_street_line3%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stateprovince     shrhdr4.shrhdr4_stateprovince%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin       shrhdr4.shrhdr4_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id           shrhdr4.shrhdr4_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid             gb_common.internal_record_id_type DEFAULT NULL);

Updates a record.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_enty_code	EDI-specific organizational entity. VARCHAR2(2) Required Key.
	p_enty_name_1	EDI institutional/agency name. VARCHAR2(35).
	p_inql_code	EDI institutional code qualifier. VARCHAR2(2).
	p_inst_code	EDI institutional code. VARCHAR2(20).
	p_enty_name_2	EDI continuation of name. VARCHAR2(35).
	p_enty_name_3	EDI continuation of name. VARCHAR2(35).
	p_street_line1	EDI institution address. VARCHAR2(35).
	p_street_line2	EDI institution address. VARCHAR2(35).
	p_city	EDI institution address. VARCHAR2(30).
	p_stat_code	EDI institution address. VARCHAR2(2).
	p_zip	EDI institution address. VARCHAR2(9).
	p_natn_code	EDI institution address. VARCHAR2(3).
	p_ctfn_code	EDI contact function code. VARCHAR2(2).
	p_contact_name	EDI contact name. VARCHAR2(35).
	p_coql_code	EDI communication number qualifier. VARCHAR2(2).
	p_comm_no	EDI communication number. VARCHAR2(80).
	p_domestic_addr_ind	Y if address is domestic. For PESCXML. VARCHAR2(1).
	p_street_line3	Third address line. For PESCXML. VARCHAR2(35).
	p_stateprovince	State or province name for an international address. For PESCXML. VARCHAR2(60).
	p_data_origin	source system that created or updated the row. VARCHAR2(30).
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30).
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18).