index

Package gp_gpbeltr

Common Business interface for the GPBELTR API (gp_gpbeltr).

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
gpbeltr_rec   Business Entity record type
gpbeltr_ref   Entity cursor variable type
gpbeltr_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) := 'GPBELTR';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

gpbeltr_rec 

TYPE gpbeltr_rec IS RECORD (
  r_syst_code               gpbeltr.gpbeltr_syst_code%TYPE,
  r_ctyp_code               gpbeltr.gpbeltr_ctyp_code%TYPE,
  r_ctyp_url                gpbeltr.gpbeltr_ctyp_url%TYPE,
  r_ctyp_exp_date           gpbeltr.gpbeltr_ctyp_exp_date%TYPE,
  r_ctyp_exe_date           gpbeltr.gpbeltr_ctyp_exe_date%TYPE,
  r_transmit_date           gpbeltr.gpbeltr_transmit_date%TYPE,
  r_proxy_idm               gpbeltr.gpbeltr_proxy_idm%TYPE,
  r_proxy_old_data          gpbeltr.gpbeltr_proxy_old_data%TYPE,
  r_proxy_new_data          gpbeltr.gpbeltr_proxy_new_data%TYPE,
  r_person_pidm             gpbeltr.gpbeltr_person_pidm%TYPE,
  r_user_id                 gpbeltr.gpbeltr_user_id%TYPE,
  r_create_date             gpbeltr.gpbeltr_create_date%TYPE,
  r_create_user             gpbeltr.gpbeltr_create_user%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gpbeltr_ref 

TYPE gpbeltr_ref IS REF CURSOR RETURN gpbeltr_rec;

Entity cursor variable type

gpbeltr_tab 

TYPE gpbeltr_tab IS TABLE OF gpbeltr_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_rowid gb_common.internal_record_id_type)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
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 gpbeltr_rec,
                   rec_two gpbeltr_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 gpbeltr_rec Required
rec_two   The second record to compare. Type gpbeltr_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      gpbeltr.gpbeltr_syst_code%TYPE,
                     p_ctyp_code      gpbeltr.gpbeltr_ctyp_code%TYPE,
                     p_ctyp_url       gpbeltr.gpbeltr_ctyp_url%TYPE,
                     p_ctyp_exp_date  gpbeltr.gpbeltr_ctyp_exp_date%TYPE,
                     p_ctyp_exe_date  gpbeltr.gpbeltr_ctyp_exe_date%TYPE,
                     p_transmit_date  gpbeltr.gpbeltr_transmit_date%TYPE,
                     p_proxy_idm      gpbeltr.gpbeltr_proxy_idm%TYPE,
                     p_proxy_old_data gpbeltr.gpbeltr_proxy_old_data%TYPE,
                     p_proxy_new_data gpbeltr.gpbeltr_proxy_new_data%TYPE,
                     p_person_pidm    gpbeltr.gpbeltr_person_pidm%TYPE,
                     p_user_id        gpbeltr.gpbeltr_user_id%TYPE,
                     p_create_date    gpbeltr.gpbeltr_create_date%TYPE,
                     p_create_user    gpbeltr.gpbeltr_create_user%TYPE)
  RETURN gpbeltr_ref

Selects all records for the entity.

Parameters
p_syst_code   What system does this belong to. VARCHAR2(30) Required
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required
p_ctyp_url   URL to be executed by recipient to complete communication loop. VARCHAR2(256)
p_ctyp_exp_date   Date after which the CTYP_URL is expired and no longer valid. DATE
p_ctyp_exe_date   Date on which the CTYP_URL was executed by the recipient making it invalid for reuse. DATE
p_transmit_date   Date that letter was sent. DATE
p_proxy_idm   Proxy identifier. NUMBER(8) Required
p_proxy_old_data   Used to store old e-mail address. VARCHAR2(128)
p_proxy_new_data   Used to store new e-mail address. VARCHAR2(128)
p_person_pidm   This will be the pidm of the person initiating the proxy relationship. NUMBER(8)
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)

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

f_query_one 

FUNCTION f_query_one(p_syst_code      gpbeltr.gpbeltr_syst_code%TYPE,
                     p_ctyp_code      gpbeltr.gpbeltr_ctyp_code%TYPE,
                     p_ctyp_url       gpbeltr.gpbeltr_ctyp_url%TYPE,
                     p_ctyp_exp_date  gpbeltr.gpbeltr_ctyp_exp_date%TYPE,
                     p_ctyp_exe_date  gpbeltr.gpbeltr_ctyp_exe_date%TYPE,
                     p_transmit_date  gpbeltr.gpbeltr_transmit_date%TYPE,
                     p_proxy_idm      gpbeltr.gpbeltr_proxy_idm%TYPE,
                     p_proxy_old_data gpbeltr.gpbeltr_proxy_old_data%TYPE,
                     p_proxy_new_data gpbeltr.gpbeltr_proxy_new_data%TYPE,
                     p_person_pidm    gpbeltr.gpbeltr_person_pidm%TYPE,
                     p_user_id        gpbeltr.gpbeltr_user_id%TYPE,
                     p_create_date    gpbeltr.gpbeltr_create_date%TYPE,
                     p_create_user    gpbeltr.gpbeltr_create_user%TYPE)
  RETURN gpbeltr_ref

