index

Package gp_gtvsyst

Common Business interface for the GTVSYST API (gp_gtvsyst).


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
gtvsyst_rec   Business Entity record type
gtvsyst_ref   Entity cursor variable type
gtvsyst_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) := 'GTVSYST';

Business Entity Name


M_BASE_TABLE_NAME

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

Base table name


gtvsyst_rec

TYPE gtvsyst_rec IS RECORD (
  r_code                    gtvsyst.gtvsyst_code%TYPE,
  r_desc                    gtvsyst.gtvsyst_desc%TYPE,
  r_system_req_ind          gtvsyst.gtvsyst_system_req_ind%TYPE,
  r_user_id                 gtvsyst.gtvsyst_user_id%TYPE,
  r_create_date             gtvsyst.gtvsyst_create_date%TYPE,
  r_create_user             gtvsyst.gtvsyst_create_user%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


gtvsyst_ref

TYPE gtvsyst_ref IS REF CURSOR RETURN gtvsyst_rec;

Entity cursor variable type


gtvsyst_tab

TYPE gtvsyst_tab IS TABLE OF gtvsyst_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  gtvsyst.gtvsyst_code%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_code   Systems that are using the general tables (e.g. "Proxy", "event management"). 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 gtvsyst_rec,
                   rec_two gtvsyst_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 gtvsyst_rec Required
rec_two   The second record to compare. Type gtvsyst_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 gtvsyst.gtvsyst_code%TYPE) RETURN gtvsyst_ref

Selects all records for the entity.

Parameters
p_code   Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key

Returns
A cursor variable that will fetch a set of records.


f_query_one

FUNCTION f_query_one(p_code gtvsyst.gtvsyst_code%TYPE) RETURN gtvsyst_ref

Selects one record using key.

Parameters
p_code   Systems that are using the general tables (e.g. "Proxy", "event management"). 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 gtvsyst_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  gtvsyst.gtvsyst_code%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gtvsyst_ref

Selects one record and locks it.

Parameters
p_code   Systems that are using the general tables (e.g. "Proxy", "event management"). 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           gtvsyst.gtvsyst_code%TYPE,
                   p_desc           gtvsyst.gtvsyst_desc%TYPE DEFAULT NULL,
                   p_system_req_ind gtvsyst.gtvsyst_system_req_ind%TYPE DEFAULT NULL,
                   p_user_id        gtvsyst.gtvsyst_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date    gtvsyst.gtvsyst_create_date%TYPE DEFAULT NULL,
                   p_create_user    gtvsyst.gtvsyst_create_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_code   Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
p_desc   Description of the system. VARCHAR2(60)
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_code  gtvsyst.gtvsyst_code%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

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


p_lock

PROCEDURE p_lock(p_code        gtvsyst.gtvsyst_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   Systems that are using the general tables (e.g. "Proxy", "event management"). 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           gtvsyst.gtvsyst_code%TYPE,
                   p_desc           gtvsyst.gtvsyst_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_system_req_ind gtvsyst.gtvsyst_system_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id        gtvsyst.gtvsyst_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date    gtvsyst.gtvsyst_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_create_user    gtvsyst.gtvsyst_create_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_code   Systems that are using the general tables (e.g. "Proxy", "event management"). VARCHAR2(30) Required Key
p_desc   Description of the system. VARCHAR2(60)
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)