Package sb_edi_acad

Package sb_edi_acad_summ

This package provides the Common Business Interface for the EDI Academic Summary API (sb_edi_acad_summ).
For use with internal processing to produce the XML transcript.

This API is responsible for loading the academic summary from the imported XML transcript document and importing the information into the SHRSUMA table.

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_acad_summ_rec	Business Entity record type
edi_acad_summ_ref	Entity cursor variable type
edi_acad_summ_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(13) := 'EDI_ACAD_SUMM';

Business Entity Name

edi_acad_summ_rec

TYPE edi_acad_summ_rec IS RECORD (
  r_dcmt_seqno              shrsuma.shrsuma_dcmt_seqno%TYPE,
  r_gpa_seqno               shrsuma.shrsuma_gpa_seqno%TYPE,
  r_ctyp_code               shrsuma.shrsuma_ctyp_code%TYPE,
  r_slvl_code               shrsuma.shrsuma_slvl_code%TYPE,
  r_gpa_hours               shrsuma.shrsuma_gpa_hours%TYPE,
  r_hours_attempted         shrsuma.shrsuma_hours_attempted%TYPE,
  r_hours_earned            shrsuma.shrsuma_hours_earned%TYPE,
  r_gpa_low                 shrsuma.shrsuma_gpa_low%TYPE,
  r_gpa_high                shrsuma.shrsuma_gpa_high%TYPE,
  r_gpa                     shrsuma.shrsuma_gpa%TYPE,
  r_gpa_excess_ind          shrsuma.shrsuma_gpa_excess_ind%TYPE,
  r_class_rank              shrsuma.shrsuma_class_rank%TYPE,
  r_class_size              shrsuma.shrsuma_class_size%TYPE,
  r_rdql_code               shrsuma.shrsuma_rdql_code%TYPE,
  r_rank_date               shrsuma.shrsuma_rank_date%TYPE,
  r_data_origin             shrsuma.shrsuma_data_origin%TYPE,
  r_user_id                 shrsuma.shrsuma_user_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

edi_acad_summ_ref

TYPE edi_acad_summ_ref IS REF CURSOR RETURN edi_acad_summ_rec;

Entity cursor variable type

edi_acad_summ_tab

TYPE edi_acad_summ_tab IS TABLE OF edi_acad_summ_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 shrsuma.shrsuma_dcmt_seqno%TYPE,
                  p_gpa_seqno  shrsuma.shrsuma_gpa_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 sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence 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_acad_summ_rec,
                   rec_two edi_acad_summ_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_acad_summ_rec Required.
	rec_two	The second record to compare. Type edi_acad_summ_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 shrsuma.shrsuma_dcmt_seqno%TYPE,
                     p_gpa_seqno  shrsuma.shrsuma_gpa_seqno%TYPE)
   RETURN edi_acad_summ_ref;

Selects all records for the entity.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence 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 shrsuma.shrsuma_dcmt_seqno%TYPE,
                     p_gpa_seqno  shrsuma.shrsuma_gpa_seqno%TYPE)
   RETURN edi_acad_summ_ref;

Selects one record using the key.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence 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_acad_summ_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 shrsuma.shrsuma_dcmt_seqno%TYPE,
                          p_gpa_seqno  shrsuma.shrsuma_gpa_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
   RETURN edi_acad_summ_ref;

