index

Package ab_adv_individual

This package provides the Common Business interface for the Advancement Idividual API (ab_adv_individual).
Only one Advancement Individual record may be created per PIDM, which must exist in SPRIDEN as a person.
 
An Advancement Individual record will be created only if the PIDM does not already exist as an Advancement Individual (i.e, a PIDM may exist as an Advancement Organization or an Advancement Individual, but never both).
 
A valid Donor Code (ATVDONR) must be supplied when creating an Advancement Individual record. If a Donor Category record (APRCATG) does not already exist for the Donor Code, it will be created when the Advancement Individual record is created, because an Advancement Individual record cannot exist without a Donor Category record.
 
When an Advancement Individual record is deleted, all of its Donor Category records will also be deleted.

Program units
f_api_version   Returns the API version number.
f_exists   Checks to see 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
adv_individual_rec   Entity record type
adv_individual_ref   Entity cursor variable type
adv_individual_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity name

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(22) := 'ADVANCEMENT_INDIVIDUAL';

Business Entity name

adv_individual_rec 

TYPE adv_individual_rec IS RECORD (
   r_pidm                    apbcons.apbcons_pidm%TYPE,
   r_pref_last_name          apbcons.apbcons_pref_last_name%TYPE,
   r_pref_first_name         apbcons.apbcons_pref_first_name%TYPE,
   r_pref_mi                 apbcons.apbcons_pref_mi%TYPE,
   r_nickname                apbcons.apbcons_nickname%TYPE,
   r_grad_name               apbcons.apbcons_grad_name%TYPE,
   r_parents_name            apbcons.apbcons_parents_name%TYPE,
   r_maiden_last_name        apbcons.apbcons_maiden_last_name%TYPE,
   r_pref_clas               apbcons.apbcons_pref_clas%TYPE,
   r_coll_code_pref          apbcons.apbcons_coll_code_pref%TYPE,
   r_home_city               apbcons.apbcons_home_city%TYPE,
   r_stat_code_home          apbcons.apbcons_stat_code_home%TYPE,
   r_natn_code_home          apbcons.apbcons_natn_code_home%TYPE,
   r_cm_name                 apbcons.apbcons_cm_name%TYPE,
   r_atyp_code_cm            apbcons.apbcons_atyp_code_cm%TYPE,
   r_dott_code               apbcons.apbcons_dott_code%TYPE,
   r_incm_code               apbcons.apbcons_incm_code%TYPE,
   r_atyp_code_pref          apbcons.apbcons_atyp_code_pref%TYPE,
   r_addr_name               apbcons.apbcons_addr_name%TYPE,
   r_atyp_code_geor          apbcons.apbcons_atyp_code_geor%TYPE,
   r_society_name            apbcons.apbcons_society_name%TYPE,
   r_data_origin             apbcons.apbcons_data_origin%TYPE,
   r_user_id                 apbcons.apbcons_user_id%TYPE,
   r_surname_prefix          apbcons.apbcons_surname_prefix%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

adv_individual_ref 

TYPE adv_individual_ref IS REF CURSOR RETURN adv_individual_rec;

Entity cursor variable type

adv_individual_tab 

TYPE adv_individual_tab IS TABLE OF adv_individual_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_pidm  apbcons.apbcons_pidm%TYPE,
                  p_rowid VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual. NUMBER(8) Required Key
p_rowid   Database ROWID of record to select. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_isequal 

Function f_isequal(rec_one adv_individual_rec, rec_two adv_individual_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 adv_individual_rec Required
rec_two   The second record to compare. Type adv_individual_rec Required

Returns
Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all 

Function f_query_all(p_pidm apbcons.apbcons_pidm%TYPE)
  RETURN adv_individual_ref

Selects all records for the entity.

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual.

Returns
A cursor variable that will fetch the set of records

f_query_one 

Function f_query_one(p_pidm apbcons.apbcons_pidm%TYPE)
  RETURN adv_individual_ref

Selects one record using key.

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual.

Returns
A cursor variable that will fetch exactly one record

f_query_by_rowid 

Function f_query_by_rowid(p_rowid VARCHAR2) RETURN adv_individual_ref

Selects one record using ROWID.

Parameters
p_rowid   Database ROWID of record to select

Returns
A cursor variable that will fetch exactly one record

f_query_one_lock 

Function f_query_one_lock(p_pidm  apbcons.apbcons_pidm%TYPE,
                          p_rowid VARCHAR2 DEFAULT NULL)
  RETURN adv_individual_ref

Selects one record and locks it.

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual.
p_rowid   Database ROWID of record to select

Returns
A cursor variable for one record, locking the record

p_create 

Procedure p_create(p_pidm             apbcons.apbcons_pidm%TYPE,
                   p_pref_last_name   apbcons.apbcons_pref_last_name%TYPE DEFAULT NULL,
                   p_pref_first_name  apbcons.apbcons_pref_first_name%TYPE DEFAULT NULL,
                   p_pref_mi          apbcons.apbcons_pref_mi%TYPE DEFAULT NULL,
                   p_nickname         apbcons.apbcons_nickname%TYPE DEFAULT NULL,
                   p_grad_name        apbcons.apbcons_grad_name%TYPE DEFAULT NULL,
                   p_parents_name     apbcons.apbcons_parents_name%TYPE DEFAULT NULL,
                   p_maiden_last_name apbcons.apbcons_maiden_last_name%TYPE DEFAULT NULL,
                   p_pref_clas        apbcons.apbcons_pref_clas%TYPE,
                   p_coll_code_pref   apbcons.apbcons_coll_code_pref%TYPE DEFAULT NULL,
                   p_home_city        apbcons.apbcons_home_city%TYPE DEFAULT NULL,
                   p_stat_code_home   apbcons.apbcons_stat_code_home%TYPE DEFAULT NULL,
                   p_natn_code_home   apbcons.apbcons_natn_code_home%TYPE DEFAULT NULL,
                   p_cm_name          apbcons.apbcons_cm_name%TYPE DEFAULT NULL,
                   p_atyp_code_cm     apbcons.apbcons_atyp_code_cm%TYPE DEFAULT NULL,
                   p_dott_code        apbcons.apbcons_dott_code%TYPE DEFAULT NULL,
                   p_incm_code        apbcons.apbcons_incm_code%TYPE DEFAULT NULL,
                   p_atyp_code_pref   apbcons.apbcons_atyp_code_pref%TYPE DEFAULT NULL,
                   p_addr_name        apbcons.apbcons_addr_name%TYPE DEFAULT NULL,
                   p_atyp_code_geor   apbcons.apbcons_atyp_code_geor%TYPE DEFAULT NULL,
                   p_society_name     apbcons.apbcons_society_name%TYPE DEFAULT NULL,
                   p_data_origin      apbcons.apbcons_data_origin%TYPE DEFAULT NULL,
                   p_user_id          apbcons.apbcons_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_donr_code        aprcatg.aprcatg_donr_code%TYPE DEFAULT NULL,
                   p_surname_prefix   apbcons.apbcons_surname_prefix%TYPE DEFAULT NULL,
                   p_rowid_out        OUT VARCHAR2)

Creates a record.

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual. NUMBER(8) Required Key
p_pref_last_name   Preferred last name of the Advancement Individual. VARCHAR2(60)
p_pref_first_name   Preferred first name of the Advancement Individual. VARCHAR2(60)
p_pref_mi   Preferred middle initial of the Advancement Individual. VARCHAR2(1)
p_surname_prefix   Surname prefix of the Advancement Individual. VARCHAR2(10)
p_nickname   Nickname used by the Advancement Individual. VARCHAR2(40)
p_grad_name   Advancement Individual's name at the time of college graduation. VARCHAR2(60)
p_parents_name   Name of the Advancement Individual's parents. VARCHAR2(50)
p_maiden_last_name   Advancement Individual's maiden name. VARCHAR2(25)
p_pref_clas   Year in which the Advancement Individual received the first degree or the year of expected graduation if the first degree has not yet been earned. VARCHAR2(4) Required
p_coll_code_pref   College within the institution with which the Advancement Individual prefers to be associated. VARCHAR2(2)
p_home_city   Advancement Individual's hometown. VARCHAR2(20)
p_stat_code_home   State of the Advancement Individual's hometown. VARCHAR2(3)
p_natn_code_home   Country of the Advancement Individual's hometown. VARCHAR2(5)
p_cm_name   Combined mailing name for the Advancement Individual. VARCHAR2(50)
p_atyp_code_cm   Address type to be used for the combined mailing. VARCHAR2(2)
p_dott_code   Advancement Individual's occupational title. VARCHAR2(4)
p_incm_code   Advancement Individual's income level. VARCHAR2(2)
p_atyp_code_pref   Advancement Individual's preferred address for solicitations and acknowledgements. VARCHAR2(2)
p_addr_name   Name to be used with the preferred address type. VARCHAR2(35)
p_atyp_code_geor   Address type of the address to be used as the preferred geographic region address. VARCHAR2(2)
p_society_name   Gift Society name. Defaults to gift societies when the memberships are created. The name may be modified on the society form. VARCHAR2(60)
p_data_origin   Source system that generated or updated the data.  VARCHAR2(30)
p_user_id   User who inserted or last updated the data. VARCHAR2(30)
p_rowid_out   Database ROWID. VARCHAR2(18)

p_delete 

Procedure p_delete(p_pidm  apbcons.apbcons_pidm%TYPE,
                   p_rowid VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual.
p_rowid   Database ROWID of record to delete

p_lock 

Procedure p_lock(p_pidm        apbcons.apbcons_pidm%TYPE,
                 p_rowid_inout IN OUT VARCHAR2)

Locks a record.
If ROWID is not passed in, the record is located using the key values.
The ROWID of the locked row is passed in and out using p_rowid_inout.

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual.
p_rowid_inout   Database ROWID of record to lock

p_update 

Procedure p_update(p_pidm             apbcons.apbcons_pidm%TYPE,
                   p_pref_last_name   apbcons.apbcons_pref_last_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pref_first_name  apbcons.apbcons_pref_first_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pref_mi          apbcons.apbcons_pref_mi%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_nickname         apbcons.apbcons_nickname%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_grad_name        apbcons.apbcons_grad_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_parents_name     apbcons.apbcons_parents_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_maiden_last_name apbcons.apbcons_maiden_last_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pref_clas        apbcons.apbcons_pref_clas%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_coll_code_pref   apbcons.apbcons_coll_code_pref%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_home_city        apbcons.apbcons_home_city%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_stat_code_home   apbcons.apbcons_stat_code_home%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_natn_code_home   apbcons.apbcons_natn_code_home%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_cm_name          apbcons.apbcons_cm_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_code_cm     apbcons.apbcons_atyp_code_cm%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_dott_code        apbcons.apbcons_dott_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_incm_code        apbcons.apbcons_incm_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_code_pref   apbcons.apbcons_atyp_code_pref%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_addr_name        apbcons.apbcons_addr_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_code_geor   apbcons.apbcons_atyp_code_geor%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_society_name     apbcons.apbcons_society_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin      apbcons.apbcons_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id          apbcons.apbcons_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_surname_prefix   apbcons.apbcons_surname_prefix%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid            VARCHAR2 DEFAULT NULL)

Updates a record

Parameters
p_pidm   Internal system-generated identification number of the Advancement Individual. NUMBER(8) Required Key
p_pref_last_name   Preferred last name of the Advancement Individual. VARCHAR2(25)
p_pref_first_name   Preferred first name of the Advancement Individual. VARCHAR2(15)
p_pref_mi   Preferred middle initial of the Advancement Individual. VARCHAR2(1)
p_surname_prefix   Surname prefix of the Advancement Individual. VARCHAR2(10)
p_nickname   Nickname used by the Advancement Individual. VARCHAR2(40)
p_grad_name   Advancement Individual's name at the time of college graduation. VARCHAR2(60)
p_parents_name   Name of the Advancement Individual's parents. VARCHAR2(50)
p_maiden_last_name   Advancement Individual's maiden name. VARCHAR2(25)
p_pref_clas   Year in which the Advancement Individual received the first degree or the year of expected graduation if the first degree has not yet been earned. VARCHAR2(4) Required
p_coll_code_pref   College within the institution with which the Advancement Individual prefers to be associated. VARCHAR2(2)
p_home_city   Advancement Individual's hometown. VARCHAR2(20)
p_stat_code_home   State of the Advancement Individual's hometown. VARCHAR2(3)
p_natn_code_home   Country of the Advancement Individual's hometown. VARCHAR2(5)
p_cm_name   Combined mailing name for the Advancement Individual. VARCHAR2(50)
p_atyp_code_cm   Address type to be used for the combined mailing. VARCHAR2(2)
p_dott_code   Advancement Individual's occupational title. VARCHAR2(4)
p_incm_code   Advancement Individual's income level. VARCHAR2(2)
p_atyp_code_pref   Advancement Individual's preferred address for solicitations and acknowledgements. VARCHAR2(2)
p_addr_name   Name to be used with the preferred address type. VARCHAR2(35)
p_atyp_code_geor   Address type of the address to be used as the preferred geographic region address. VARCHAR2(2)
p_society_name   Gift Society name. Defaults to gift societies when the memberships are created. The name may be modified on the society form. VARCHAR2(60)
p_data_origin   Source system that generated or updated the data.  VARCHAR2(30)
p_user_id   User who inserted or last updated the data. VARCHAR2(30)
p_surname_prefix   Surname prefix of the Advancement Individual. VARCHAR2(60)
p_rowid   Database ROWID. VARCHAR2(18)