Package sb_pesc_status

Package sb_pesc_status_export

This package provides the Common Business Interface for the PESC Status Export API (sb_pesc_status_export).
"PESC" stands for "Postsecondary Electronic Standards Council." This API is responsible for accessing the SHREPTD table, which holds export records 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_export_rec	Business Entity record type
pesc_status_export_ref	Entity cursor variable type
pesc_status_export_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity Name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(20) := 'PESC_STATUS_EXPORT';

Business Entity Name

pesc_status_export_rec

TYPE pesc_status_export_rec IS RECORD (
  r_pidm                    shreptd.shreptd_pidm%TYPE,
  r_request_seq_no          shreptd.shreptd_request_seq_no%TYPE,
  r_user_id                 shreptd.shreptd_user_id%TYPE,
  r_document_id             shreptd.shreptd_document_id%TYPE,
  r_doc_id_extract_date     shreptd.shreptd_doc_id_extract_date%TYPE,
  r_doc_id_rcpt_proc_date   shreptd.shreptd_doc_id_rcpt_proc_date%TYPE,
  r_doc_id_resp_proc_date   shreptd.shreptd_doc_id_resp_proc_date%TYPE,
  r_doc_id_resp_status      shreptd.shreptd_doc_id_resp_status%TYPE,
  r_doc_id_receipt_status   shreptd.shreptd_doc_id_receipt_status%TYPE,
  r_document_type           shreptd.shreptd_document_type%TYPE,
  r_data_origin             shreptd.shreptd_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

pesc_status_export_ref

TYPE pesc_status_export_ref IS REF CURSOR RETURN pesc_status_export_rec;

Entity cursor variable type

pesc_status_export_tab

TYPE pesc_status_export_tab IS TABLE OF pesc_status_export_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_pidm        shreptd.shreptd_pidm%TYPE,
                  p_document_id shreptd.shreptd_document_id%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
   RETURN VARCHAR2;

Checks to see if a record exists.

Parameters

	p_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_document_id	The document identification number associated with a transcript sent to or received from an 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_export_rec,
                   rec_two pesc_status_export_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_export_rec Required.
	rec_two	The second record to compare. Type pesc_status_export_rec Required.

Returns

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

f_query_all

FUNCTION f_query_all(p_pidm        shreptd.shreptd_pidm%TYPE,
                     p_document_id shreptd.shreptd_document_id%TYPE)
   RETURN pesc_status_export_ref;

Selects all records for the entity.

Parameters

	p_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_document_id	The document identification number associated with a transcript sent to or received from an institution. VARCHAR2(30) Required Key.

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_pidm        shreptd.shreptd_pidm%TYPE,
                     p_document_id shreptd.shreptd_document_id%TYPE)
   RETURN pesc_status_export_ref;

Selects one record using the key.

Parameters

	p_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_document_id	The document identification number associated with a transcript sent to or received from an 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_export_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_pidm        shreptd.shreptd_pidm%TYPE,
                          p_document_id shreptd.shreptd_document_id%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
   RETURN pesc_status_export_ref;

Selects one record and locks it.

Parameters

	p_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_document_id	The document identification number associated with a transcript sent to or received from an 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_pidm                  shreptd.shreptd_pidm%TYPE,
                   p_request_seq_no        shreptd.shreptd_request_seq_no%TYPE,
                   p_user_id               shreptd.shreptd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_document_id           shreptd.shreptd_document_id%TYPE,
                   p_doc_id_extract_date   shreptd.shreptd_doc_id_extract_date%TYPE DEFAULT NULL,
                   p_doc_id_rcpt_proc_date shreptd.shreptd_doc_id_rcpt_proc_date%TYPE DEFAULT NULL,
                   p_doc_id_resp_proc_date shreptd.shreptd_doc_id_resp_proc_date%TYPE DEFAULT NULL,
                   p_doc_id_resp_status    shreptd.shreptd_doc_id_resp_status%TYPE DEFAULT NULL,
                   p_doc_id_receipt_status shreptd.shreptd_doc_id_receipt_status%TYPE DEFAULT NULL,
                   p_document_type         shreptd.shreptd_document_type%TYPE DEFAULT NULL,
                   p_data_origin           shreptd.shreptd_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out             OUT gb_common.internal_record_id_type);

Creates a record.

Parameters

	p_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_request_seq_no	Transcript request number. NUMBER(3) Required.
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30) Required.
	p_document_id	The document identification number associated with a transcript sent to or received from an institution. VARCHAR2(30) Required Key.
	p_doc_id_extract_date	The date the file was extracted. DATE.
	p_doc_id_rcpt_proc_date	The date the document ID file was processed by the receiving institution. DATE.
	p_doc_id_resp_proc_date	The date the document ID response file was processed. DATE.
	p_doc_id_resp_status	The status of the document ID response file from the receiving institution. VARCHAR2(2).
	p_doc_id_receipt_status	The status of the document ID receipt file from the receiving institution. VARCHAR2(2).
	p_document_type	The response document type associated with the particular document ID. 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_pidm        shreptd.shreptd_pidm%TYPE,
                   p_document_id shreptd.shreptd_document_id%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_document_id	The document identification number associated with a transcript sent to or received from an institution. VARCHAR2(30) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

PROCEDURE p_lock(p_pidm        shreptd.shreptd_pidm%TYPE,
                 p_document_id shreptd.shreptd_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_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_document_id	The document identification number associated with a transcript sent to or received from an 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_pidm                  shreptd.shreptd_pidm%TYPE,
                   p_request_seq_no        shreptd.shreptd_request_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id               shreptd.shreptd_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_document_id           shreptd.shreptd_document_id%TYPE,
                   p_doc_id_extract_date   shreptd.shreptd_doc_id_extract_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_doc_id_rcpt_proc_date shreptd.shreptd_doc_id_rcpt_proc_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_doc_id_resp_proc_date shreptd.shreptd_doc_id_resp_proc_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_doc_id_resp_status    shreptd.shreptd_doc_id_resp_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_doc_id_receipt_status shreptd.shreptd_doc_id_receipt_status%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_document_type         shreptd.shreptd_document_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin           shreptd.shreptd_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                 gb_common.internal_record_id_type DEFAULT NULL);

Updates a record.

Parameters

	p_pidm	Internal identifier (PIDM) of the student. NUMBER(8) Required Key.
	p_request_seq_no	Transcript request number. NUMBER(3) Required.
	p_user_id	Oracle ID of the user who changed the record. VARCHAR2(30) Required.
	p_document_id	The document identification number associated with a transcript sent to or received from an institution. VARCHAR2(30) Required Key.
	p_doc_id_extract_date	The date the file was extracted. DATE.
	p_doc_id_rcpt_proc_date	The date the document ID file was processed by the receiving institution. DATE.
	p_doc_id_resp_proc_date	The date the document ID response file was processed. DATE.
	p_doc_id_resp_status	The status of the document ID response file from the receiving institution. VARCHAR2(2).
	p_doc_id_receipt_status	The status of the document ID receipt file from the receiving institution. VARCHAR2(2).
	p_document_type	The response document type associated with the particular document ID. 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).