Selects one record using key.

Parameters
p_syst_code   What system does this belong to. VARCHAR2(30) Required
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required
p_ctyp_url   URL to be executed by recipient to complete communication loop. VARCHAR2(256)
p_ctyp_exp_date   Date after which the CTYP_URL is expired and no longer valid. DATE
p_ctyp_exe_date   Date on which the CTYP_URL was executed by the recipient making it invalid for reuse. DATE
p_transmit_date   Date that letter was sent. DATE
p_proxy_idm   Proxy identifier. NUMBER(8) Required
p_proxy_old_data   Used to store old e-mail address. VARCHAR2(128)
p_proxy_new_data   Used to store new e-mail address. VARCHAR2(128)
p_person_pidm   This will be the pidm of the person initiating the proxy relationship. NUMBER(8)
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)

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 gpbeltr_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      gpbeltr.gpbeltr_syst_code%TYPE,
                          p_ctyp_code      gpbeltr.gpbeltr_ctyp_code%TYPE,
                          p_ctyp_url       gpbeltr.gpbeltr_ctyp_url%TYPE,
                          p_ctyp_exp_date  gpbeltr.gpbeltr_ctyp_exp_date%TYPE,
                          p_ctyp_exe_date  gpbeltr.gpbeltr_ctyp_exe_date%TYPE,
                          p_transmit_date  gpbeltr.gpbeltr_transmit_date%TYPE,
                          p_proxy_idm      gpbeltr.gpbeltr_proxy_idm%TYPE,
                          p_proxy_old_data gpbeltr.gpbeltr_proxy_old_data%TYPE,
                          p_proxy_new_data gpbeltr.gpbeltr_proxy_new_data%TYPE,
                          p_person_pidm    gpbeltr.gpbeltr_person_pidm%TYPE,
                          p_user_id        gpbeltr.gpbeltr_user_id%TYPE,
                          p_create_date    gpbeltr.gpbeltr_create_date%TYPE,
                          p_create_user    gpbeltr.gpbeltr_create_user%TYPE,
                          p_rowid          gb_common.internal_record_id_type)
  RETURN gpbeltr_ref

Selects one record and locks it.

Parameters
p_syst_code   What system does this belong to. VARCHAR2(30) Required
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required
p_ctyp_url   URL to be executed by recipient to complete communication loop. VARCHAR2(256)
p_ctyp_exp_date   Date after which the CTYP_URL is expired and no longer valid. DATE
p_ctyp_exe_date   Date on which the CTYP_URL was executed by the recipient making it invalid for reuse. DATE
p_transmit_date   Date that letter was sent. DATE
p_proxy_idm   Proxy identifier. NUMBER(8) Required
p_proxy_old_data   Used to store old e-mail address. VARCHAR2(128)
p_proxy_new_data   Used to store new e-mail address. VARCHAR2(128)
p_person_pidm   This will be the pidm of the person initiating the proxy relationship. NUMBER(8)
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 selected. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.

p_create 

