Package gb_displaycolumns

This package provides the Common Business interface for the DISPLAY COLUMNS API, gb_displaycolumns.

GORDMCL: (Data Display Mask Column Rules)

The Data Display Mask Column rules define the data items (columns) that can be masked in Banner forms.

The rules identify the object name and block name for each data item.

This is to support the protection of sensitive and personally identifiable information (PII), such as ID and birthdate, as needed on Banner forms.

The object, block and item (column) names are required, as well as data type, data length, system required indicator, activity date and User ID.

The object name is validated against Object Maintenance (GUAOBJS).

Lists are available for block name (ALL_TABLES) and item name (ALL_TAB_COLUMNS), however, the fields are not validated.

The Form Item Data Queried Into field is used to identify the specific form field that will be reformatted for display to end users.

The format mask procedure will use the Data Display Mask Rules (GORDMSK) to replace the actual values.

The Numeric Precision (number of digits) can only be specified for numeric items (columns).

System required records cannot be updated or deleted.

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a record exists.
f_isequal	Compares two display column records for equality.
f_query_all	Selects display column records.
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

displaycolumns_rec	Business Entity record type.
displaycolumns_ref	Entity cursor variable type.
displaycolumns_tab	Entity table type.

Constants

M_ENTITY_NAME

Business Entity name.

M_ENTITY_NAME

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

Business Entity name.

displaycolumns_rec

TYPE displaycolumns_rec IS RECORD (
   r_objs_code               gordmcl.gordmcl_objs_code%TYPE,
   r_block_name              gordmcl.gordmcl_block_name%TYPE,
   r_column_name             gordmcl.gordmcl_column_name%TYPE,
   r_sys_req_ind             gordmcl.gordmcl_sys_req_ind%TYPE,
   r_data_type_cde           gordmcl.gordmcl_data_type_cde%TYPE,
   r_data_length             gordmcl.gordmcl_data_length%TYPE,
   r_user_id                 gordmcl.gordmcl_user_id%TYPE,
   r_query_column            gordmcl.gordmcl_query_column%TYPE,
   r_numeric_precision       gordmcl.gordmcl_numeric_precision%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type.

displaycolumns_ref

TYPE displaycolumns_ref IS REF CURSOR RETURN displaycolumns_rec;

Entity cursor variable type.

displaycolumns_tab

TYPE displaycolumns_tab IS TABLE OF displaycolumns_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_objs_code   gordmcl.gordmcl_objs_code%TYPE,
                  p_block_name  gordmcl.gordmcl_block_name%TYPE DEFAULT NULL,
                  p_column_name gordmcl.gordmcl_column_name%TYPE DEFAULT NULL,
                  p_rowid       VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Optional Key
	p_column_name	Column Name. VARCHAR2(30). Optional Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18). Optional

Returns

Y if found, otherwise N.

f_isequal

FUNCTION f_isequal(rec_one displaycolumns_rec,
                   rec_two displaycolumns_rec) RETURN VARCHAR2

Compares two display column 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 displaycolumns_rec. Required
	rec_two	The second record to compare. Type displaycolumns_rec. Required

Returns

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

f_query_all

FUNCTION f_query_all(p_objs_code   gordmcl.gordmcl_objs_code%TYPE,
                     p_block_name  gordmcl.gordmcl_block_name%TYPE DEFAULT NULL,
                     p_column_name gordmcl.gordmcl_column_name%TYPE DEFAULT NULL)
  RETURN displaycolumns_ref

Selects display column records.

Parameters

	p_objs_code	Object which thedisplay rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Optional Key
	p_column_name	Column Name. VARCHAR2(30). Optional Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_objs_code   gordmcl.gordmcl_objs_code%TYPE,
                     p_block_name  gordmcl.gordmcl_block_name%TYPE,
                     p_column_name gordmcl.gordmcl_column_name%TYPE)
  RETURN displaycolumns_ref

Selects one record using the key.

