Package sb_edi

Package sb_edi_status

This package provides the Common Business Interface for the EDI Status API (sb_edi_status).
This API is responsible for accessing the SHREDIS table, which holds EDI Status records for the imported electronic transcript. 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_status_rec	Business Entity record type
edi_status_ref	Entity cursor variable type
edi_status_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(10) := 'EDI_STATUS';

Business Entity Name

edi_status_rec

TYPE edi_status_rec IS RECORD (
  r_dcmt_seqno              shredis.shredis_dcmt_seqno%TYPE,
  r_dsts_code               shredis.shredis_dsts_code%TYPE,
  r_comp_ind                shredis.shredis_comp_ind%TYPE,
  r_priority                shredis.shredis_priority%TYPE,
  r_user                    shredis.shredis_user%TYPE,
  r_date_in                 shredis.shredis_date_in%TYPE,
  r_date_out                shredis.shredis_date_out%TYPE,
  r_data_origin             shredis.shredis_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_status_ref

TYPE edi_status_ref IS REF CURSOR RETURN edi_status_rec;

Entity cursor variable type

edi_status_tab

TYPE edi_status_tab IS TABLE OF edi_status_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 shredis.shredis_dcmt_seqno%TYPE,
                  p_dsts_code  shredis.shredis_dsts_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_dsts_code	EDI document disposition status code. VARCHAR2(4) 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_status_rec,
                   rec_two edi_status_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_status_rec Required.
	rec_two	The second record to compare. Type edi_status_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 shredis.shredis_dcmt_seqno%TYPE,
                     p_dsts_code  shredis.shredis_dsts_code%TYPE)
   RETURN edi_status_ref;

Selects all records for the entity.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_dsts_code	EDI document disposition status code. VARCHAR2(4) Required Key.

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_dcmt_seqno shredis.shredis_dcmt_seqno%TYPE,
                     p_dsts_code  shredis.shredis_dsts_code%TYPE)
   RETURN edi_status_ref;

Selects one record using the key.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_dsts_code	EDI document disposition status code. VARCHAR2(4) 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_status_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 shredis.shredis_dcmt_seqno%TYPE,
                          p_dsts_code  shredis.shredis_dsts_code%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_status_ref;

Selects one record and locks it.

Parameters

	p_dcmt_seqno	EDI document ID number. NUMBER(8) Required Key.
	p_dsts_code	EDI document disposition status code. VARCHAR2(4) 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  shredis.shredis_dcmt_seqno%TYPE,
                   p_dsts_code   shredis.shredis_dsts_code%TYPE,
                   p_comp_ind    shredis.shredis_comp_ind%TYPE,
                   p_priority    shredis.shredis_priority%TYPE,
                   p_user        shredis.shredis_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_date_in     shredis.shredis_date_in%TYPE,
                   p_date_out    shredis.shredis_date_out%TYPE DEFAULT NULL,
                   p_data_origin shredis.shredis_data_origin%TYPE DEFAULT NULL,
                   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_dsts_code	EDI document disposition status code. VARCHAR2(4) Required Key.
	p_comp_ind	[A]ctive/[I]nactive. VARCHAR2(1) Required.
	p_priority	EDI document priority. NUMBER(2) Required.
	p_user	EDI user name. VARCHAR2(30) Required.
	p_date_in	EDI date status became active. DATE Required.
	p_date_out	EDI date status became inactive. DATE.
	p_data_origin	Source system that created or updated the data. VARCHAR2(30).
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required.

p_delete

PROCEDURE p_delete(p_dcmt_seqno shredis.shredis_dcmt_seqno%TYPE,
                   p_dsts_code  shredis.shredis_dsts_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_dsts_code	EDI document disposition status code. VARCHAR2(4) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

PROCEDURE p_lock(p_dcmt_seqno  shredis.shredis_dcmt_seqno%TYPE,
                 p_dsts_code   shredis.shredis_dsts_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_dsts_code	EDI document disposition status code. VARCHAR2(4) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update

PROCEDURE p_update(p_dcmt_seqno  shredis.shredis_dcmt_seqno%TYPE,
                   p_dsts_code   shredis.shredis_dsts_code%TYPE,
                   p_comp_ind    shredis.shredis_comp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_priority    shredis.shredis_priority%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user        shredis.shredis_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_date_in     shredis.shredis_date_in%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_date_out    shredis.shredis_date_out%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_data_origin shredis.shredis_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 ID number. NUMBER(8) Required Key.
	p_dsts_code	EDI document disposition status code. VARCHAR2(4) Required Key.
	p_comp_ind	[A]ctive/[I]nactive. VARCHAR2(1) Required.
	p_priority	EDI document priority. NUMBER(2) Required.
	p_user	EDI user name. VARCHAR2(30) Required.
	p_date_in	EDI date status became active. DATE Required.
	p_date_out	EDI date status became inactive. DATE.
	p_data_origin	Source system that created or updated the data. VARCHAR2(30).
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18).