Package sb_enroll_ver

Package sb_enroll_ver_service

This package provides the Common Business interface for the Enrollment Verification Self-Service Options API (sb_enroll_ver_service).
This defines the special service available for processing the enrollment verification report, such as special overnight or same day delivery or even hold for pickup.

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

enroll_ver_service_rec	Business Entity record type.
enroll_ver_service_ref	Entity cursor variable type.
enroll_ver_service_tab	Entity table type.

Constants

M_ENTITY_NAME

Business Entity Name.

M_ENTITY_NAME

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

Business Entity Name.

enroll_ver_service_rec

TYPE enroll_ver_service_rec IS RECORD (
  r_eprt_code               sfrenss.sfrenss_eprt_code%TYPE,
  r_wsso_code               sfrenss.sfrenss_wsso_code%TYPE,
  r_acct_type_cde           sfrenss.sfrenss_acct_type_cde%TYPE,
  r_data_origin             sfrenss.sfrenss_data_origin%TYPE,
  r_user_id                 sfrenss.sfrenss_user_id%TYPE,
  r_charge                  sfrenss.sfrenss_charge%TYPE,
  r_charge_per_cde          sfrenss.sfrenss_charge_per_cde%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type.

enroll_ver_service_ref

TYPE enroll_ver_service_ref IS REF CURSOR RETURN enroll_ver_service_rec;

Entity cursor variable type.

enroll_ver_service_tab

TYPE enroll_ver_service_tab IS TABLE OF enroll_ver_service_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_eprt_code sfrenss.sfrenss_eprt_code%TYPE,
                  p_wsso_code sfrenss.sfrenss_wsso_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) 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 enroll_ver_service_rec,
                   rec_two enroll_ver_service_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 enroll_ver_service_rec Required
	rec_two	The second record to compare. Type enroll_ver_service_rec Required

Returns

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

f_query_all

Function f_query_all(p_eprt_code sfrenss.sfrenss_eprt_code%TYPE,
                     p_wsso_code sfrenss.sfrenss_wsso_code%TYPE)
  RETURN enroll_ver_service_ref

Selects all records for the entity.

Parameters

	p_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) Required Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

Function f_query_one(p_eprt_code sfrenss.sfrenss_eprt_code%TYPE,
                     p_wsso_code sfrenss.sfrenss_wsso_code%TYPE)
  RETURN enroll_ver_service_ref

Selects one record using the key.

Parameters

	p_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) 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 enroll_ver_service_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_eprt_code sfrenss.sfrenss_eprt_code%TYPE,
                          p_wsso_code sfrenss.sfrenss_wsso_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN enroll_ver_service_ref

Selects one record and locks it.

Parameters

	p_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) 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_eprt_code      sfrenss.sfrenss_eprt_code%TYPE,
                   p_wsso_code      sfrenss.sfrenss_wsso_code%TYPE,
                   p_acct_type_cde  sfrenss.sfrenss_acct_type_cde%TYPE,
                   p_data_origin    sfrenss.sfrenss_data_origin%TYPE,
                   p_user_id        sfrenss.sfrenss_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_charge         sfrenss.sfrenss_charge%TYPE DEFAULT NULL,
                   p_charge_per_cde sfrenss.sfrenss_charge_per_cde%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) Required Key
	p_acct_type_cde	Indicates what type of A/R account is to be created: one of the student's or a miscellaneous one. Values C or M. VARCHAR2(1) Required
	p_data_origin	Origin of the data. VARCHAR2(30) Required
	p_user_id	Most recent user to create or update the record. VARCHAR2(30) Required
	p_charge	Charge associated with the service. NUMBER(12,2)
	p_charge_per_cde	How the service is charged, by the C (copy) or R (request). VARCHAR2(1)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_eprt_code sfrenss.sfrenss_eprt_code%TYPE,
                   p_wsso_code sfrenss.sfrenss_wsso_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_eprt_code   sfrenss.sfrenss_eprt_code%TYPE,
                 p_wsso_code   sfrenss.sfrenss_wsso_code%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_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_eprt_code      sfrenss.sfrenss_eprt_code%TYPE,
                   p_wsso_code      sfrenss.sfrenss_wsso_code%TYPE,
                   p_acct_type_cde  sfrenss.sfrenss_acct_type_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin    sfrenss.sfrenss_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id        sfrenss.sfrenss_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_charge         sfrenss.sfrenss_charge%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_charge_per_cde sfrenss.sfrenss_charge_per_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_eprt_code	Type of the enrollment verification request. VARCHAR2(4) Required Key
	p_wsso_code	Service option available to self-service requests. VARCHAR2(4) Required Key
	p_acct_type_cde	Indicates what type A/R account is to be created: one of the student's accounts or a miscellaneous one. Values C or M. VARCHAR2(1) Required
	p_data_origin	Origin of the data. VARCHAR2(30) Required
	p_user_id	Most recent user to create or update the record. VARCHAR2(30) Required
	p_charge	Charge associated with the service. NUMBER(12,2)
	p_charge_per_cde	How the service is charged, by the C (copy) or R (request). VARCHAR2(1)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)