index

Package gp_gebcomm

Common Business interface for the GEBCOMM API (gp_gebcomm).

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
gebcomm_rec   Business Entity record type
gebcomm_ref   Entity cursor variable type
gebcomm_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) := 'GEBCOMM';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

gebcomm_rec 

TYPE gebcomm_rec IS RECORD (
  r_syst_code               gebcomm.gebcomm_syst_code%TYPE,
  r_ctyp_code               gebcomm.gebcomm_ctyp_code%TYPE,
  r_per_notify_ind          gebcomm.gebcomm_per_notify_ind%TYPE,
  r_admin_notify_ind        gebcomm.gebcomm_admin_notify_ind%TYPE,
  r_proxy_notify_ind        gebcomm.gebcomm_proxy_notify_ind%TYPE,
  r_letr_per_noti_code      gebcomm.gebcomm_letr_per_noti_code%TYPE,
  r_letr_adm_noti_code      gebcomm.gebcomm_letr_adm_noti_code%TYPE,
  r_letr_pxy_noti_code      gebcomm.gebcomm_letr_pxy_noti_code%TYPE,
  r_bcc_per_ind             gebcomm.gebcomm_bcc_per_ind%TYPE,
  r_bcc_pxy_ind             gebcomm.gebcomm_bcc_pxy_ind%TYPE,
  r_host_name               gebcomm.gebcomm_host_name%TYPE,
  r_admin_email             gebcomm.gebcomm_admin_email%TYPE,
  r_system_req_ind          gebcomm.gebcomm_system_req_ind%TYPE,
  r_user_id                 gebcomm.gebcomm_user_id%TYPE,
  r_create_date             gebcomm.gebcomm_create_date%TYPE,
  r_create_user             gebcomm.gebcomm_create_user%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gebcomm_ref 

TYPE gebcomm_ref IS REF CURSOR RETURN gebcomm_rec;

Entity cursor variable type

gebcomm_tab 

TYPE gebcomm_tab IS TABLE OF gebcomm_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 gebcomm.gebcomm_syst_code%TYPE,
                  p_ctyp_code gebcomm.gebcomm_ctyp_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_syst_code   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications 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 gebcomm_rec,
                   rec_two gebcomm_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 gebcomm_rec Required
rec_two   The second record to compare. Type gebcomm_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 gebcomm.gebcomm_syst_code%TYPE,
                     p_ctyp_code gebcomm.gebcomm_ctyp_code%TYPE)
  RETURN gebcomm_ref

Selects all records for the entity.

Parameters
p_syst_code   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications 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 gebcomm.gebcomm_syst_code%TYPE,
                     p_ctyp_code gebcomm.gebcomm_ctyp_code%TYPE)
  RETURN gebcomm_ref

Selects one record using key.

Parameters
p_syst_code   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications 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 gebcomm_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 gebcomm.gebcomm_syst_code%TYPE,
                          p_ctyp_code gebcomm.gebcomm_ctyp_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gebcomm_ref

Selects one record and locks it.

Parameters
p_syst_code   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications 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          gebcomm.gebcomm_syst_code%TYPE,
                   p_ctyp_code          gebcomm.gebcomm_ctyp_code%TYPE,
                   p_per_notify_ind     gebcomm.gebcomm_per_notify_ind%TYPE,
                   p_admin_notify_ind   gebcomm.gebcomm_admin_notify_ind%TYPE,
                   p_proxy_notify_ind   gebcomm.gebcomm_proxy_notify_ind%TYPE,
                   p_letr_per_noti_code gebcomm.gebcomm_letr_per_noti_code%TYPE DEFAULT NULL,
                   p_letr_adm_noti_code gebcomm.gebcomm_letr_adm_noti_code%TYPE DEFAULT NULL,
                   p_letr_pxy_noti_code gebcomm.gebcomm_letr_pxy_noti_code%TYPE DEFAULT NULL,
                   p_bcc_per_ind        gebcomm.gebcomm_bcc_per_ind%TYPE,
                   p_bcc_pxy_ind        gebcomm.gebcomm_bcc_pxy_ind%TYPE,
                   p_host_name          gebcomm.gebcomm_host_name%TYPE DEFAULT NULL,
                   p_admin_email        gebcomm.gebcomm_admin_email%TYPE DEFAULT NULL,
                   p_system_req_ind     gebcomm.gebcomm_system_req_ind%TYPE DEFAULT NULL,
                   p_user_id            gebcomm.gebcomm_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date        gebcomm.gebcomm_create_date%TYPE DEFAULT NULL,
                   p_create_user        gebcomm.gebcomm_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   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required Key
