index

Package gp_gprhist

Common Business interface for the GPRHIST API (gp_gprhist).

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
gprhist_rec   Business Entity record type
gprhist_ref   Entity cursor variable type
gprhist_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) := 'GPRHIST';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

gprhist_rec 

TYPE gprhist_rec IS RECORD (
  r_person_pidm             gprhist.gprhist_person_pidm%TYPE,
  r_page_name               gprhist.gprhist_page_name%TYPE,
  r_old_auth_ind            gprhist.gprhist_old_auth_ind%TYPE,
  r_new_auth_ind            gprhist.gprhist_new_auth_ind%TYPE,
  r_create_user             gprhist.gprhist_create_user%TYPE,
  r_create_date             gprhist.gprhist_create_date%TYPE,
  r_user_id                 gprhist.gprhist_user_id%TYPE,
  r_proxy_idm               gprhist.gprhist_proxy_idm%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

gprhist_ref 

TYPE gprhist_ref IS REF CURSOR RETURN gprhist_rec;

Entity cursor variable type

gprhist_tab 

TYPE gprhist_tab IS TABLE OF gprhist_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 gprhist_rec,
                   rec_two gprhist_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 gprhist_rec Required
rec_two   The second record to compare. Type gprhist_rec Required

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

f_query_all 

FUNCTION f_query_all(p_person_pidm  gprhist.gprhist_person_pidm%TYPE,
                     p_page_name    gprhist.gprhist_page_name%TYPE,
                     p_old_auth_ind gprhist.gprhist_old_auth_ind%TYPE,
                     p_new_auth_ind gprhist.gprhist_new_auth_ind%TYPE,
                     p_create_user  gprhist.gprhist_create_user%TYPE,
                     p_create_date  gprhist.gprhist_create_date%TYPE,
                     p_user_id      gprhist.gprhist_user_id%TYPE,
                     p_proxy_idm    gprhist.gprhist_proxy_idm%TYPE)
  RETURN gprhist_ref

Selects all records for the entity.

Parameters
p_person_pidm   General Person PIDM of person involved in this activity. NUMBER(8) Required
p_page_name   This is the Banner Self-Service page name in package.procedure format. VARCHAR2(120) Required
p_old_auth_ind   The value "Y" means the person has authorized the proxy to see the page on their behalf. VARCHAR2(1)
p_new_auth_ind   The value "N" means the person has revoked authorization. VARCHAR2(1)
p_create_user   Username responsible for initial creation. VARCHAR2(30)
p_create_date   Date when the record was initially created. DATE
p_user_id   The ID for the user that most recently updated the record. VARCHAR2(30)
p_proxy_idm   See GPBPRXY. NUMBER(8) Required

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

f_query_one 

FUNCTION f_query_one(p_person_pidm  gprhist.gprhist_person_pidm%TYPE,
                     p_page_name    gprhist.gprhist_page_name%TYPE,
                     p_old_auth_ind gprhist.gprhist_old_auth_ind%TYPE,
                     p_new_auth_ind gprhist.gprhist_new_auth_ind%TYPE,
                     p_create_user  gprhist.gprhist_create_user%TYPE,
                     p_create_date  gprhist.gprhist_create_date%TYPE,
                     p_user_id      gprhist.gprhist_user_id%TYPE,
                     p_proxy_idm    gprhist.gprhist_proxy_idm%TYPE)
  RETURN gprhist_ref

Selects one record using key.

Parameters
p_person_pidm   General Person PIDM of person involved in this activity. NUMBER(8) Required
p_page_name   This is the Banner Self-Service page name in package.procedure format. VARCHAR2(120) Required
p_old_auth_ind   The value "Y" means the person has authorized the proxy to see the page on their behalf. VARCHAR2(1)
p_new_auth_ind   The value "N" means the person has revoked authorization. VARCHAR2(1)
p_create_user   Username responsible for initial creation. VARCHAR2(30)
p_create_date   Date when the record was initially created. DATE
p_user_id   The ID for the user that most recently updated the record. VARCHAR2(30)
p_proxy_idm   See GPBPRXY. NUMBER(8) Required

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 gprhist_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_person_pidm  gprhist.gprhist_person_pidm%TYPE,
                          p_page_name    gprhist.gprhist_page_name%TYPE,
                          p_old_auth_ind gprhist.gprhist_old_auth_ind%TYPE,
                          p_new_auth_ind gprhist.gprhist_new_auth_ind%TYPE,
                          p_create_user  gprhist.gprhist_create_user%TYPE,
                          p_create_date  gprhist.gprhist_create_date%TYPE,
                          p_user_id      gprhist.gprhist_user_id%TYPE,
                          p_proxy_idm    gprhist.gprhist_proxy_idm%TYPE,
                          p_rowid        gb_common.internal_record_id_type)
  RETURN gprhist_ref