PROCEDURE p_create(p_syst_code      gpbeltr.gpbeltr_syst_code%TYPE,
                   p_ctyp_code      gpbeltr.gpbeltr_ctyp_code%TYPE,
                   p_ctyp_url       gpbeltr.gpbeltr_ctyp_url%TYPE DEFAULT NULL,
                   p_ctyp_exp_date  gpbeltr.gpbeltr_ctyp_exp_date%TYPE DEFAULT NULL,
                   p_ctyp_exe_date  gpbeltr.gpbeltr_ctyp_exe_date%TYPE DEFAULT NULL,
                   p_transmit_date  gpbeltr.gpbeltr_transmit_date%TYPE DEFAULT NULL,
                   p_proxy_idm      gpbeltr.gpbeltr_proxy_idm%TYPE,
                   p_proxy_old_data gpbeltr.gpbeltr_proxy_old_data%TYPE DEFAULT NULL,
                   p_proxy_new_data gpbeltr.gpbeltr_proxy_new_data%TYPE DEFAULT NULL,
                   p_person_pidm    gpbeltr.gpbeltr_person_pidm%TYPE DEFAULT NULL,
                   p_user_id        gpbeltr.gpbeltr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date    gpbeltr.gpbeltr_create_date%TYPE DEFAULT NULL,
                   p_create_user    gpbeltr.gpbeltr_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   What system does this belong to. VARCHAR2(30) Required
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required
p_ctyp_url   URL to be executed by recipient to complete communication loop. VARCHAR2(256)
p_ctyp_exp_date   Date after which the CTYP_URL is expired and no longer valid. DATE
p_ctyp_exe_date   Date on which the CTYP_URL was executed by the recipient making it invalid for reuse. DATE
p_transmit_date   Date that letter was sent. DATE
p_proxy_idm   Proxy identifier. NUMBER(8) Required
p_proxy_old_data   Used to store old e-mail address. VARCHAR2(128)
p_proxy_new_data   Used to store new e-mail address. VARCHAR2(128)
p_person_pidm   This will be the pidm of the person initiating the proxy relationship. NUMBER(8)
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      gpbeltr.gpbeltr_syst_code%TYPE,
                   p_ctyp_code      gpbeltr.gpbeltr_ctyp_code%TYPE,
                   p_ctyp_url       gpbeltr.gpbeltr_ctyp_url%TYPE,
                   p_ctyp_exp_date  gpbeltr.gpbeltr_ctyp_exp_date%TYPE,
                   p_ctyp_exe_date  gpbeltr.gpbeltr_ctyp_exe_date%TYPE,
                   p_transmit_date  gpbeltr.gpbeltr_transmit_date%TYPE,
                   p_proxy_idm      gpbeltr.gpbeltr_proxy_idm%TYPE,
                   p_proxy_old_data gpbeltr.gpbeltr_proxy_old_data%TYPE,
                   p_proxy_new_data gpbeltr.gpbeltr_proxy_new_data%TYPE,
                   p_person_pidm    gpbeltr.gpbeltr_person_pidm%TYPE,
                   p_user_id        gpbeltr.gpbeltr_user_id%TYPE,
                   p_create_date    gpbeltr.gpbeltr_create_date%TYPE,
                   p_create_user    gpbeltr.gpbeltr_create_user%TYPE,
                   p_rowid          gb_common.internal_record_id_type)

Deletes a record.

Parameters
p_syst_code   What system does this belong to. VARCHAR2(30) Required
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required
p_ctyp_url   URL to be executed by recipient to complete communication loop. VARCHAR2(256)
p_ctyp_exp_date   Date after which the CTYP_URL is expired and no longer valid. DATE
p_ctyp_exe_date   Date on which the CTYP_URL was executed by the recipient making it invalid for reuse. DATE
p_transmit_date   Date that letter was sent. DATE
p_proxy_idm   Proxy identifier. NUMBER(8) Required
p_proxy_old_data   Used to store old e-mail address. VARCHAR2(128)
p_proxy_new_data   Used to store new e-mail address. VARCHAR2(128)
p_person_pidm   This will be the pidm of the person initiating the proxy relationship. NUMBER(8)
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 deleted. VARCHAR2(18)

p_lock 

PROCEDURE p_lock(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_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

PROCEDURE p_update(p_syst_code      gpbeltr.gpbeltr_syst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ctyp_code      gpbeltr.gpbeltr_ctyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ctyp_url       gpbeltr.gpbeltr_ctyp_url%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_ctyp_exp_date  gpbeltr.gpbeltr_ctyp_exp_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_ctyp_exe_date  gpbeltr.gpbeltr_ctyp_exe_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_transmit_date  gpbeltr.gpbeltr_transmit_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_proxy_idm      gpbeltr.gpbeltr_proxy_idm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_proxy_old_data gpbeltr.gpbeltr_proxy_old_data%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_proxy_new_data gpbeltr.gpbeltr_proxy_new_data%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_person_pidm    gpbeltr.gpbeltr_person_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id        gpbeltr.gpbeltr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date    gpbeltr.gpbeltr_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_create_user    gpbeltr.gpbeltr_create_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type)

Updates a record.

Parameters
p_syst_code   What system does this belong to. VARCHAR2(30) Required
p_ctyp_code   Communications type within the system. VARCHAR2(30) Required
p_ctyp_url   URL to be executed by recipient to complete communication loop. VARCHAR2(256)
p_ctyp_exp_date   Date after which the CTYP_URL is expired and no longer valid. DATE
p_ctyp_exe_date   Date on which the CTYP_URL was executed by the recipient making it invalid for reuse. DATE
p_transmit_date   Date that letter was sent. DATE
p_proxy_idm   Proxy identifier. NUMBER(8) Required
p_proxy_old_data   Used to store old e-mail address. VARCHAR2(128)
p_proxy_new_data   Used to store new e-mail address. VARCHAR2(128)
p_person_pidm   This will be the pidm of the person initiating the proxy relationship. NUMBER(8)
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)