M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(7) := 'GPRXREF';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

gprxref_rec

TYPE gprxref_rec IS RECORD (
  r_proxy_idm               gprxref.gprxref_proxy_idm%TYPE,
  r_person_pidm             gprxref.gprxref_person_pidm%TYPE,
  r_retp_code               gprxref.gprxref_retp_code%TYPE,
  r_proxy_desc              gprxref.gprxref_proxy_desc%TYPE,
  r_start_date              gprxref.gprxref_start_date%TYPE,
  r_stop_date               gprxref.gprxref_stop_date%TYPE,
  r_create_user             gprxref.gprxref_create_user%TYPE,
  r_create_date             gprxref.gprxref_create_date%TYPE,
  r_user_id                 gprxref.gprxref_user_id%TYPE,
  r_passphrase              gprxref.gprxref_passphrase%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gprxref_ref

TYPE gprxref_ref IS REF CURSOR RETURN gprxref_rec;

Entity cursor variable type

gprxref_tab

TYPE gprxref_tab IS TABLE OF gprxref_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version

FUNCTION f_api_version RETURN PLS_INTEGER

Returns the API version number.

f_exists

FUNCTION f_exists(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                  p_person_pidm gprxref.gprxref_person_pidm%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

f_isequal

FUNCTION f_isequal(rec_one gprxref_rec,
                   rec_two gprxref_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.

f_query_all

FUNCTION f_query_all(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                     p_person_pidm gprxref.gprxref_person_pidm%TYPE)
  RETURN gprxref_ref

Selects all records for the entity.

f_query_one

FUNCTION f_query_one(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                     p_person_pidm gprxref.gprxref_person_pidm%TYPE)
  RETURN gprxref_ref

Selects one record using key.

f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN gprxref_ref

Selects one record using ROWID.

f_query_one_lock

FUNCTION f_query_one_lock(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                          p_person_pidm gprxref.gprxref_person_pidm%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN gprxref_ref

Selects one record and locks it.

F_GetXREF_RETP

FUNCTION f_getxref_retp(p_proxyidm    gprxref.gprxref_proxy_idm%TYPE,
                        p_person_pidm gprxref.gprxref_person_pidm%TYPE)
  RETURN VARCHAR2

Get the current relationship code and eturn AAA if none found

p_create

PROCEDURE p_create(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                   p_person_pidm gprxref.gprxref_person_pidm%TYPE,
                   p_retp_code   gprxref.gprxref_retp_code%TYPE,
                   p_proxy_desc  gprxref.gprxref_proxy_desc%TYPE DEFAULT NULL,
                   p_start_date  gprxref.gprxref_start_date%TYPE,
                   p_stop_date   gprxref.gprxref_stop_date%TYPE,
                   p_create_user gprxref.gprxref_create_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date gprxref.gprxref_create_date%TYPE DEFAULT NULL,
                   p_user_id     gprxref.gprxref_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_passphrase  gprxref.gprxref_passphrase%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

* Creates a record.
* @param p_proxy_idm See GPBPRXY. There is one GPRXREF record per proxy/person combination. NUMBER(8) Required Key
* @param p_person_pidm General Person PIDM of student who cross-referenced this proxy. NUMBER(8) Required Key
* @param p_retp_code This code defines the relationship to the proxy as maintained by the person. This code may determine rules or parameters for the proxy authorization. A proxy with parent code may be selected for common matching. VARCHAR2(30)
 Required
* @param p_proxy_desc This is a name or description shown with the proxy email address as maintained by the person. It could be their proper name or something like "mom", "dad" or "uncle bud". The proxy email address and this description are shown on
 the person pages to help identify the proxy. VARCHAR2(120)
* @param p_start_date This date is maintained by the person. TRUNC(SYSDATE) must be equal or greater than this date before the person can be selected by the proxy to view pages. Default to the date the proxy was added by the person. Future dating is
 supported. DATE Required
* @param p_stop_date This date is maintained by the person. TRUNC(SYSDATE) must be equal or less than this date before the person can be selected by the proxy to view pages. The default stop date is calculated using rule parameter based on
 relationship code. The stop date can be updated to a past date to disable access for that proxy. DATE Required
* @param p_create_user Username responsible for initial creation. VARCHAR2(30)
* @param p_create_date Date when the record was initially created. DATE
* @param p_user_id The ID for the user that most recently updated the record. VARCHAR2(30)
* @param p_passphrase This character string is assigned by the person and known by the proxy as evidence of FERPA authorization. Not used by web4proxy. VARCHAR2(256)
* @param p_rowid_out Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                   p_person_pidm gprxref.gprxref_person_pidm%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

p_lock

PROCEDURE p_lock(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                 p_person_pidm gprxref.gprxref_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_update

PROCEDURE p_update(p_proxy_idm   gprxref.gprxref_proxy_idm%TYPE,
                   p_person_pidm gprxref.gprxref_person_pidm%TYPE,
                   p_retp_code   gprxref.gprxref_retp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_proxy_desc  gprxref.gprxref_proxy_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_start_date  gprxref.gprxref_start_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_stop_date   gprxref.gprxref_stop_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_create_user gprxref.gprxref_create_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_create_date gprxref.gprxref_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_user_id     gprxref.gprxref_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_passphrase  gprxref.gprxref_passphrase%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

* Updates a record.
* @param p_proxy_idm See GPBPRXY. There is one GPRXREF record per proxy/person combination. NUMBER(8) Required Key
* @param p_person_pidm General Person PIDM of student who cross-referenced this proxy. NUMBER(8) Required Key
* @param p_retp_code This code defines the relationship to the proxy as maintained by the person. This code may determine rules or parameters for the proxy authorization. A proxy with parent code may be selected for common matching. VARCHAR2(30)
 Required
* @param p_proxy_desc This is a name or description shown with the proxy email address as maintained by the person. It could be their proper name or something like "mom", "dad" or "uncle bud". The proxy email address and this description are shown on
 the person pages to help identify the proxy. VARCHAR2(120)
* @param p_start_date This date is maintained by the person. TRUNC(SYSDATE) must be equal or greater than this date before the person can be selected by the proxy to view pages. Default to the date the proxy was added by the person. Future dating is
 supported. DATE Required
* @param p_stop_date This date is maintained by the person. TRUNC(SYSDATE) must be equal or less than this date before the person can be selected by the proxy to view pages. The default stop date is calculated using rule parameter based on
 relationship code. The stop date can be updated to a past date to disable access for that proxy. DATE Required
* @param p_create_user Username responsible for initial creation. VARCHAR2(30)
* @param p_create_date Date when the record was initially created. DATE
* @param p_user_id The ID for the user that most recently updated the record. VARCHAR2(30)
* @param p_passphrase This character string is assigned by the person and known by the proxy as evidence of FERPA authorization. Not used by web4proxy. VARCHAR2(256)
* @param p_rowid Database ROWID of the record to be updated. VARCHAR2(18)