Package gb_domains

This package provides the Common Business interface for the DOMAINS API, gb_domains.

GOBFDMN: (FGAC Domain Code Rules)

The FGAC Domain Code Rules define the driver table associated with each of the domains defined on the GTVFDMN table as well as the associated domain type.

Domains are the central entity in FGAC design.

VBS and PII domain types are supported in Banner FGAC domain rule processing.

Each domain is associated with a domain driver table.

The domain driver table for a VBS domain defines the processing area that will be tied to the VBS predicates.

The domain driver table for PII domains defines the driver table where a PIDM must exist for the user to have access.

A domain must be defined as a PII Type to enable PII processing.

If a PII Domain Code Rule is not enabled, FGAC processing will not validate PII access during execution of the PII driver rules.

System required Domain Code Rules cannot be deleted.

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

domains_rec	Entity record type.
domains_ref	Entity cursor variable type.
domains_tab	Entity table type.

Constants

M_ENTITY_NAME

Business Entity name.

M_ENTITY_NAME

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

Business Entity name.

domains_rec

TYPE domains_rec IS RECORD (
   r_fdmn_code               gobfdmn.gobfdmn_fdmn_code%TYPE,
   r_table_name              gobfdmn.gobfdmn_table_name%TYPE,
   r_fdtp_code               gobfdmn.gobfdmn_fdtp_code%TYPE,
   r_sys_req_ind             gobfdmn.gobfdmn_sys_req_ind%TYPE,
   r_enable_pii_ind          gobfdmn.gobfdmn_enable_pii_ind%TYPE,
   r_user_id                 gobfdmn.gobfdmn_user_id%TYPE,
   r_pii_column_name         gobfdmn.gobfdmn_pii_column_name%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type.

domains_ref

TYPE domains_ref IS REF CURSOR RETURN domains_rec;

Entity cursor variable type.

domains_tab

TYPE domains_tab IS TABLE OF domains_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_fdmn_code gobfdmn.gobfdmn_fdmn_code%TYPE,
                  p_rowid     VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_fdmn_code	FGAC Domain code. VARCHAR2(30). Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR(18). Optional

Returns

Y if found, otherwise N.

f_isequal

FUNCTION f_isequal(rec_one domains_rec,
                   rec_two domains_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 domains_rec. Required
	rec_two	The second record to compare. Type domains_rec. Required

Returns

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

f_query_all

FUNCTION f_query_all(p_fdmn_code gobfdmn.gobfdmn_fdmn_code%TYPE)
  RETURN domains_ref

Selects all records for the entity.

Parameters

p_fdmn_code

FGAC Domain code. VARCHAR2(30). Required Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_fdmn_code gobfdmn.gobfdmn_fdmn_code%TYPE)
  RETURN domains_ref

Selects one record using the key.

Parameters

p_fdmn_code

FGAC Domain 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 domains_ref

Selects one record using the ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR(18). Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

FUNCTION f_query_one_lock(p_fdmn_code gobfdmn.gobfdmn_fdmn_code%TYPE,
                          p_rowid     VARCHAR2 DEFAULT NULL)
  RETURN domains_ref

Selects one record and locks it.

Parameters

	p_fdmn_code	FGAC Domain code. VARCHAR2(30). Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR(18). Optional

Returns

A cursor variable for one record, locking the record.

p_create

PROCEDURE p_create(p_fdmn_code       gobfdmn.gobfdmn_fdmn_code%TYPE,
                   p_table_name      gobfdmn.gobfdmn_table_name%TYPE,
                   p_fdtp_code       gobfdmn.gobfdmn_fdtp_code%TYPE,
                   p_sys_req_ind     gobfdmn.gobfdmn_sys_req_ind%TYPE DEFAULT 'N',
                   p_enable_pii_ind  gobfdmn.gobfdmn_enable_pii_ind%TYPE DEFAULT 'N',
                   p_user_id         gobfdmn.gobfdmn_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_pii_column_name gobfdmn.gobfdmn_pii_column_name%TYPE DEFAULT NULL,
                   p_rowid_out       OUT VARCHAR2)

Creates a record.

Parameters

p_fdmn_code

FGAC Domain code. VARCHAR2(30). Required Key

p_table_name

Table name that is the driver for the FGAC domain. VARCHAR2(30). Required

p_fdtp_code

FGAC Domain type code. VARCHAR2(5). Required

p_sys_req_ind

System required indicator. VARCHAR2(1). Required

	Y	Data is system required
	N	Data is not system required

p_enable_pii_ind

Enable the PII domain indicator. VARCHAR2(1). Required

	Y	Enable the PII domain
	N	Do not enable the PII domain

p_user_id

Oracle ID of the user who created or last updated a record. VARCHAR2(30). Optional

p_pii_column_name

Column name the PII process will use to match PIDM values to the driver table. VARCHAR2(30). Optional

p_rowid_out

Database ROWID of the record to be created. VARCHAR(18). Required

p_delete

PROCEDURE p_delete(p_fdmn_code gobfdmn.gobfdmn_fdmn_code%TYPE,
                   p_rowid     VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_fdmn_code	FGAC Domain code. VARCHAR2(30). Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR(18). Optional

p_lock

PROCEDURE p_lock(p_fdmn_code   gobfdmn.gobfdmn_fdmn_code%TYPE,
                 p_rowid_inout IN OUT VARCHAR2)

Locks a record.
If the 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_fdmn_code	FGAC Domain code. VARCHAR2(30). Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR(18). Required

p_update

PROCEDURE p_update(p_fdmn_code       gobfdmn.gobfdmn_fdmn_code%TYPE,
                   p_table_name      gobfdmn.gobfdmn_table_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fdtp_code       gobfdmn.gobfdmn_fdtp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sys_req_ind     gobfdmn.gobfdmn_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_enable_pii_ind  gobfdmn.gobfdmn_enable_pii_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         gobfdmn.gobfdmn_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_pii_column_name gobfdmn.gobfdmn_pii_column_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters

p_fdmn_code

FGAC Domain code. VARCHAR2(30). Required Key

p_table_name

Table name that is the driver for the FGAC domain. VARCHAR2(30). Required

p_fdtp_code

FGAC Domain type code. VARCHAR2(5). Required

p_sys_req_ind

System required indicator. VARCHAR2(1). Required

	Y	Data is system required
	N	Data is not system required

p_enable_pii_ind

Enable the PII domain indicator. VARCHAR2(1). Required

	Y	Enable the PII domain
	N	Do not enable the PII domain

p_user_id

Oracle ID of the user who created or last updated a record. VARCHAR2(30). Optional

p_pii_column_name

Column name the PII process will use to match PIDM values to the driver table. VARCHAR2(30). Optional

p_rowid

Database ROWID of the record to be updated. VARCHAR(18). Optional