Selects one record and locks it.

Parameters
p_person_pidm   General Person PIDM of person involved in this activity. NUMBER(8) Required
p_page_name   This is the Banner Self-Service page name in package.procedure format. VARCHAR2(120) Required
p_old_auth_ind   The value "Y" means the person has authorized the proxy to see the page on their behalf. VARCHAR2(1)
p_new_auth_ind   The value "N" means the person has revoked authorization. VARCHAR2(1)
p_create_user   Username responsible for initial creation. VARCHAR2(30)
p_create_date   Date when the record was initially created. DATE
p_user_id   The ID for the user that most recently updated the record. VARCHAR2(30)
p_proxy_idm   See GPBPRXY. NUMBER(8) Required
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_person_pidm  gprhist.gprhist_person_pidm%TYPE,
                   p_page_name    gprhist.gprhist_page_name%TYPE,
                   p_old_auth_ind gprhist.gprhist_old_auth_ind%TYPE DEFAULT NULL,
                   p_new_auth_ind gprhist.gprhist_new_auth_ind%TYPE DEFAULT NULL,
                   p_create_user  gprhist.gprhist_create_user%TYPE DEFAULT gb_common.f_sct_user,
                   p_create_date  gprhist.gprhist_create_date%TYPE DEFAULT NULL,
                   p_user_id      gprhist.gprhist_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_proxy_idm    gprhist.gprhist_proxy_idm%TYPE,
                   p_rowid_out    OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_person_pidm   General Person PIDM of person involved in this activity. NUMBER(8) Required
p_page_name   This is the Banner Self-Service page name in package.procedure format. VARCHAR2(120) Required
p_old_auth_ind   The value "Y" means the person has authorized the proxy to see the page on their behalf. VARCHAR2(1)
p_new_auth_ind   The value "N" means the person has revoked authorization. VARCHAR2(1)
p_create_user   Username responsible for initial creation. VARCHAR2(30)
p_create_date   Date when the record was initially created. DATE
p_user_id   The ID for the user that most recently updated the record. VARCHAR2(30)
p_proxy_idm   See GPBPRXY. NUMBER(8) Required
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

PROCEDURE p_delete(p_person_pidm  gprhist.gprhist_person_pidm%TYPE,
                   p_page_name    gprhist.gprhist_page_name%TYPE,
                   p_old_auth_ind gprhist.gprhist_old_auth_ind%TYPE,
                   p_new_auth_ind gprhist.gprhist_new_auth_ind%TYPE,
                   p_create_user  gprhist.gprhist_create_user%TYPE,
                   p_create_date  gprhist.gprhist_create_date%TYPE,
                   p_user_id      gprhist.gprhist_user_id%TYPE,
                   p_proxy_idm    gprhist.gprhist_proxy_idm%TYPE,
                   p_rowid        gb_common.internal_record_id_type)

Deletes a record.

Parameters
p_person_pidm   General Person PIDM of person involved in this activity. NUMBER(8) Required
p_page_name   This is the Banner Self-Service page name in package.procedure format. VARCHAR2(120) Required
p_old_auth_ind   The value "Y" means the person has authorized the proxy to see the page on their behalf. VARCHAR2(1)
p_new_auth_ind   The value "N" means the person has revoked authorization. VARCHAR2(1)
p_create_user   Username responsible for initial creation. VARCHAR2(30)
p_create_date   Date when the record was initially created. DATE
p_user_id   The ID for the user that most recently updated the record. VARCHAR2(30)
p_proxy_idm   See GPBPRXY. NUMBER(8) Required
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_person_pidm  gprhist.gprhist_person_pidm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_page_name    gprhist.gprhist_page_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_old_auth_ind gprhist.gprhist_old_auth_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_new_auth_ind gprhist.gprhist_new_auth_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_create_user  gprhist.gprhist_create_user%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_create_date  gprhist.gprhist_create_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_user_id      gprhist.gprhist_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_proxy_idm    gprhist.gprhist_proxy_idm%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rowid        gb_common.internal_record_id_type)

Updates a record.

Parameters
p_person_pidm   General Person PIDM of person involved in this activity. NUMBER(8) Required
p_page_name   This is the Banner Self-Service page name in package.procedure format. VARCHAR2(120) Required
p_old_auth_ind   The value "Y" means the person has authorized the proxy to see the page on their behalf. VARCHAR2(1)
p_new_auth_ind   The value "N" means the person has revoked authorization. VARCHAR2(1)
p_create_user   Username responsible for initial creation. VARCHAR2(30)
p_create_date   Date when the record was initially created. DATE
p_user_id   The ID for the user that most recently updated the record. VARCHAR2(30)
p_proxy_idm   See GPBPRXY. NUMBER(8) Required
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)