index

Package gp_gerload

Common Business interface for the GERLOAD API (gp_gerload).

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
gerload_rec   Business Entity record type
gerload_ref   Entity cursor variable type
gerload_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) := 'GERLOAD';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

gerload_rec 

TYPE gerload_rec IS RECORD (
  r_syst_code               gerload.gerload_syst_code%TYPE,
  r_retp_code               gerload.gerload_retp_code%TYPE,
  r_dtyp_code               gerload.gerload_dtyp_code%TYPE,
  r_load_activity_ind       gerload.gerload_load_activity_ind%TYPE,
  r_user_id                 gerload.gerload_user_id%TYPE,
  r_create_date             gerload.gerload_create_date%TYPE,
  r_create_user             gerload.gerload_create_user%TYPE,
  r_opt_out_adv_ind         gerload.gerload_opt_out_adv_ind%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gerload_ref 

TYPE gerload_ref IS REF CURSOR RETURN gerload_rec;

Entity cursor variable type

gerload_tab 

TYPE gerload_tab IS TABLE OF gerload_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 gerload.gerload_syst_code%TYPE,
                  p_retp_code gerload.gerload_retp_code%TYPE,
                  p_dtyp_code gerload.gerload_dtyp_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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_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 gerload_rec,
                   rec_two gerload_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 gerload_rec Required
rec_two   The second record to compare. Type gerload_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 gerload.gerload_syst_code%TYPE,
                     p_retp_code gerload.gerload_retp_code%TYPE,
                     p_dtyp_code gerload.gerload_dtyp_code%TYPE)
  RETURN gerload_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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_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_syst_code gerload.gerload_syst_code%TYPE,
                     p_retp_code gerload.gerload_retp_code%TYPE,
                     p_dtyp_code gerload.gerload_dtyp_code%TYPE)
  RETURN gerload_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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_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 gerload_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 gerload.gerload_syst_code%TYPE,
                          p_retp_code gerload.gerload_retp_code%TYPE,
                          p_dtyp_code gerload.gerload_dtyp_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gerload_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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_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_syst_code         gerload.gerload_syst_code%TYPE,
                   p_retp_code         gerload.gerload_retp_code%TYPE,
                   p_dtyp_code         gerload.gerload_dtyp_code%TYPE,
                   p_load_activity_ind gerload.gerload_load_activity_ind%TYPE,
                   p_user_id           gerload.gerload_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date       gerload.gerload_create_date%TYPE DEFAULT NULL,
                   p_create_user       gerload.gerload_create_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_opt_out_adv_ind   gerload.gerload_opt_out_adv_ind%TYPE DEFAULT NULL,
                   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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_code   Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). VARCHAR2(30) Required Key
p_load_activity_ind   For this combination, what should happen? Values include Y (move to Banner) and N (do not move to Banner). VARCHAR2(1) Required
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_opt_out_adv_ind   For system and relationship type, can person opt out of being added to Advancement? Values are Y (yes, can opt out), N (no, cannot opt out). VARCHAR2(1)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

PROCEDURE p_delete(p_syst_code gerload.gerload_syst_code%TYPE,
                   p_retp_code gerload.gerload_retp_code%TYPE,
                   p_dtyp_code gerload.gerload_dtyp_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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_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_syst_code   gerload.gerload_syst_code%TYPE,
                 p_retp_code   gerload.gerload_retp_code%TYPE,
                 p_dtyp_code   gerload.gerload_dtyp_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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_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_syst_code         gerload.gerload_syst_code%TYPE,
                   p_retp_code         gerload.gerload_retp_code%TYPE,
                   p_dtyp_code         gerload.gerload_dtyp_code%TYPE,
                   p_load_activity_ind gerload.gerload_load_activity_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id           gerload.gerload_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date       gerload.gerload_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_create_user       gerload.gerload_create_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_opt_out_adv_ind   gerload.gerload_opt_out_adv_ind%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_retp_code   Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
p_dtyp_code   Data type within Banner that can be populated (e.g. Basic Person, Proxy, Advancement, etc). VARCHAR2(30) Required Key
p_load_activity_ind   For this combination, what should happen? Values include Y (move to Banner) and N (do not move to Banner). VARCHAR2(1) Required
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_opt_out_adv_ind   For system and relationship type, can person opt out of being added to Advancement? Values are Y (yes, can opt out), N (no, cannot opt out). VARCHAR2(1)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)