p_per_notify_ind   Y (yes) means to send the communication to the person involved; N (no) means to not send the communication. VARCHAR2(1) Required
p_admin_notify_ind   Y (yes) means to send the communication to the administrator; N (no) means to not send the communication. VARCHAR2(1) Required
p_proxy_notify_ind   Y (yes) means to send the communication to the proxy; N (no) means to not send the communication; this will be only for communications where the GTVCTYP flag = N. VARCHAR2(1) Required
p_letr_per_noti_code   Letter code that will be used to notify the person. VARCHAR2(15)
p_letr_adm_noti_code   Letter code that will be used to notify the administrator. VARCHAR2(15)
p_letr_pxy_noti_code   Letter code that will be used to notify the proxy. VARCHAR2(15)
p_bcc_per_ind   Y (yes) means the administrator should be bcc on letters sent to the person; N (no) means to not bcc the administrator. VARCHAR2(1) Required
p_bcc_pxy_ind   Y (yes) means the administrator should be bcc on letters sent to the proxy; N (no) means to not bcc the administrator. VARCHAR2(1) Required
p_host_name   Host name to be used when an email is sent for this system and communications type. VARCHAR2(30)
p_admin_email   Email to use for the administrator emails. VARCHAR2(128)
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 gebcomm.gebcomm_syst_code%TYPE,
                   p_ctyp_code gebcomm.gebcomm_ctyp_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_syst_code   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications 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   gebcomm.gebcomm_syst_code%TYPE,
                 p_ctyp_code   gebcomm.gebcomm_ctyp_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   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications 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          gebcomm.gebcomm_syst_code%TYPE,
                   p_ctyp_code          gebcomm.gebcomm_ctyp_code%TYPE,
                   p_per_notify_ind     gebcomm.gebcomm_per_notify_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_admin_notify_ind   gebcomm.gebcomm_admin_notify_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_proxy_notify_ind   gebcomm.gebcomm_proxy_notify_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_letr_per_noti_code gebcomm.gebcomm_letr_per_noti_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_letr_adm_noti_code gebcomm.gebcomm_letr_adm_noti_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_letr_pxy_noti_code gebcomm.gebcomm_letr_pxy_noti_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bcc_per_ind        gebcomm.gebcomm_bcc_per_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_bcc_pxy_ind        gebcomm.gebcomm_bcc_pxy_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_host_name          gebcomm.gebcomm_host_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_admin_email        gebcomm.gebcomm_admin_email%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_system_req_ind     gebcomm.gebcomm_system_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id            gebcomm.gebcomm_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date        gebcomm.gebcomm_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_create_user        gebcomm.gebcomm_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   Base record for a system and communications type. VARCHAR2(30) Required Key
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required Key
p_per_notify_ind   Y (yes) means to send the communication to the person involved; N (no) means to not send the communication. VARCHAR2(1) Required
p_admin_notify_ind   Y (yes) means to send the communication to the administrator; N (no) means to not send the communication. VARCHAR2(1) Required
p_proxy_notify_ind   Y (yes) means to send the communication to the proxy; N (no) means to not send the communication; this will be only for communications where the GTVCTYP flag = N. VARCHAR2(1) Required
p_letr_per_noti_code   Letter code that will be used to notify the person. VARCHAR2(15)
p_letr_adm_noti_code   Letter code that will be used to notify the administrator. VARCHAR2(15)
p_letr_pxy_noti_code   Letter code that will be used to notify the proxy. VARCHAR2(15)
p_bcc_per_ind   Y (yes) means the administrator should be bcc on letters sent to the person; N (no) means to not bcc the administrator. VARCHAR2(1) Required
p_bcc_pxy_ind   Y (yes) means the administrator should be bcc on letters sent to the proxy; N (no) means to not bcc the administrator. VARCHAR2(1) Required
p_host_name   Host name to be used when an email is sent for this system and communications type. VARCHAR2(30)
p_admin_email   Email to use for the administrator emails. VARCHAR2(128)
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)