Package gb_institution

Package gb_institution_role

Common Business interface for the INSTITUTION_ROLE API (gb_institution_role).

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 a pidm and role group.
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.
p_maintain_roles	Calculates roles for a person and adds/deletes rows from database to reflect latest roles.

Types

institution_role_rec	Business Entity record type
institution_role_ref	Entity cursor variable type
institution_role_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(16) := 'INSTITUTION_ROLE';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

institution_role_rec

TYPE institution_role_rec IS RECORD (
  r_pidm                    gorirol.gorirol_pidm%TYPE,
  r_role_group              gorirol.gorirol_role_group%TYPE,
  r_role                    gorirol.gorirol_role%TYPE,
  r_user_id                 gorirol.gorirol_user_id%TYPE,
  r_vpdi_code               gorirol.gorirol_vpdi_code%TYPE,
  r_data_origin             gorirol.gorirol_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

institution_role_ref

TYPE institution_role_ref IS REF CURSOR RETURN institution_role_rec;

Entity cursor variable type

institution_role_tab

TYPE institution_role_tab IS TABLE OF institution_role_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       gorirol.gorirol_pidm%TYPE,
                  p_role_group gorirol.gorirol_role_group%TYPE,
                  p_role       gorirol.gorirol_role%TYPE,
                  p_vpdi_code  gorirol.gorirol_vpdi_code%TYPE DEFAULT NULL,
                  p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30) Required Key
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)
	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 institution_role_rec,
                   rec_two institution_role_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 institution_role_rec Required
	rec_two	The second record to compare. Type institution_role_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       gorirol.gorirol_pidm%TYPE,
                     p_role_group gorirol.gorirol_role_group%TYPE,
                     p_vpdi_code  gorirol.gorirol_vpdi_code%TYPE := NULL)
  RETURN institution_role_ref

Selects all records for a pidm and role group.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm       gorirol.gorirol_pidm%TYPE,
                     p_role_group gorirol.gorirol_role_group%TYPE,
                     p_role       gorirol.gorirol_role%TYPE,
                     p_vpdi_code  gorirol.gorirol_vpdi_code%TYPE := NULL)
  RETURN institution_role_ref

Selects one record using key.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30) Required Key
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)

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 institution_role_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_pidm       gorirol.gorirol_pidm%TYPE,
                          p_role_group gorirol.gorirol_role_group%TYPE,
                          p_role       gorirol.gorirol_role%TYPE,
                          p_vpdi_code  gorirol.gorirol_vpdi_code%TYPE := NULL,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN institution_role_ref

Selects one record and locks it.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30) Required Key
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)
	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_pidm        gorirol.gorirol_pidm%TYPE,
                   p_role_group  gorirol.gorirol_role_group%TYPE,
                   p_role        gorirol.gorirol_role%TYPE,
                   p_user_id     gorirol.gorirol_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_vpdi_code   gorirol.gorirol_vpdi_code%TYPE DEFAULT NULL,
                   p_data_origin gorirol.gorirol_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30) Required Key
	p_user_id	The unique identification of the user. VARCHAR2(30) Required
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm       gorirol.gorirol_pidm%TYPE,
                   p_role_group gorirol.gorirol_role_group%TYPE,
                   p_role       gorirol.gorirol_role%TYPE,
                   p_vpdi_code  gorirol.gorirol_vpdi_code%TYPE DEFAULT NULL,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30) Required Key
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_pidm        gorirol.gorirol_pidm%TYPE,
                 p_role_group  gorirol.gorirol_role_group%TYPE,
                 p_role        gorirol.gorirol_role%TYPE,
                 p_vpdi_code   gorirol.gorirol_vpdi_code%TYPE DEFAULT NULL,
                 p_rowid_inout IN OUT 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_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30) Required Key
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_pidm        gorirol.gorirol_pidm%TYPE,
                   p_role_group  gorirol.gorirol_role_group%TYPE,
                   p_role        gorirol.gorirol_role%TYPE,
                   p_user_id     gorirol.gorirol_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_vpdi_code   gorirol.gorirol_vpdi_code%TYPE DEFAULT NULL,
                   p_data_origin gorirol.gorirol_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30) Required Key
	p_user_id	The unique identification of the user. VARCHAR2(30) Required
	p_vpdi_code	Institution Codes for the Banner System. VARCHAR2(6)
	p_data_origin	Source system that created or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)

p_maintain_roles

PROCEDURE p_maintain_roles(p_pidm       IN gorirol.gorirol_pidm%TYPE,
                           p_role_group IN gorirol.gorirol_role_group%TYPE,
                           p_role       IN gorirol.gorirol_role%TYPE := NULL)

Calculates roles for a person and adds/deletes rows from database to reflect latest roles.

Parameters

	p_pidm	NUMBER(8) Required Key
	p_role_group	VARCHAR2(30) Required Key
	p_role	Institution Role name. VARCHAR2(30)