Package sb_edi_immunization

This package provides the Common Business interface for the EDI Immunization API (sb_edi_immunization).

Program units

f_api_version	Returns the API version number.
f_exists	Checks 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_immunization_rec	Business Entity record type
edi_immunization_ref	Entity cursor variable type
edi_immunization_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(16) := 'EDI_IMMUNIZATION';

Business Entity Name

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'SHRIMMU';

Base table name

edi_immunization_rec

TYPE edi_immunization_rec IS RECORD (
  r_dcmt_seqno              shrimmu.shrimmu_dcmt_seqno%TYPE,
  r_immu_code               shrimmu.shrimmu_immu_code%TYPE,
  r_seq_no                  shrimmu.shrimmu_seq_no%TYPE,
  r_user_id                 shrimmu.shrimmu_user_id%TYPE,
  r_immu_date               shrimmu.shrimmu_immu_date%TYPE,
  r_imst_code               shrimmu.shrimmu_imst_code%TYPE,
  r_rpt_cde                 shrimmu.shrimmu_rpt_cde%TYPE,
  r_comment                 shrimmu.shrimmu_comment%TYPE,
  r_data_origin             shrimmu.shrimmu_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_immunization_ref

TYPE edi_immunization_ref IS REF CURSOR RETURN edi_immunization_rec;

Entity cursor variable type

edi_immunization_tab

TYPE edi_immunization_tab IS TABLE OF edi_immunization_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 shrimmu.shrimmu_dcmt_seqno%TYPE,
                  p_immu_code  shrimmu.shrimmu_immu_code%TYPE,
                  p_seq_no     shrimmu.shrimmu_seq_no%TYPE,
                  p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_dcmt_seqno	EDI document sequence internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(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_immunization_rec,
                   rec_two edi_immunization_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_immunization_rec Required
	rec_two	The second record to compare. Type edi_immunization_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 shrimmu.shrimmu_dcmt_seqno%TYPE,
                     p_immu_code  shrimmu.shrimmu_immu_code%TYPE,
                     p_seq_no     shrimmu.shrimmu_seq_no%TYPE)
  RETURN edi_immunization_ref

Selects all records for the entity.

Parameters

	p_dcmt_seqno	EDI document sequence internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(2) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_dcmt_seqno shrimmu.shrimmu_dcmt_seqno%TYPE,
                     p_immu_code  shrimmu.shrimmu_immu_code%TYPE,
                     p_seq_no     shrimmu.shrimmu_seq_no%TYPE)
  RETURN edi_immunization_ref

Selects one record using the key.

Parameters

	p_dcmt_seqno	EDI document sequence internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(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_immunization_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 shrimmu.shrimmu_dcmt_seqno%TYPE,
                          p_immu_code  shrimmu.shrimmu_immu_code%TYPE,
                          p_seq_no     shrimmu.shrimmu_seq_no%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN edi_immunization_ref

Selects one record and locks it.

Parameters

	p_dcmt_seqno	EDI document sequence internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(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  shrimmu.shrimmu_dcmt_seqno%TYPE,
                   p_immu_code   shrimmu.shrimmu_immu_code%TYPE,
                   p_seq_no      shrimmu.shrimmu_seq_no%TYPE,
                   p_user_id     shrimmu.shrimmu_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_immu_date   shrimmu.shrimmu_immu_date%TYPE DEFAULT NULL,
                   p_imst_code   shrimmu.shrimmu_imst_code%TYPE DEFAULT NULL,
                   p_rpt_cde     shrimmu.shrimmu_rpt_cde%TYPE DEFAULT NULL,
                   p_comment     shrimmu.shrimmu_comment%TYPE DEFAULT NULL,
                   p_data_origin shrimmu.shrimmu_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_dcmt_seqno	EDI document sequence internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(2) Required Key
	p_user_id	User ID of the last person who updated this record. VARCHAR2(30) Required
	p_immu_date	Date associated with the immunization. DATE
	p_imst_code	Immunization status code. VARCHAR2(2)
	p_rpt_cde	EDI immunization report type code. VARCHAR2(2)
	p_comment	Comment on the immunization record. VARCHAR2(4000)
	p_data_origin	Latest source for the data contained in this 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 shrimmu.shrimmu_dcmt_seqno%TYPE,
                   p_immu_code  shrimmu.shrimmu_immu_code%TYPE,
                   p_seq_no     shrimmu.shrimmu_seq_no%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_dcmt_seqno	EDI document sequence internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_dcmt_seqno  shrimmu.shrimmu_dcmt_seqno%TYPE,
                 p_immu_code   shrimmu.shrimmu_immu_code%TYPE,
                 p_seq_no      shrimmu.shrimmu_seq_no%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks a record.
If 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 internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(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  shrimmu.shrimmu_dcmt_seqno%TYPE,
                   p_immu_code   shrimmu.shrimmu_immu_code%TYPE,
                   p_seq_no      shrimmu.shrimmu_seq_no%TYPE,
                   p_user_id     shrimmu.shrimmu_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_immu_date   shrimmu.shrimmu_immu_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_imst_code   shrimmu.shrimmu_imst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rpt_cde     shrimmu.shrimmu_rpt_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_comment     shrimmu.shrimmu_comment%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin shrimmu.shrimmu_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 internal identification number. NUMBER(8) Required Key
	p_immu_code	Immunization code associated with the student. VARCHAR2(10) Required Key
	p_seq_no	Internal sequence number. NUMBER(2) Required Key
	p_user_id	User ID of the last person who updated this record. VARCHAR2(30) Required
	p_immu_date	Date associated with the immunization. DATE
	p_imst_code	Immunization status code. VARCHAR2(2)
	p_rpt_cde	EDI immunization report type code. VARCHAR2(2)
	p_comment	Comment on the immunization record. VARCHAR2(4000)
	p_data_origin	Latest source for the data contained in this record. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)