Package gb_businessprofile

This package provides the Common Business interface for the Business Profile API, GB_BUSINESSPROFILE

FGAC Business Profile Assignments provide a way to group users with similar responsibilities. After business profile validation codes have been created (they are stored in the GTVFBPR table), the profiles can then be assigned to individual users. A user may be assigned to more than one business profile.
Users may be added or deleted from business profile assignments. The User IDs must be valid in the ALL_USERS table. These are the Oracle IDs for Banner users assigned to the profile.

Business profiles can be assigned to FGAC VBS rules. Business profiles can also be used to simplify assigning PII domains.

FGAC business profile assignments are stored in the GORFBPR table.

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 the key.
f_query_by_rowid	Selects one record using the 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

businessprofile_rec	Entity record type
businessprofile_ref	Entity cursor variable type
businessprofile_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(15) := 'BUSINESSPROFILE';

Business Entity name

businessprofile_rec

TYPE businessprofile_rec IS RECORD (
   r_fgac_user_id            gorfbpr.gorfbpr_fgac_user_id%TYPE,
   r_fbpr_code               gorfbpr.gorfbpr_fbpr_code%TYPE,
   r_user_id                 gorfbpr.gorfbpr_user_id%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

businessprofile_ref

TYPE businessprofile_ref IS REF CURSOR RETURN businessprofile_rec;

Entity cursor variable type

businessprofile_tab

TYPE businessprofile_tab IS TABLE OF businessprofile_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_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                  p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE,
                  p_rowid        VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_fgac_user_id	Oracle ID for the Banner user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required Key

Returns

Y if found, otherwise N.

f_isequal

FUNCTION f_isequal(rec_one businessprofile_rec,
                   rec_two businessprofile_rec) RETURN VARCHAR2

Compares two records for equality.

Parameters

	rec_one	The first record to compare. Defined as type businessprofile_rec.
	rec_two	The second record to compare. Defined as type businessprofile_rec.

Returns

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

f_query_all

FUNCTION f_query_all(p_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                     p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE)
  RETURN businessprofile_ref

Selects all records for the entity.

Parameters

	p_fgac_user_id	Oracle ID for the Banner user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                     p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE)
  RETURN businessprofile_ref

Selects one record using the key.

Parameters

	p_fgac_user_id	Oracle ID for the user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid VARCHAR2) RETURN businessprofile_ref

Selects one record using the 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_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                          p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE,
                          p_rowid        VARCHAR2 DEFAULT NULL)
  RETURN businessprofile_ref

Selects one record and locks it.

Parameters

	p_fgac_user_id	Oracle ID of the user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns

A cursor variable for one record, locking the record.

p_create

PROCEDURE p_create(p_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                   p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE,
                   p_user_id      gorfbpr.gorfbpr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out    OUT VARCHAR2)

Creates a record.

Parameters

	p_fgac_user_id	Oracle ID of the user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required Key
	p_user_id	The Oracle ID of the most recent user to create or update a record. VARCHAR2(30) Required
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                   p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE,
                   p_rowid        VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_fgac_user_id	Oracle ID for the Banner user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18) Required

p_lock

PROCEDURE p_lock(p_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                 p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE,
                 p_rowid_inout  IN OUT VARCHAR2)

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_fgac_user_id	Oracle ID for the Banner user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_fgac_user_id gorfbpr.gorfbpr_fgac_user_id%TYPE,
                   p_fbpr_code    gorfbpr.gorfbpr_fbpr_code%TYPE,
                   p_user_id      gorfbpr.gorfbpr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid        VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters

	p_fgac_user_id	Oracle ID of the Banner user for whom the business profile applies. VARCHAR2(30) Required Key
	p_fbpr_code	FGAC business profile code. VARCHAR2(30) Required Key
	p_user_id	The Oracle ID of the most recent user to create or update a record. VARCHAR2(30) Required
	p_rowid	Database ROWID of record to update. VARCHAR2(18) Required