Package gp_gtvdtyp

Common Business interface for the GTVDTYP API (gp_gtvdtyp).

Program units

f_api_version	Returns the API version number.
f_exists	Checks 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 key.
f_query_by_rowid	Selects one record using 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

gtvdtyp_rec	Business Entity record type
gtvdtyp_ref	Entity cursor variable type
gtvdtyp_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(7) := 'GTVDTYP';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

gtvdtyp_rec

TYPE gtvdtyp_rec IS RECORD (
  r_code                    gtvdtyp.gtvdtyp_code%TYPE,
  r_desc                    gtvdtyp.gtvdtyp_desc%TYPE,
  r_process                 gtvdtyp.gtvdtyp_process%TYPE,
  r_process_seq             gtvdtyp.gtvdtyp_process_seq%TYPE,
  r_system_req_ind          gtvdtyp.gtvdtyp_system_req_ind%TYPE,
  r_user_id                 gtvdtyp.gtvdtyp_user_id%TYPE,
  r_create_date             gtvdtyp.gtvdtyp_create_date%TYPE,
  r_create_user             gtvdtyp.gtvdtyp_create_user%TYPE,
  r_data_origin             gtvdtyp.gtvdtyp_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gtvdtyp_ref

TYPE gtvdtyp_ref IS REF CURSOR RETURN gtvdtyp_rec;

Entity cursor variable type

gtvdtyp_tab

TYPE gtvdtyp_tab IS TABLE OF gtvdtyp_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_code  gtvdtyp.gtvdtyp_code%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_code	Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). 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 gtvdtyp_rec,
                   rec_two gtvdtyp_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 gtvdtyp_rec Required
	rec_two	The second record to compare. Type gtvdtyp_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_code gtvdtyp.gtvdtyp_code%TYPE) RETURN gtvdtyp_ref

Selects all records for the entity.

Parameters

p_code

Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). VARCHAR2(30) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_code gtvdtyp.gtvdtyp_code%TYPE) RETURN gtvdtyp_ref

Selects one record using key.

Parameters

p_code

Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). 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 gtvdtyp_ref

Selects one record using 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_code  gtvdtyp.gtvdtyp_code%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gtvdtyp_ref

Selects one record and locks it.

Parameters

	p_code	Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). 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_code           gtvdtyp.gtvdtyp_code%TYPE,
                   p_desc           gtvdtyp.gtvdtyp_desc%TYPE DEFAULT NULL,
                   p_process        gtvdtyp.gtvdtyp_process%TYPE DEFAULT NULL,
                   p_process_seq    gtvdtyp.gtvdtyp_process_seq%TYPE DEFAULT NULL,
                   p_system_req_ind gtvdtyp.gtvdtyp_system_req_ind%TYPE DEFAULT NULL,
                   p_user_id        gtvdtyp.gtvdtyp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date    gtvdtyp.gtvdtyp_create_date%TYPE DEFAULT NULL,
                   p_create_user    gtvdtyp.gtvdtyp_create_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    gtvdtyp.gtvdtyp_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.
@param p_code Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). VARCHAR2(30) Required Key
@param p_desc Description of the system. VARCHAR2(60)
@param p_process An optional package.function name that can be used as a user exit to perform specific logic to load data.
The function must be designed to accept the following parameters: GENBPSH_GIDM NUMBER(8), GENBPSH_SYST_CODE VARCHAR2(30), GENBPSH_RETP_CODE VARCHAR2(30), GENBPSH_DTYP_CODE VARCHAR2(30), GENIDEN_PIDM NUMBER(8) and return a VARCHAR2(500) that will be NULL on a successful process or an error message if applicable. VARCHAR2(100)
@param p_process_seq The sequence in which the GTVDTYP_PROCESS will be called. Duplicates are allowed, and if so, the processes will be called in alphabetical order within sequence number. NUMBER(3)
@param p_system_req_ind System required indicator (informational only). VARCHAR2(1)
@param p_user_id The ID for the user that most recently updated the record. VARCHAR2(30)
@param p_create_date This field contains date new record created. DATE
@param p_create_user This field contains Banner User ID which created new record. VARCHAR2(30)
@param p_data_origin Source system that created or updated the data. VARCHAR2(30)
@param p_rowid_out Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_code  gtvdtyp.gtvdtyp_code%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_code	Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). VARCHAR2(30) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_code        gtvdtyp.gtvdtyp_code%TYPE,
                 p_rowid_inout IN OUT NOCOPY 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_code	Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). VARCHAR2(30) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_code           gtvdtyp.gtvdtyp_code%TYPE,
                   p_desc           gtvdtyp.gtvdtyp_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_process        gtvdtyp.gtvdtyp_process%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_process_seq    gtvdtyp.gtvdtyp_process_seq%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_system_req_ind gtvdtyp.gtvdtyp_system_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id        gtvdtyp.gtvdtyp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date    gtvdtyp.gtvdtyp_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_create_user    gtvdtyp.gtvdtyp_create_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin    gtvdtyp.gtvdtyp_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.
@param p_code Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). VARCHAR2(30) Required Key
@param p_desc Description of the system. VARCHAR2(60)
@param p_process An optional package.function name that can be used as a user exit to perform specific logic to load data.
The function must be designed to accept the following parameters: GENBPSH_GIDM NUMBER(8), GENBPSH_SYST_CODE VARCHAR2(30), GENBPSH_RETP_CODE VARCHAR2(30), GENBPSH_DTYP_CODE VARCHAR2(30), GENIDEN_PIDM NUMBER(8) and return a VARCHAR2(500) that will be NULL on a successful process or an error message if applicable. VARCHAR2(100)
@param p_process_seq The sequence in which the GTVDTYP_PROCESS will be called. Duplicates are allowed, and if so, the processes will be called in alphabetical order within sequence number. NUMBER(3)
@param p_system_req_ind System required indicator (informational only). VARCHAR2(1)
@param p_user_id The ID for the user that most recently updated the record. VARCHAR2(30)
@param p_create_date This field contains date new record created. DATE
@param p_create_user This field contains Banner User ID which created new record. VARCHAR2(30)
@param p_data_origin Source system that created or updated the data. VARCHAR2(30)
@param p_rowid Database ROWID of the record to be updated. VARCHAR2(18)