Package gb_domaintype

This package provides the Common Business interface for the DOMAIN TYPE API, gb_domaintype.

GOBFDTP: (FGAC Domain Type Predicate Rule Table)

The FGAC Domain Type predicate rule defines the predicate requirements for each domain type.

The currently supported domain types are PII and VBS.

VBS domain types require the entry of a user-defined SQL predicate.

If a predicate is required, the checkbox is checked (value of 'Y').

If a predicate is not required, the checkbox is unchecked (value of 'N'), and only the domain types that require a predicate (VBS) can be entered in the FGAC Group Access Rules Table (GOBFGAC).

PII domain types execute without additional user-defined predicates.

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists.
f_isequal	Compare 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

domaintype_rec	Entity record type.
domaintype_ref	Entity cursor variable type.
domaintype_tab	Entity table type.

Constants

M_ENTITY_NAME

Business Entity name.

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(10) := 'DOMAINTYPE';

Business Entity name.

domaintype_rec

TYPE domaintype_rec IS RECORD (
   r_fdtp_code               gobfdtp.gobfdtp_fdtp_code%TYPE,
   r_predicate_ind           gobfdtp.gobfdtp_predicate_ind%TYPE,
   r_sys_req_ind             gobfdtp.gobfdtp_sys_req_ind%TYPE,
   r_user_id                 gobfdtp.gobfdtp_user_id%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type.

domaintype_ref

TYPE domaintype_ref IS REF CURSOR RETURN domaintype_rec;

Entity cursor variable type.

domaintype_tab

TYPE domaintype_tab IS TABLE OF domaintype_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_fdtp_code gobfdtp.gobfdtp_fdtp_code%TYPE,
                  p_rowid     VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_fdtp_code	FGAC Domain type code. Required
	p_rowid	Database ROWID of the record to be selected. Optional

Returns

Y if found, otherwise N

f_isequal

FUNCTION f_isequal(rec_one domaintype_rec,
                   rec_two domaintype_rec) RETURN VARCHAR2

Compare two records for equality.

Parameters

	rec_one	The first record to compare. Required
	rec_two	The second record to compare. Required

Returns

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

f_query_all

FUNCTION f_query_all(p_fdtp_code gobfdtp.gobfdtp_fdtp_code%TYPE)
  RETURN domaintype_ref

Selects all records for the entity.

Parameters

p_fdtp_code

FGAC Domain type code. Required Key

Returns

A cursor variable that will fetch the set of records

f_query_one

FUNCTION f_query_one(p_fdtp_code gobfdtp.gobfdtp_fdtp_code%TYPE)
  RETURN domaintype_ref

Selects one record using the key.

Parameters

p_fdtp_code

FGAC Domain type code. 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 domaintype_ref

Selects one record using the 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_fdtp_code gobfdtp.gobfdtp_fdtp_code%TYPE,
                          p_rowid     VARCHAR2 DEFAULT NULL)
  RETURN domaintype_ref

Selects one record and locks it.

Parameters

	p_fdtp_code	FGAC Domain type code. 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_fdtp_code     gobfdtp.gobfdtp_fdtp_code%TYPE,
                   p_predicate_ind gobfdtp.gobfdtp_predicate_ind%TYPE,
                   p_sys_req_ind   gobfdtp.gobfdtp_sys_req_ind%TYPE,
                   p_user_id       gobfdtp.gobfdtp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out     OUT VARCHAR2)

Creates a record.

Parameters

p_fdtp_code

FGAC Domain type code. Required Key

p_predicate_ind

Predicate Indicator. Required

	Y	Predicate is required for the domain type
	N	Predicate is not required for the domain type

p_sys_req_ind

Indicates whether or not this type is system required. Required

	Y	Required for the system
	N	Not required for the system

p_user_id

Oracle ID of the user who created or last updated the record. Optional

p_rowid_out

Database ROWID of the record that was created. Required

p_delete

PROCEDURE p_delete(p_fdtp_code gobfdtp.gobfdtp_fdtp_code%TYPE,
                   p_rowid     VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_fdtp_code	FGAC Domain type code. Required Key
	p_rowid	Database ROWID of the record to be deleted. Optional

p_lock

PROCEDURE p_lock(p_fdtp_code   gobfdtp.gobfdtp_fdtp_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_fdtp_code	FGAC Domain type code. Required Key
	p_rowid_inout	Database ROWID of the record to be locked. Required

p_update

PROCEDURE p_update(p_fdtp_code     gobfdtp.gobfdtp_fdtp_code%TYPE,
                   p_predicate_ind gobfdtp.gobfdtp_predicate_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sys_req_ind   gobfdtp.gobfdtp_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id       gobfdtp.gobfdtp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid         VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters

p_fdtp_code

FGAC Domain type code. Required Key

p_predicate_ind

Predicate Indicator. Optional

	Y	Predicate is required for the domain type
	N	Predicate is not required for the domain type

p_sys_req_ind

Indicates whether or not this type is system required. Optional

	Y	Required for system
	N	Not required for system

p_user_id

Oracle ID of the user who created or last updated the record. Optional

p_rowid

Database ROWID of the record to be updated. Optional