Package sb_pesc_status

Package sb_pesc_status_imp

This package provides the Common Business Interface for the PESC Status Import API (sb_xml_status_imp).
"PESC" stands for "Postsecondary Electronic Standards Council". This API is responsible for accessing the SHRIPTD table, which holds records of import status for the XML 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

pesc_status_imp_rec	Business Entity record type
pesc_status_imp_ref	Entity cursor variable type
pesc_status_imp_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(15) := 'PESC_STATUS_IMP';

Business Entity Name

pesc_status_imp_rec

TYPE pesc_status_imp_rec IS RECORD (
  r_recv_document_id        shriptd.shriptd_recv_document_id%TYPE,
  r_sent_document_id        shriptd.shriptd_sent_document_id%TYPE,
  r_sent_org_cde            shriptd.shriptd_sent_org_cde%TYPE,
  r_sent_org_cde_type       shriptd.shriptd_sent_org_cde_type%TYPE,
  r_sent_org_name           shriptd.shriptd_sent_org_name%TYPE,
  r_doc_id_receive_date     shriptd.shriptd_doc_id_receive_date%TYPE,
  r_doc_id_receive_status   shriptd.shriptd_doc_id_receive_status%TYPE,
  r_dcmt_seqno              shriptd.shriptd_dcmt_seqno%TYPE,
  r_processed_date          shriptd.shriptd_processed_date%TYPE,
  r_user_id                 shriptd.shriptd_user_id%TYPE,
  r_data_origin             shriptd.shriptd_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

pesc_status_imp_ref

TYPE pesc_status_imp_ref IS REF CURSOR RETURN pesc_status_imp_rec;

Entity cursor variable type

pesc_status_imp_tab

TYPE pesc_status_imp_tab IS TABLE OF pesc_status_imp_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_recv_document_id shriptd.shriptd_recv_document_id%TYPE,
                  p_rowid            gb_common.internal_record_id_type DEFAULT NULL)
   RETURN VARCHAR2;

Checks to see if a record exists.

Parameters

	p_recv_document_id	The document identification number generated by the receiving institution. VARCHAR2(30) 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 pesc_status_imp_rec,
                   rec_two pesc_status_imp_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 pesc_status_imp_rec Required.
	rec_two	The second record to compare. Type pesc_status_imp_rec Required.

Returns

Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all

FUNCTION f_query_all(p_recv_document_id  shriptd.shriptd_recv_document_id%TYPE DEFAULT NULL,
                     p_sent_document_id  shriptd.shriptd_sent_document_id%TYPE DEFAULT NULL,
                     p_sent_org_cde      shriptd.shriptd_sent_org_cde%TYPE DEFAULT NULL,
                     p_sent_org_cde_type shriptd.shriptd_sent_org_cde_type%TYPE DEFAULT NULL,
                     p_sent_org_name     shriptd.shriptd_sent_org_name%TYPE DEFAULT NULL)
   RETURN pesc_status_imp_ref;

Selects all records for the entity. If provided all parameters must be an exact match except for the p_sent_orgn_name which can contain an Oracle delimited search string.

Parameters

	p_recv_document_id	The document identification number generated by the receiving institution. VARCHAR2(30).
	p_sent_document_id	The document identification number associated with a transcript sent from an institution. VARCHAR2(35).
	p_sent_org_cde	The organization code of the sending institution. VARCHAR2(20).
	p_sent_org_cde_type	The type of organization code of the sending institution. VARCHAR2(20).
	p_sent_org_name	The name of the organization that sent the document. VARCHAR2(60).

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_recv_document_id shriptd.shriptd_recv_document_id%TYPE)
   RETURN pesc_status_imp_ref;

Selects one record using the key.

Parameters

p_recv_document_id

The document identification number generated by the receiving institution. VARCHAR2(30) 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 pesc_status_imp_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_recv_document_id shriptd.shriptd_recv_document_id%TYPE,
                          p_rowid            gb_common.internal_record_id_type DEFAULT NULL)
   RETURN pesc_status_imp_ref;

Selects one record and locks it.

