Package sb_gradapp

Package sb_gradapp_paymentopts

This package provides the Common Business interface for the Graduation Application Payment Options API (sb_gradapp_paymentopts).

The payment options that display via the self-service Graduation Application are defined in the Graduation Date Payment Options table (SHRGAPO). Detail codes are defined for the graduation application display rule (SHBGADR_. A payment option, charge amount, and account type code will be associated with the detail code.

Program units

f_api_version

f_exists

f_isequal

f_query_all

f_query_one

f_query_by_rowid

f_query_one_lock

p_create

p_delete

p_lock

p_update

Types

gradapp_paymentopts_rec

gradapp_paymentopts_ref

gradapp_paymentopts_tab

Constants

M_ENTITY_NAME

M_BASE_TABLE_NAME

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(19) := 'GRADAPP_PAYMENTOPTS';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

gradapp_paymentopts_rec

TYPE gradapp_paymentopts_rec IS RECORD (
  r_gadr_code               shrgapo.shrgapo_gadr_code%TYPE,
  r_wpyo_code               shrgapo.shrgapo_wpyo_code%TYPE,
  r_detc_code               shrgapo.shrgapo_detc_code%TYPE,
  r_chrg                    shrgapo.shrgapo_chrg%TYPE,
  r_user_id                 shrgapo.shrgapo_user_id%TYPE,
  r_data_origin             shrgapo.shrgapo_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gradapp_paymentopts_ref

TYPE gradapp_paymentopts_ref IS REF CURSOR RETURN gradapp_paymentopts_rec;

Entity cursor variable type

gradapp_paymentopts_tab

TYPE gradapp_paymentopts_tab IS TABLE OF gradapp_paymentopts_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_gadr_code shrgapo.shrgapo_gadr_code%TYPE,
                  p_wpyo_code shrgapo.shrgapo_wpyo_code%TYPE DEFAULT NULL,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required
	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 gradapp_paymentopts_rec,
                   rec_two gradapp_paymentopts_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 gradapp_paymentopts_rec Required
	rec_two	The second record to compare. Type gradapp_paymentopts_rec Required

Returns

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

f_query_all

Function f_query_all(p_gadr_code shrgapo.shrgapo_gadr_code%TYPE DEFAULT NULL,
                     p_wpyo_code shrgapo.shrgapo_wpyo_code%TYPE DEFAULT NULL,
                     p_detc_code shrgapo.shrgapo_detc_code%TYPE DEFAULT NULL)
  RETURN gradapp_paymentopts_ref

Selects all records for the entity.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required
	p_detc_code	Detail code associated with each charge and payment that can be entered onto an account. VARCHAR2(4) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_gadr_code shrgapo.shrgapo_gadr_code%TYPE,
                     p_wpyo_code shrgapo.shrgapo_wpyo_code%TYPE)
  RETURN gradapp_paymentopts_ref

Selects one record using the key.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required

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 gradapp_paymentopts_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_gadr_code shrgapo.shrgapo_gadr_code%TYPE,
                          p_wpyo_code shrgapo.shrgapo_wpyo_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gradapp_paymentopts_ref

Selects one record and locks it.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required
	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_gadr_code   shrgapo.shrgapo_gadr_code%TYPE,
                   p_wpyo_code   shrgapo.shrgapo_wpyo_code%TYPE,
                   p_detc_code   shrgapo.shrgapo_detc_code%TYPE,
                   p_chrg        shrgapo.shrgapo_chrg%TYPE,
                   p_user_id     shrgapo.shrgapo_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin shrgapo.shrgapo_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required
	p_detc_code	Detail code associated with each charge and payment that can be entered onto an account. VARCHAR2(4) Required Key
	p_chrg	Charge associated with the service. NUMBER(12,2) Required
	p_user_id	ID of the most recent user to create or update the row in the SHRGAPO table. VARCHAR2(30) Required
	p_data_origin	Value of the source system that inserted 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_gadr_code shrgapo.shrgapo_gadr_code%TYPE,
                   p_wpyo_code shrgapo.shrgapo_wpyo_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_gadr_code   shrgapo.shrgapo_gadr_code%TYPE,
                 p_wpyo_code   shrgapo.shrgapo_wpyo_code%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_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_gadr_code   shrgapo.shrgapo_gadr_code%TYPE,
                   p_wpyo_code   shrgapo.shrgapo_wpyo_code%TYPE,
                   p_detc_code   shrgapo.shrgapo_detc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_chrg        shrgapo.shrgapo_chrg%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id     shrgapo.shrgapo_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin shrgapo.shrgapo_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_gadr_code	Display rule code for the graduation application. VARCHAR2(15) Required Key
	p_wpyo_code	Code of the payment option available for self-service requests. VARCHAR2(4) Required
	p_detc_code	Detail code associated with each charge and payment that can be entered onto an account. VARCHAR2(4) Required Key
	p_chrg	Charge associated with the service. NUMBER(12,2) Required
	p_user_id	ID of the most recent user to create or update the row in the SHRGAPO table. VARCHAR2(30) Required
	p_data_origin	Value of the source system that inserted or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)