Package sb_edi

Package sb_edi_header

This package provides the Common Business Interface for the EDI Header API (sb_edi_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_header_rec	Business Entity record type
edi_header_ref	Entity cursor variable type
edi_header_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

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

Business Entity Name

edi_header_rec

TYPE edi_header_rec IS RECORD (
  r_dcmt_seqno              shbhead.shbhead_dcmt_seqno%TYPE,
  r_id_date_key             shbhead.shbhead_id_date_key%TYPE,
  r_id_doc_key              shbhead.shbhead_id_doc_key%TYPE,
  r_id_edi_key              shbhead.shbhead_id_edi_key%TYPE,
  r_id_tporg                shbhead.shbhead_id_tporg%TYPE,
  r_pidm                    shbhead.shbhead_pidm%TYPE,
  r_xset_code               shbhead.shbhead_xset_code%TYPE,
  r_ackkey_t                shbhead.shbhead_ackkey_t%TYPE,
  r_send_date               shbhead.shbhead_send_date%TYPE,
  r_send_time               shbhead.shbhead_send_time%TYPE,
  r_stim_code               shbhead.shbhead_stim_code%TYPE,
  r_xprp_code               shbhead.shbhead_xprp_code%TYPE,
  r_xrsn_code               shbhead.shbhead_xrsn_code%TYPE,
  r_sid_ssnum               shbhead.shbhead_sid_ssnum%TYPE,
  r_sid_agency_num          shbhead.shbhead_sid_agency_num%TYPE,
  r_sid_agency_desc         shbhead.shbhead_sid_agency_desc%TYPE,
  r_dob_qual                shbhead.shbhead_dob_qual%TYPE,
  r_dob_date_code           shbhead.shbhead_dob_date_code%TYPE,
  r_gender                  shbhead.shbhead_gender%TYPE,
  r_marital                 shbhead.shbhead_marital%TYPE,
  r_ethnic                  shbhead.shbhead_ethnic%TYPE,
  r_citizen                 shbhead.shbhead_citizen%TYPE,
  r_home_cntry              shbhead.shbhead_home_cntry%TYPE,
  r_dcmt_image              shbhead.shbhead_dcmt_image%TYPE,
  r_xml_transcript          shbhead.shbhead_xml_transcript%TYPE,
  r_user_id                 shbhead.shbhead_user_id%TYPE,
  r_data_origin             shbhead.shbhead_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_header_ref

TYPE edi_header_ref IS REF CURSOR RETURN edi_header_rec;

Entity cursor variable type

edi_header_tab

TYPE edi_header_tab IS TABLE OF edi_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 shbhead.shbhead_dcmt_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 ID number. 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_header_rec,
                   rec_two edi_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_header_rec Required.
	rec_two	The second record to compare. Type edi_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 shbhead.shbhead_dcmt_seqno%TYPE)
   RETURN edi_header_ref;

Selects all records for the entity.

Parameters

p_dcmt_seqno

EDI document ID number. 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 shbhead.shbhead_dcmt_seqno%TYPE)
   RETURN edi_header_ref;

Selects one record using the key.

Parameters

p_dcmt_seqno

EDI document ID number. 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_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 shbhead.shbhead_dcmt_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_header_ref;

Selects one record and locks it.

Parameters

	p_dcmt_seqno	EDI document ID number. 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      shbhead.shbhead_dcmt_seqno%TYPE,
                   p_id_date_key     shbhead.shbhead_id_date_key%TYPE,
                   p_id_doc_key      shbhead.shbhead_id_doc_key%TYPE,
                   p_id_edi_key      shbhead.shbhead_id_edi_key%TYPE,
                   p_id_tporg        shbhead.shbhead_id_tporg%TYPE,
                   p_pidm            shbhead.shbhead_pidm%TYPE DEFAULT NULL,
                   p_xset_code       shbhead.shbhead_xset_code%TYPE DEFAULT NULL,
                   p_ackkey_t        shbhead.shbhead_ackkey_t%TYPE DEFAULT NULL,
                   p_send_date       shbhead.shbhead_send_date%TYPE DEFAULT NULL,
                   p_send_time       shbhead.shbhead_send_time%TYPE DEFAULT NULL,
                   p_stim_code       shbhead.shbhead_stim_code%TYPE DEFAULT NULL,
                   p_xprp_code       shbhead.shbhead_xprp_code%TYPE DEFAULT NULL,
                   p_xrsn_code       shbhead.shbhead_xrsn_code%TYPE DEFAULT NULL,
                   p_sid_ssnum       shbhead.shbhead_sid_ssnum%TYPE DEFAULT NULL,
                   p_sid_agency_num  shbhead.shbhead_sid_agency_num%TYPE DEFAULT NULL,
                   p_sid_agency_desc shbhead.shbhead_sid_agency_desc%TYPE DEFAULT NULL,
                   p_dob_qual        shbhead.shbhead_dob_qual%TYPE DEFAULT NULL,
                   p_dob_date_code   shbhead.shbhead_dob_date_code%TYPE DEFAULT NULL,
                   p_gender          shbhead.shbhead_gender%TYPE DEFAULT NULL,
                   p_marital         shbhead.shbhead_marital%TYPE DEFAULT NULL,
                   p_ethnic          shbhead.shbhead_ethnic%TYPE DEFAULT NULL,
                   p_citizen         shbhead.shbhead_citizen%TYPE DEFAULT NULL,
                   p_home_cntry      shbhead.shbhead_home_cntry%TYPE DEFAULT NULL,
                   p_dcmt_image      shbhead.shbhead_dcmt_image%TYPE DEFAULT NULL,
                   p_xml_transcript  shbhead.shbhead_xml_transcript%TYPE DEFAULT NULL,
                   p_user_id         shbhead.shbhead_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     shbhead.shbhead_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_id_date_key	EDI document date code. NUMBER(6) Required.
	p_id_doc_key	EDI document type code. NUMBER(3) Required.
	p_id_edi_key	EDI document key. VARCHAR2(35) Required.
	p_id_tporg	EDI document key item. VARCHAR2(8) Required.
	p_pidm	EDI document association. NUMBER(8).
	p_xset_code	EDI transaction set code. VARCHAR2(2).
	p_ackkey_t	EDI acknowledgement key. VARCHAR2(9).
	p_send_date	EDI send date. VARCHAR2(6).
	p_send_time	EDI send time. VARCHAR2(6).
	p_stim_code	EDI time code. VARCHAR2(2).
	p_xprp_code	EDI transcript purpose code. VARCHAR2(2).
	p_xrsn_code	EDI reason for sending transcript. VARCHAR2(3).
	p_sid_ssnum	EDI student ID (SSN). VARCHAR2(9).
	p_sid_agency_num	EDI student ID (agency number). VARCHAR2(30).
	p_sid_agency_desc	EDI description of student ID. VARCHAR2(80).
	p_dob_qual	EDI date of birth qualifier. VARCHAR2(3).
	p_dob_date_code	EDI date of birth. VARCHAR2(8).
	p_gender	EDI gender or sex. VARCHAR2(1).
	p_marital	EDI marital status code. VARCHAR2(1).
	p_ethnic	EDI ethnic code. VARCHAR2(1).
	p_citizen	EDI citizenship status. VARCHAR2(2).
	p_home_cntry	EDI home country code. VARCHAR2(3).
	p_dcmt_image	Text image of transcript. LONG.
	p_xml_transcript	XML transcript as sent by the institution. CLOB.
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30).
	p_data_origin	Source system that created or updated the row. VARCHAR2(30).
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required.