Parameters

	p_recv_document_id	The document identification number generated by the receiving institution. VARCHAR2(30) 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_recv_document_id      shriptd.shriptd_recv_document_id%TYPE,
                   p_sent_document_id      shriptd.shriptd_sent_document_id%TYPE,
                   p_sent_org_cde          shriptd.shriptd_sent_org_cde%TYPE,
                   p_sent_org_cde_type     shriptd.shriptd_sent_org_cde_type%TYPE,
                   p_sent_org_name         shriptd.shriptd_sent_org_name%TYPE DEFAULT NULL,
                   p_doc_id_receive_date   shriptd.shriptd_doc_id_receive_date%TYPE DEFAULT NULL,
                   p_doc_id_receive_status shriptd.shriptd_doc_id_receive_status%TYPE,
                   p_dcmt_seqno            shriptd.shriptd_dcmt_seqno%TYPE DEFAULT NULL,
                   p_processed_date        shriptd.shriptd_processed_date%TYPE DEFAULT NULL,
                   p_user_id               shriptd.shriptd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin           shriptd.shriptd_data_origin%TYPE,
                   p_rowid_out             OUT gb_common.internal_record_id_type);

Creates a record.

Parameters

	p_recv_document_id	The document identification number generated by the receiving institution. VARCHAR2(30) Required Key.
	p_sent_document_id	The document identification number associated with a transcript sent from an institution. VARCHAR2(35) Required.
	p_sent_org_cde	The organization code of the sending institution. VARCHAR2(20) Required.
	p_sent_org_cde_type	The type of organization code of the sending institution. VARCHAR2(20) Required.
	p_sent_org_name	The name of the organization that sent the document. VARCHAR2(60).
	p_doc_id_receive_date	The date the file was received. DATE.
	p_doc_id_receive_status	The status of the Document. R=Received, P=Processed. If document status =P, then the PROCESSED_DATE is the date the document was processed into Banner. VARCHAR2(2) Required.
	p_dcmt_seqno	EDI document sequence number used to store data in SHR temporary tables. NUMBER(8).
	p_processed_date	Date the document was processed into Banner. DATE.
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30) Required.
	p_data_origin	Source system that created or updated the row. VARCHAR2(30) Required.
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required.

p_delete

PROCEDURE p_delete(p_recv_document_id shriptd.shriptd_recv_document_id%TYPE,
                   p_rowid            gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_recv_document_id	The document identification number generated by the receiving institution. VARCHAR2(30) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

PROCEDURE p_lock(p_recv_document_id shriptd.shriptd_recv_document_id%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_recv_document_id	The document identification number generated by the receiving institution. VARCHAR2(30) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update

PROCEDURE p_update(p_recv_document_id      shriptd.shriptd_recv_document_id%TYPE,
                   p_sent_document_id      shriptd.shriptd_sent_document_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sent_org_cde          shriptd.shriptd_sent_org_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sent_org_cde_type     shriptd.shriptd_sent_org_cde_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sent_org_name         shriptd.shriptd_sent_org_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_doc_id_receive_date   shriptd.shriptd_doc_id_receive_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_doc_id_receive_status shriptd.shriptd_doc_id_receive_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dcmt_seqno            shriptd.shriptd_dcmt_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_processed_date        shriptd.shriptd_processed_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_user_id               shriptd.shriptd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin           shriptd.shriptd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                 gb_common.internal_record_id_type DEFAULT NULL);

Updates a record.

Parameters

	p_recv_document_id	The document identification number generated by the receiving institution. VARCHAR2(30) Required Key.
	p_sent_document_id	The document identification number associated with a transcript sent from an institution. VARCHAR2(35) Required.
	p_sent_org_cde	The organization code of the sending institution. VARCHAR2(20) Required.
	p_sent_org_cde_type	The type of organization code of the sending institution. VARCHAR2(20) Required.
	p_sent_org_name	The name of the organization that sent the document. VARCHAR2(60).
	p_doc_id_receive_date	The date the file was received. DATE.
	p_doc_id_receive_status	The status of the Document. R=Received, P=Processed. If document status =P, then the PROCESSED_DATE is the date the document was processed into Banner. VARCHAR2(2) Required.
	p_dcmt_seqno	EDI document sequence number used to store data in SHR temporary tables. NUMBER(8).
	p_processed_date	Date document was processed into Banner. DATE.
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30) Required.
	p_data_origin	Source system that created or updated the row. VARCHAR2(30) Required.
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18).