Package gp_genbpsh
Common Business interface for the GENBPSH API (gp_genbpsh).
|
M_ENTITY_NAME
M_ENTITY_NAME CONSTANT VARCHAR2(7) := 'GENBPSH';
Business Entity Name
M_BASE_TABLE_NAME
M_BASE_TABLE_NAME CONSTANT VARCHAR2(7) := 'GENBPSH';
Base table name
genbpsh_rec
TYPE genbpsh_rec IS RECORD (
r_gidm genbpsh.genbpsh_gidm%TYPE,
r_syst_code genbpsh.genbpsh_syst_code%TYPE,
r_retp_code genbpsh.genbpsh_retp_code%TYPE,
r_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
r_create_ind genbpsh.genbpsh_create_ind%TYPE,
r_person_pidm genbpsh.genbpsh_person_pidm%TYPE,
r_aux_data genbpsh.genbpsh_aux_data%TYPE,
r_load_status genbpsh.genbpsh_load_status%TYPE,
r_load_date genbpsh.genbpsh_load_date%TYPE,
r_user_id genbpsh.genbpsh_user_id%TYPE,
r_create_date genbpsh.genbpsh_create_date%TYPE,
r_internal_record_id gb_common.internal_record_id_type);
Business Entity record type
genbpsh_ref
TYPE genbpsh_ref IS REF CURSOR RETURN genbpsh_rec;
Entity cursor variable type
genbpsh_tab
TYPE genbpsh_tab IS TABLE OF genbpsh_rec INDEX BY BINARY_INTEGER;
Entity table type
f_api_version
FUNCTION f_api_version RETURN PLS_INTEGER
Returns the API version number.
|
Version of the API signature. Changes only when the signature changes.
|
f_exists
FUNCTION f_exists(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_person_pidm genbpsh.genbpsh_person_pidm%TYPE,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
RETURN VARCHAR2
Checks if a record exists.
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18)
|
f_isequal
FUNCTION f_isequal(rec_one genbpsh_rec,
rec_two genbpsh_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.
|
rec_one
|
The first record to compare. Type genbpsh_rec Required
|
|
rec_two
|
The second record to compare. Type genbpsh_rec Required
|
|
Y if all values in records are equal, otherwise N. Nulls match Nulls.
|
f_query_all
FUNCTION f_query_all(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_person_pidm genbpsh.genbpsh_person_pidm%TYPE)
RETURN genbpsh_ref
Selects all records for the entity.
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
A cursor variable that will fetch a set of records.
|
f_query_one
FUNCTION f_query_one(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_person_pidm genbpsh.genbpsh_person_pidm%TYPE)
RETURN genbpsh_ref
Selects one record using key.
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
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 genbpsh_ref
Selects one record using ROWID.
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18) Required
|
|
A cursor variable that will fetch exactly one record.
|
f_query_one_lock
FUNCTION f_query_one_lock(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_person_pidm genbpsh.genbpsh_person_pidm%TYPE,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
RETURN genbpsh_ref
Selects one record and locks it.
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
p_rowid
|
Database ROWID of the record to be selected. VARCHAR2(18)
|
|
A cursor variable for one record, locking the record.
|
p_create
PROCEDURE p_create(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_create_ind genbpsh.genbpsh_create_ind%TYPE,
p_person_pidm genbpsh.genbpsh_person_pidm%TYPE,
p_aux_data genbpsh.genbpsh_aux_data%TYPE DEFAULT NULL,
p_load_status genbpsh.genbpsh_load_status%TYPE DEFAULT NULL,
p_load_date genbpsh.genbpsh_load_date%TYPE DEFAULT NULL,
p_user_id genbpsh.genbpsh_user_id%TYPE DEFAULT gb_common.f_sct_user,
p_create_date genbpsh.genbpsh_create_date%TYPE DEFAULT NULL,
p_rowid_out OUT gb_common.internal_record_id_type)
Creates a record.
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_create_ind
|
Should this data type be created? Y = yes, create; N = no, do not create. This is initially populated from the rule table and may be overridden on the online form. VARCHAR2(1) Required
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
p_aux_data
|
This will be the Advancement XREF code belonging to the proxy (GENBPSH_PIDM); the Advancement XREF code for the person can be derived from ATVXREF_REVERSE_XREF. VARCHAR2(30)
|
|
p_load_status
|
The status of moving this type of data for this person. Valid value is M (move). A blank/null value is unprocessed. VARCHAR2(1)
|
|
p_load_date
|
Date the data was moved. DATE
|
|
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_rowid_out
|
Database ROWID of the record to be created. VARCHAR2(18) Required
|
p_delete
PROCEDURE p_delete(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_person_pidm genbpsh.genbpsh_person_pidm%TYPE,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
Deletes a record.
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
p_rowid
|
Database ROWID of the record to be deleted. VARCHAR2(18)
|
p_lock
PROCEDURE p_lock(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_person_pidm genbpsh.genbpsh_person_pidm%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
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
p_rowid_inout
|
Database ROWID of the record to be locked. VARCHAR2(18) Required
|
p_update
PROCEDURE p_update(p_gidm genbpsh.genbpsh_gidm%TYPE,
p_syst_code genbpsh.genbpsh_syst_code%TYPE,
p_retp_code genbpsh.genbpsh_retp_code%TYPE,
p_dtyp_code genbpsh.genbpsh_dtyp_code%TYPE,
p_create_ind genbpsh.genbpsh_create_ind%TYPE DEFAULT dml_common.f_unspecified_string,
p_person_pidm genbpsh.genbpsh_person_pidm%TYPE,
p_aux_data genbpsh.genbpsh_aux_data%TYPE DEFAULT dml_common.f_unspecified_string,
p_load_status genbpsh.genbpsh_load_status%TYPE DEFAULT dml_common.f_unspecified_string,
p_load_date genbpsh.genbpsh_load_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_user_id genbpsh.genbpsh_user_id%TYPE DEFAULT dml_common.f_unspecified_string,
p_create_date genbpsh.genbpsh_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
p_rowid gb_common.internal_record_id_type DEFAULT NULL)
Updates a record.
|
p_gidm
|
Unique ID of General Matching Person. NUMBER(8) Required Key
|
|
p_syst_code
|
Specifies what system will be using this person (e.g. Web4Proxy). VARCHAR2(30) Required Key
|
|
p_retp_code
|
Record type within system (e.g. Parent, Spouse, Employer, etc). VARCHAR2(30) Required Key
|
|
p_dtyp_code
|
What kind of data is this (e.g. Proxy, Advancement, etc). VARCHAR2(30) Required Key
|
|
p_create_ind
|
Should this data type be created? Y = yes, create; N = no, do not create. This is initially populated from the rule table and may be overridden on the online form. VARCHAR2(1) Required
|
|
p_person_pidm
|
This will be the pidm of the person initiating the proxy relationship. NUMBER(8) Required Key
|
|
p_aux_data
|
This will be the Advancement XREF code belonging to the proxy (GENBPSH_PIDM); the Advancement XREF code for the person can be derived from ATVXREF_REVERSE_XREF. VARCHAR2(30)
|
|
p_load_status
|
The status of moving this type of data for this person. Valid value is M (move). A blank/null value is unprocessed. VARCHAR2(1)
|
|
p_load_date
|
Date the data was moved. DATE
|
|
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_rowid
|
Database ROWID of the record to be updated. VARCHAR2(18)
|