Parameters

	p_objs_code	Object which thedisplay rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. 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 displaycolumns_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_objs_code   gordmcl.gordmcl_objs_code%TYPE,
                          p_block_name  gordmcl.gordmcl_block_name%TYPE,
                          p_column_name gordmcl.gordmcl_column_name%TYPE,
                          p_rowid       VARCHAR2 DEFAULT NULL)
  RETURN displaycolumns_ref

Selects one record and locks it.

Parameters

	p_objs_code	Object which thedisplay rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18). Optional

Returns

A cursor variable for one record, locking the record.

p_create

PROCEDURE p_create(p_objs_code         gordmcl.gordmcl_objs_code%TYPE,
                   p_block_name        gordmcl.gordmcl_block_name%TYPE,
                   p_column_name       gordmcl.gordmcl_column_name%TYPE,
                   p_sys_req_ind       gordmcl.gordmcl_sys_req_ind%TYPE,
                   p_data_type_cde     gordmcl.gordmcl_data_type_cde%TYPE,
                   p_data_length       gordmcl.gordmcl_data_length%TYPE,
                   p_user_id           gordmcl.gordmcl_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_query_column      gordmcl.gordmcl_query_column%TYPE DEFAULT NULL,
                   p_numeric_precision gordmcl.gordmcl_numeric_precision%TYPE DEFAULT NULL,
                   p_rowid_out         OUT VARCHAR2)

Creates a record.

Parameters

p_objs_code

Object which the display rules will be applied to. VARCHAR2(30). Required Key

p_block_name

Block Name. VARCHAR2(30). Required Key

p_column_name

Column Name. VARCHAR2(30). Required Key

p_sys_req_ind

System required indicator. VARCHAR2(1). Required

	Y	Data is required for the system
	N	Data is not required for the system

p_data_type_cde

Value to indicate the type of data. VARCHAR2(1). Required

	C	Character
	N	Numeric
	D	Date

p_data_length

Length of the item. NUMBER(3). Required

p_user_id

The most recent user to create or update a record. VARCHAR2(30). Optional

p_query_column

Column name that has the data that will be reformatted. This is used only if the column to be reformatted is a text field. The format mask procedure will actually replace values and assign the reformatted data to the field specified in gordmsk_column_name. VARCHAR2(30). Optional

p_numeric_precision

Number of digits allowed if the item is a numeric data type. NUMBER(3). Optional

p_rowid_out

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

p_delete

PROCEDURE p_delete(p_objs_code   gordmcl.gordmcl_objs_code%TYPE,
                   p_block_name  gordmcl.gordmcl_block_name%TYPE,
                   p_column_name gordmcl.gordmcl_column_name%TYPE,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18). Optional

p_lock

PROCEDURE p_lock(p_objs_code   gordmcl.gordmcl_objs_code%TYPE,
                 p_block_name  gordmcl.gordmcl_block_name%TYPE,
                 p_column_name gordmcl.gordmcl_column_name%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_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18). Required

p_update

PROCEDURE p_update(p_objs_code         gordmcl.gordmcl_objs_code%TYPE,
                   p_block_name        gordmcl.gordmcl_block_name%TYPE,
                   p_column_name       gordmcl.gordmcl_column_name%TYPE,
                   p_sys_req_ind       gordmcl.gordmcl_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_type_cde     gordmcl.gordmcl_data_type_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_length       gordmcl.gordmcl_data_length%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id           gordmcl.gordmcl_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_query_column      gordmcl.gordmcl_query_column%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_numeric_precision gordmcl.gordmcl_numeric_precision%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rowid             VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters

p_objs_code

Object which the display rules will be applied to. VARCHAR2(30). Required Key

p_block_name

Block Name. VARCHAR2(30). Required Key

p_column_name

Column Name. VARCHAR2(30). Required Key

p_sys_req_ind

System required indicator. VARCHAR2(1). Required

	Y	Data is required for the system
	N	Data is not required for the system

p_data_type_cde

Value to indicate the type of data. VARCHAR2(1). Required

	C	Character
	N	Numeric
	D	Date

p_data_length

Length of the item. NUMBER(3). Required

p_user_id

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

p_query_column

p_numeric_precision

Number of digits allowed if the item is a numeric data type. NUMBER(3). Optional

p_rowid

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