p_delete

PROCEDURE p_delete(p_dcmt_seqno shbhead.shbhead_dcmt_seqno%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_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

PROCEDURE p_lock(p_dcmt_seqno  shbhead.shbhead_dcmt_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 ID number. 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      shbhead.shbhead_dcmt_seqno%TYPE,
                   p_id_date_key     shbhead.shbhead_id_date_key%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_id_doc_key      shbhead.shbhead_id_doc_key%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_id_edi_key      shbhead.shbhead_id_edi_key%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_id_tporg        shbhead.shbhead_id_tporg%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pidm            shbhead.shbhead_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_xset_code       shbhead.shbhead_xset_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ackkey_t        shbhead.shbhead_ackkey_t%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_send_date       shbhead.shbhead_send_date%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_send_time       shbhead.shbhead_send_time%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stim_code       shbhead.shbhead_stim_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_xprp_code       shbhead.shbhead_xprp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_xrsn_code       shbhead.shbhead_xrsn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sid_ssnum       shbhead.shbhead_sid_ssnum%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sid_agency_num  shbhead.shbhead_sid_agency_num%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sid_agency_desc shbhead.shbhead_sid_agency_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dob_qual        shbhead.shbhead_dob_qual%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dob_date_code   shbhead.shbhead_dob_date_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_gender          shbhead.shbhead_gender%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_marital         shbhead.shbhead_marital%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ethnic          shbhead.shbhead_ethnic%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_citizen         shbhead.shbhead_citizen%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_home_cntry      shbhead.shbhead_home_cntry%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dcmt_image      shbhead.shbhead_dcmt_image%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_xml_transcript  shbhead.shbhead_xml_transcript%TYPE DEFAULT dml_common.f_unspecified_clob,
                   p_user_id         shbhead.shbhead_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     shbhead.shbhead_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_id_date_key	EDI document date code. NUMBER(6) Required.
	p_id_doc_key	EDI document type code. NUMBER(3) Required.
	p_id_edi_key	EDI document key. VARCHAR2(35) Required.
	p_id_tporg	EDI document key item. VARCHAR2(8) Required.
	p_pidm	EDI document association. NUMBER(8).
	p_xset_code	EDI transaction set code. VARCHAR2(2).
	p_ackkey_t	EDI acknowledgement key. VARCHAR2(9).
	p_send_date	EDI send date. VARCHAR2(6).
	p_send_time	EDI send time. VARCHAR2(6).
	p_stim_code	EDI time code. VARCHAR2(2).
	p_xprp_code	EDI transcript purpose code. VARCHAR2(2).
	p_xrsn_code	EDI reason for sending transcript. VARCHAR2(3).
	p_sid_ssnum	EDI student ID (SSN). VARCHAR2(9).
	p_sid_agency_num	EDI student ID (agency number). VARCHAR2(30).
	p_sid_agency_desc	EDI description of student ID. VARCHAR2(80).
	p_dob_qual	EDI date of birth qualifier. VARCHAR2(3).
	p_dob_date_code	EDI date of birth. VARCHAR2(8).
	p_gender	EDI gender or sex. VARCHAR2(1).
	p_marital	EDI marital status code. VARCHAR2(1).
	p_ethnic	EDI ethnic code. VARCHAR2(1).
	p_citizen	EDI citizenship status. VARCHAR2(2).
	p_home_cntry	EDI home country code. VARCHAR2(3).
	p_dcmt_image	Text image of transcript. LONG.
	p_xml_transcript	XML transcript as sent by the institution. CLOB.
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30).
	p_data_origin	Source system that created or updated the row. VARCHAR2(30).
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18).