Package gp_gtvotyp

Common Business interface for the GTVOTYP API (gp_gtvotyp).

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

gtvotyp_rec	Business Entity record type
gtvotyp_ref	Entity cursor variable type
gtvotyp_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) := 'GTVOTYP';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

gtvotyp_rec

TYPE gtvotyp_rec IS RECORD (
  r_syst_code               gtvotyp.gtvotyp_syst_code%TYPE,
  r_code                    gtvotyp.gtvotyp_code%TYPE,
  r_desc                    gtvotyp.gtvotyp_desc%TYPE,
  r_data_type               gtvotyp.gtvotyp_data_type%TYPE,
  r_system_level_cde        gtvotyp.gtvotyp_system_level_cde%TYPE,
  r_option_default          gtvotyp.gtvotyp_option_default%TYPE,
  r_system_req_ind          gtvotyp.gtvotyp_system_req_ind%TYPE,
  r_user_id                 gtvotyp.gtvotyp_user_id%TYPE,
  r_create_date             gtvotyp.gtvotyp_create_date%TYPE,
  r_create_user             gtvotyp.gtvotyp_create_user%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gtvotyp_ref

TYPE gtvotyp_ref IS REF CURSOR RETURN gtvotyp_rec;

Entity cursor variable type

gtvotyp_tab

TYPE gtvotyp_tab IS TABLE OF gtvotyp_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_syst_code gtvotyp.gtvotyp_syst_code%TYPE,
                  p_code      gtvotyp.gtvotyp_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. 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 gtvotyp_rec,
                   rec_two gtvotyp_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 gtvotyp_rec Required
	rec_two	The second record to compare. Type gtvotyp_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_syst_code gtvotyp.gtvotyp_syst_code%TYPE,
                     p_code      gtvotyp.gtvotyp_code%TYPE)
  RETURN gtvotyp_ref

Selects all records for the entity.

Parameters

	p_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. VARCHAR2(30) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_syst_code gtvotyp.gtvotyp_syst_code%TYPE,
                     p_code      gtvotyp.gtvotyp_code%TYPE)
  RETURN gtvotyp_ref

Selects one record using key.

Parameters

	p_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. 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 gtvotyp_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_syst_code gtvotyp.gtvotyp_syst_code%TYPE,
                          p_code      gtvotyp.gtvotyp_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gtvotyp_ref

Selects one record and locks it.

Parameters

	p_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. 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_syst_code        gtvotyp.gtvotyp_syst_code%TYPE,
                   p_code             gtvotyp.gtvotyp_code%TYPE,
                   p_desc             gtvotyp.gtvotyp_desc%TYPE DEFAULT NULL,
                   p_data_type        gtvotyp.gtvotyp_data_type%TYPE,
                   p_system_level_cde gtvotyp.gtvotyp_system_level_cde%TYPE,
                   p_option_default   gtvotyp.gtvotyp_option_default%TYPE,
                   p_system_req_ind   gtvotyp.gtvotyp_system_req_ind%TYPE DEFAULT NULL,
                   p_user_id          gtvotyp.gtvotyp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date      gtvotyp.gtvotyp_create_date%TYPE DEFAULT NULL,
                   p_create_user      gtvotyp.gtvotyp_create_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out        OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. VARCHAR2(30) Required Key
	p_desc	Description of the option. VARCHAR2(120)
	p_data_type	Date, varchar, number, indicator. VARCHAR2(20) Required
	p_system_level_cde	S (system) means this is only valid at the system level; R (record also) means that system/record type combinations may be defined and used. VARCHAR2(1) Required
	p_option_default	Default value to be used (suitably edited) if the system need it and canot find it elsewhere. VARCHAR2(60) Required
	p_system_req_ind	System required indicator (informational only). VARCHAR2(1)
	p_user_id	The ID for the user that most recently updated the record. VARCHAR2(30)
	p_create_date	This field contains date new record created. DATE
	p_create_user	This field contains Banner User ID which created new record. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_syst_code gtvotyp.gtvotyp_syst_code%TYPE,
                   p_code      gtvotyp.gtvotyp_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. VARCHAR2(30) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_syst_code   gtvotyp.gtvotyp_syst_code%TYPE,
                 p_code        gtvotyp.gtvotyp_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_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. VARCHAR2(30) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_syst_code        gtvotyp.gtvotyp_syst_code%TYPE,
                   p_code             gtvotyp.gtvotyp_code%TYPE,
                   p_desc             gtvotyp.gtvotyp_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_type        gtvotyp.gtvotyp_data_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_system_level_cde gtvotyp.gtvotyp_system_level_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_option_default   gtvotyp.gtvotyp_option_default%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_system_req_ind   gtvotyp.gtvotyp_system_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id          gtvotyp.gtvotyp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date      gtvotyp.gtvotyp_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_create_user      gtvotyp.gtvotyp_create_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid            gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_syst_code	Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
	p_code	Option type within the system. VARCHAR2(30) Required Key
	p_desc	Description of the option. VARCHAR2(120)
	p_data_type	Date, varchar, number, indicator. VARCHAR2(20) Required
	p_system_level_cde	S (system) means this is only valid at the system level; R (record also) means that system/record type combinations may be defined and used. VARCHAR2(1) Required
	p_option_default	Default value to be used (suitably edited) if the system need it and canot find it elsewhere. VARCHAR2(60) Required
	p_system_req_ind	System required indicator (informational only). VARCHAR2(1)
	p_user_id	The ID for the user that most recently updated the record. VARCHAR2(30)
	p_create_date	This field contains date new record created. DATE
	p_create_user	This field contains Banner User ID which created new record. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)