Package sb_edi_identification

This package provides the Common Business Interface for the EDI Identification API (sb_edi_identification).
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_identification_rec	Business Entity record type
edi_identification_ref	Entity cursor variable type
edi_identification_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(18) := 'EDI_IDENTIFICATION';

Business Entity Name

edi_identification_rec

TYPE edi_identification_rec IS RECORD (
  r_dcmt_seqno              shriden.shriden_dcmt_seqno%TYPE,
  r_idql_code               shriden.shriden_idql_code%TYPE,
  r_idnm_code               shriden.shriden_idnm_code%TYPE,
  r_enid_code               shriden.shriden_enid_code%TYPE,
  r_rnql_code               shriden.shriden_rnql_code%TYPE,
  r_ref_numb                shriden.shriden_ref_numb%TYPE,
  r_rltn_code               shriden.shriden_rltn_code%TYPE,
  r_last_name               shriden.shriden_last_name%TYPE,
  r_name_prefix             shriden.shriden_name_prefix%TYPE,
  r_first_name              shriden.shriden_first_name%TYPE,
  r_first_initial           shriden.shriden_first_initial%TYPE,
  r_middle_name_1           shriden.shriden_middle_name_1%TYPE,
  r_middle_name_2           shriden.shriden_middle_name_2%TYPE,
  r_middle_initial_1        shriden.shriden_middle_initial_1%TYPE,
  r_middle_initial_2        shriden.shriden_middle_initial_2%TYPE,
  r_name_suffix             shriden.shriden_name_suffix%TYPE,
  r_former_name             shriden.shriden_former_name%TYPE,
  r_combined_name           shriden.shriden_combined_name%TYPE,
  r_composite_name          shriden.shriden_composite_name%TYPE,
  r_agency_name             shriden.shriden_agency_name%TYPE,
  r_street_line1            shriden.shriden_street_line1%TYPE,
  r_street_line2            shriden.shriden_street_line2%TYPE,
  r_city                    shriden.shriden_city%TYPE,
  r_stat_code               shriden.shriden_stat_code%TYPE,
  r_zip                     shriden.shriden_zip%TYPE,
  r_natn_code               shriden.shriden_natn_code%TYPE,
  r_id_note                 shriden.shriden_id_note%TYPE,
  r_domestic_addr_ind       shriden.shriden_domestic_addr_ind%TYPE,
  r_street_line3            shriden.shriden_street_line3%TYPE,
  r_stateprovince           shriden.shriden_stateprovince%TYPE,
  r_data_origin             shriden.shriden_data_origin%TYPE,
  r_user_id                 shriden.shriden_user_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_identification_ref

TYPE edi_identification_ref IS REF CURSOR RETURN edi_identification_rec;

Entity cursor variable type

edi_identification_tab

TYPE edi_identification_tab IS TABLE OF edi_identification_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 shriden.shriden_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_identification_rec,
                   rec_two edi_identification_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_identification_rec Required.
	rec_two	The second record to compare. Type edi_identification_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 shriden.shriden_dcmt_seqno%TYPE)
   RETURN edi_identification_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 shriden.shriden_dcmt_seqno%TYPE)
   RETURN edi_identification_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_identification_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 shriden.shriden_dcmt_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_identification_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        shriden.shriden_dcmt_seqno%TYPE,
                   p_idql_code         shriden.shriden_idql_code%TYPE DEFAULT NULL,
                   p_idnm_code         shriden.shriden_idnm_code%TYPE DEFAULT NULL,
                   p_enid_code         shriden.shriden_enid_code%TYPE DEFAULT NULL,
                   p_rnql_code         shriden.shriden_rnql_code%TYPE DEFAULT NULL,
                   p_ref_numb          shriden.shriden_ref_numb%TYPE DEFAULT NULL,
                   p_rltn_code         shriden.shriden_rltn_code%TYPE DEFAULT NULL,
                   p_last_name         shriden.shriden_last_name%TYPE DEFAULT NULL,
                   p_name_prefix       shriden.shriden_name_prefix%TYPE DEFAULT NULL,
                   p_first_name        shriden.shriden_first_name%TYPE DEFAULT NULL,
                   p_first_initial     shriden.shriden_first_initial%TYPE DEFAULT NULL,
                   p_middle_name_1     shriden.shriden_middle_name_1%TYPE DEFAULT NULL,
                   p_middle_name_2     shriden.shriden_middle_name_2%TYPE DEFAULT NULL,
                   p_middle_initial_1  shriden.shriden_middle_initial_1%TYPE DEFAULT NULL,
                   p_middle_initial_2  shriden.shriden_middle_initial_2%TYPE DEFAULT NULL,
                   p_name_suffix       shriden.shriden_name_suffix%TYPE DEFAULT NULL,
                   p_former_name       shriden.shriden_former_name%TYPE DEFAULT NULL,
                   p_combined_name     shriden.shriden_combined_name%TYPE DEFAULT NULL,
                   p_composite_name    shriden.shriden_composite_name%TYPE DEFAULT NULL,
                   p_agency_name       shriden.shriden_agency_name%TYPE DEFAULT NULL,
                   p_street_line1      shriden.shriden_street_line1%TYPE DEFAULT NULL,
                   p_street_line2      shriden.shriden_street_line2%TYPE DEFAULT NULL,
                   p_city              shriden.shriden_city%TYPE DEFAULT NULL,
                   p_stat_code         shriden.shriden_stat_code%TYPE DEFAULT NULL,
                   p_zip               shriden.shriden_zip%TYPE DEFAULT NULL,
                   p_natn_code         shriden.shriden_natn_code%TYPE DEFAULT NULL,
                   p_id_note           shriden.shriden_id_note%TYPE DEFAULT NULL,
                   p_domestic_addr_ind shriden.shriden_domestic_addr_ind%TYPE DEFAULT NULL,
                   p_street_line3      shriden.shriden_street_line3%TYPE DEFAULT NULL,
                   p_stateprovince     shriden.shriden_stateprovince%TYPE DEFAULT NULL,
                   p_data_origin       shriden.shriden_data_origin%TYPE DEFAULT NULL,
                   p_user_id           shriden.shriden_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_idql_code	EDI entity type qualifier code. VARCHAR2(1).
	p_idnm_code	EDI name type code. VARCHAR2(2).
	p_enid_code	EDI entity identifier code. VARCHAR2(2).
	p_rnql_code	EDI reference number qualifier. VARCHAR2(2).
	p_ref_numb	EDI reference number. VARCHAR2(30).
	p_rltn_code	EDI relationship code. VARCHAR2(2).
	p_last_name	EDI last name. VARCHAR2(35).
	p_name_prefix	EDI name Prefix. VARCHAR2(35).
	p_first_name	EDI first name. VARCHAR2(35).
	p_first_initial	EDI first initial. VARCHAR2(35).
	p_middle_name_1	EDI first middle name. VARCHAR2(35).
	p_middle_name_2	EDI second middle name. VARCHAR2(35).
	p_middle_initial_1	EDI first middle initial. VARCHAR2(35).
	p_middle_initial_2	EDI second middle initial. VARCHAR2(35).
	p_name_suffix	EDI name suffix. VARCHAR2(35).
	p_former_name	EDI former name. VARCHAR2(35).
	p_combined_name	EDI combined name (Unstructured). VARCHAR2(35).
	p_composite_name	EDI composite name. VARCHAR2(35).
	p_agency_name	EDI agency name. VARCHAR2(35).
	p_street_line1	EDI student street address. VARCHAR2(35).
	p_street_line2	EDI student street address. VARCHAR2(35).
	p_city	EDI student city. VARCHAR2(30).
	p_stat_code	EDI student state code. VARCHAR2(2).
	p_zip	EDI student ZIP or postal code. VARCHAR2(9).
	p_natn_code	EDI student nation code. VARCHAR2(3).
	p_id_note	EDI note about student name/ID. VARCHAR2(60).
	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 shriden.shriden_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  shriden.shriden_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        shriden.shriden_dcmt_seqno%TYPE,
                   p_idql_code         shriden.shriden_idql_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_idnm_code         shriden.shriden_idnm_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_enid_code         shriden.shriden_enid_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rnql_code         shriden.shriden_rnql_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ref_numb          shriden.shriden_ref_numb%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rltn_code         shriden.shriden_rltn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_last_name         shriden.shriden_last_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_name_prefix       shriden.shriden_name_prefix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_first_name        shriden.shriden_first_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_first_initial     shriden.shriden_first_initial%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_middle_name_1     shriden.shriden_middle_name_1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_middle_name_2     shriden.shriden_middle_name_2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_middle_initial_1  shriden.shriden_middle_initial_1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_middle_initial_2  shriden.shriden_middle_initial_2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_name_suffix       shriden.shriden_name_suffix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_former_name       shriden.shriden_former_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_combined_name     shriden.shriden_combined_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_composite_name    shriden.shriden_composite_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_agency_name       shriden.shriden_agency_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line1      shriden.shriden_street_line1%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line2      shriden.shriden_street_line2%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_city              shriden.shriden_city%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stat_code         shriden.shriden_stat_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_zip               shriden.shriden_zip%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_natn_code         shriden.shriden_natn_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_id_note           shriden.shriden_id_note%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_domestic_addr_ind shriden.shriden_domestic_addr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_street_line3      shriden.shriden_street_line3%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stateprovince     shriden.shriden_stateprovince%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin       shriden.shriden_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id           shriden.shriden_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_idql_code	EDI entity type qualifier code. VARCHAR2(1).
	p_idnm_code	EDI name type code. VARCHAR2(2).
	p_enid_code	EDI entity identifier code. VARCHAR2(2).
	p_rnql_code	EDI reference number qualifier. VARCHAR2(2).
	p_ref_numb	EDI reference number. VARCHAR2(30).
	p_rltn_code	EDI relationship code. VARCHAR2(2).
	p_last_name	EDI last name. VARCHAR2(35).
	p_name_prefix	EDI name prefix. VARCHAR2(35).
	p_first_name	EDI first name. VARCHAR2(35).
	p_first_initial	EDI first initial. VARCHAR2(35).
	p_middle_name_1	EDI first middle name. VARCHAR2(35).
	p_middle_name_2	EDI second middle name. VARCHAR2(35).
	p_middle_initial_1	EDI first middle initial. VARCHAR2(35).
	p_middle_initial_2	EDI second middle initial. VARCHAR2(35).
	p_name_suffix	EDI name suffix. VARCHAR2(35).
	p_former_name	EDI former name. VARCHAR2(35).
	p_combined_name	EDI combined name (Unstructured). VARCHAR2(35).
	p_composite_name	EDI composite name. VARCHAR2(35).
	p_agency_name	EDI agency name. VARCHAR2(35).
	p_street_line1	EDI student street address. VARCHAR2(35).
	p_street_line2	EDI student street address. VARCHAR2(35).
	p_city	EDI student city. VARCHAR2(30).
	p_stat_code	EDI student state code. VARCHAR2(2).
	p_zip	EDI student ZIP or postal code. VARCHAR2(9).
	p_natn_code	EDI student nation code. VARCHAR2(3).
	p_id_note	EDI note about student name/ID. VARCHAR2(60).
	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).