Package gb_userpiidomains

This package provides the Common Business interface for the USER PII DOMAINS API, gb_userpiidomains.

Fine-Grained Access Personal Identifier Interface domains assigned to a user ID.

This table includes all the PII domain type domains an individual user is authorized to access when PII processing is enabled. If users are authorized for multiple PII domains, the user's home domain will be identified in the FGAC Personal User Defaults table (GORFPUD).

The PII domains that a user has access to will include domains directly assigned to the user as well as domains associated to business profiles assigned to the user.

The Banner user ID (Oracle ID of the Banner user), PII Domain code, Activity Date and User ID must be supplied when creating a PII domain record. An existing PII domain for a user cannot be updated.

There are no restrictions on creating or deleting PII user domains.

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

userpiidomains_rec	Entity record type.
userpiidomains_ref	Entity cursor variable type.
userpiidomains_tab	Entity table type.

Constants

M_ENTITY_NAME

Business Entity name.

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(14) := 'USERPIIDOMAINS';

Business Entity name.

userpiidomains_rec

TYPE userpiidomains_rec IS RECORD (
   r_fgac_user_id            gorfpii.gorfpii_fgac_user_id%TYPE,
   r_fdmn_code_pii           gorfpii.gorfpii_fdmn_code_pii%TYPE,
   r_user_id                 gorfpii.gorfpii_user_id%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type.

userpiidomains_ref

TYPE userpiidomains_ref IS REF CURSOR RETURN userpiidomains_rec;

Entity cursor variable type.

userpiidomains_tab

TYPE userpiidomains_tab IS TABLE OF userpiidomains_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  gorfpii.gorfpii_fgac_user_id%TYPE,
                  p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%TYPE,
                  p_rowid         VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_fgac_user_id	Oracle ID for whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. Required Key
	p_rowid	Database ROWID of record. Optional

Returns

Y if found, otherwise N

f_isequal

FUNCTION f_isequal(rec_one userpiidomains_rec,
                   rec_two userpiidomains_rec) RETURN VARCHAR2

Compares two records for equality.

Parameters

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

Returns

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

f_query_all

FUNCTION f_query_all(p_fgac_user_id  gorfpii.gorfpii_fgac_user_id%TYPE,
                     p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%TYPE)
  RETURN userpiidomains_ref

Selects all records for the entity.

Parameters

	p_fgac_user_id	Oracle ID for whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. Required Key

Returns

A cursor variable that will fetch the set of records

f_query_one

FUNCTION f_query_one(p_fgac_user_id  gorfpii.gorfpii_fgac_user_id%TYPE,
                     p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%TYPE)
  RETURN userpiidomains_ref

Selects one record using key.

Parameters

	p_fgac_user_id	Oracle ID for whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. 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 userpiidomains_ref

Selects one record using ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. Required

Returns

A cursor variable that will fetch exactly one record

f_query_one_lock

FUNCTION f_query_one_lock(p_fgac_user_id  gorfpii.gorfpii_fgac_user_id%TYPE,
                          p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%TYPE,
                          p_rowid         VARCHAR2 DEFAULT NULL)
  RETURN userpiidomains_ref

Selects one record and locks it.

Parameters

	p_fgac_user_id	Oracle ID for whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. Required Key
	p_rowid	Database ROWID of the record to be selected. Optional

Returns

A cursor variable for one record, locking the record

p_create

PROCEDURE p_create(p_fgac_user_id  gorfpii.gorfpii_fgac_user_id%TYPE,
                   p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%TYPE,
                   p_user_id       gorfpii.gorfpii_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out     OUT VARCHAR2)

Creates a record.

Parameters

	p_fgac_user_id	Oracle ID for whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. Required Key
	p_user_id	Oracle ID of the user who created or last updated a record. Optional
	p_rowid_out	Database ROWID of the record to be created. Required

p_delete

PROCEDURE p_delete(p_fgac_user_id  gorfpii.gorfpii_fgac_user_id%TYPE,
                   p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%TYPE,
                   p_rowid         VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_fgac_user_id	Oracle ID for whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. Required Key
	p_rowid	Database ROWID of record to delete. Optional

p_lock

PROCEDURE p_lock(p_fgac_user_id  gorfpii.gorfpii_fgac_user_id%TYPE,
                 p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%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 whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. Required Key
	p_rowid_inout	Database ROWID of record to be locked. Required

p_update

PROCEDURE p_update(p_fgac_user_id  gorfpii.gorfpii_fgac_user_id%TYPE,
                   p_fdmn_code_pii gorfpii.gorfpii_fdmn_code_pii%TYPE,
                   p_user_id       gorfpii.gorfpii_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid         VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters

	p_fgac_user_id	Oracle ID for whom the PII Domains apply. Required Key
	p_fdmn_code_pii	PII domain code for individual. This pertains to the Spriden Restricted functional FGAC domains. Required Key
	p_user_id	Oracle ID of the user who created or last updated a record. Optional
	p_rowid	Database ROWID of record to be updated. Optional