Selects one record and locks it.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence 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      shrsuma.shrsuma_dcmt_seqno%TYPE,
                   p_gpa_seqno       shrsuma.shrsuma_gpa_seqno%TYPE,
                   p_ctyp_code       shrsuma.shrsuma_ctyp_code%TYPE DEFAULT NULL,
                   p_slvl_code       shrsuma.shrsuma_slvl_code%TYPE DEFAULT NULL,
                   p_gpa_hours       shrsuma.shrsuma_gpa_hours%TYPE DEFAULT NULL,
                   p_hours_attempted shrsuma.shrsuma_hours_attempted%TYPE DEFAULT NULL,
                   p_hours_earned    shrsuma.shrsuma_hours_earned%TYPE DEFAULT NULL,
                   p_gpa_low         shrsuma.shrsuma_gpa_low%TYPE DEFAULT NULL,
                   p_gpa_high        shrsuma.shrsuma_gpa_high%TYPE DEFAULT NULL,
                   p_gpa             shrsuma.shrsuma_gpa%TYPE DEFAULT NULL,
                   p_gpa_excess_ind  shrsuma.shrsuma_gpa_excess_ind%TYPE DEFAULT NULL,
                   p_class_rank      shrsuma.shrsuma_class_rank%TYPE DEFAULT NULL,
                   p_class_size      shrsuma.shrsuma_class_size%TYPE DEFAULT NULL,
                   p_rdql_code       shrsuma.shrsuma_rdql_code%TYPE DEFAULT NULL,
                   p_rank_date       shrsuma.shrsuma_rank_date%TYPE DEFAULT NULL,
                   p_data_origin     shrsuma.shrsuma_data_origin%TYPE DEFAULT NULL,
                   p_user_id         shrsuma.shrsuma_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 sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence number. NUMBER(8) Required Key.
	p_ctyp_code	EDI credit type code. VARCHAR2(1).
	p_slvl_code	EDI student course level code. VARCHAR2(2).
	p_gpa_hours	EDI academic credit hours included in GPA. NUMBER(11,3).
	p_hours_attempted	EDI academic credit hours attempted. NUMBER(11,3).
	p_hours_earned	EDI academic credit hours earned. NUMBER(11,3).
	p_gpa_low	EDI lowest possible grade average. NUMBER(23,9).
	p_gpa_high	EDI highest possible grade average. NUMBER(23,9).
	p_gpa	EDI academic grade point average. NUMBER(23,9).
	p_gpa_excess_ind	EDI excessive GPA indicator. VARCHAR2(1).
	p_class_rank	EDI position in class (K-12). NUMBER(4).
	p_class_size	EDI total number in class (K-12). NUMBER(5).
	p_rdql_code	EDI format code for class rank date. VARCHAR2(3).
	p_rank_date	EDI class rank date. VARCHAR2(8).
	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 shrsuma.shrsuma_dcmt_seqno%TYPE,
                   p_gpa_seqno  shrsuma.shrsuma_gpa_seqno%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_dcmt_seqno	EDI document sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence 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  shrsuma.shrsuma_dcmt_seqno%TYPE,
                 p_gpa_seqno   shrsuma.shrsuma_gpa_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 sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence 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      shrsuma.shrsuma_dcmt_seqno%TYPE,
                   p_gpa_seqno       shrsuma.shrsuma_gpa_seqno%TYPE,
                   p_ctyp_code       shrsuma.shrsuma_ctyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_slvl_code       shrsuma.shrsuma_slvl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_gpa_hours       shrsuma.shrsuma_gpa_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_hours_attempted shrsuma.shrsuma_hours_attempted%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_hours_earned    shrsuma.shrsuma_hours_earned%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_gpa_low         shrsuma.shrsuma_gpa_low%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_gpa_high        shrsuma.shrsuma_gpa_high%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_gpa             shrsuma.shrsuma_gpa%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_gpa_excess_ind  shrsuma.shrsuma_gpa_excess_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_class_rank      shrsuma.shrsuma_class_rank%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_class_size      shrsuma.shrsuma_class_size%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rdql_code       shrsuma.shrsuma_rdql_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rank_date       shrsuma.shrsuma_rank_date%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin     shrsuma.shrsuma_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         shrsuma.shrsuma_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 sequence number. NUMBER(8) Required Key.
	p_gpa_seqno	EDI GPA sequence number. NUMBER(8) Required Key.
	p_ctyp_code	EDI credit type code. VARCHAR2(1).
	p_slvl_code	EDI student course level code. VARCHAR2(2).
	p_gpa_hours	EDI academic credit hours included in GPA. NUMBER(11,3).
	p_hours_attempted	EDI academic credit hours attempted. NUMBER(11,3).
	p_hours_earned	EDI academic credit hours earned. NUMBER(11,3).
	p_gpa_low	EDI lowest possible grade average. NUMBER(23,9).
	p_gpa_high	EDI highest possible grade average. NUMBER(23,9).
	p_gpa	EDI academic grade point average. NUMBER(23,9).
	p_gpa_excess_ind	EDI excessive GPA indicator. VARCHAR2(1).
	p_class_rank	EDI position in class (K-12). NUMBER(4).
	p_class_size	EDI total number in class (K-12). NUMBER(5).
	p_rdql_code	EDI format code for class rank date. VARCHAR2(3).
	p_rank_date	EDI class rank date. VARCHAR2(8).
	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).