Package sb_pagefieldconfig

BANINST1@S10B80

Common Business interface for the Page And Field Configuration API (sb_pagefieldconfig).

Program units

f_api_version	Returns the API version number.
f_exists	Checks if a record exists.
f_display_number_exists	Checks if a display_number already exists for a term, persona, page.
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

pagefieldconfig_rec	Business Entity record type
pagefieldconfig_ref	Entity cursor variable type
pagefieldconfig_tab	Entity table type

Constants

M_ENTITY_NAME	Business Entity Name
M_BASE_TABLE_NAME	Base table name

M_ENTITY_NAME

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

Business Entity Name

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'SORWSCR';

Base table name

pagefieldconfig_rec

TYPE pagefieldconfig_rec IS RECORD (
  r_wspg_code               sorwscr.sorwscr_wspg_code%TYPE,
  r_wsfd_code               sorwscr.sorwscr_wsfd_code%TYPE,
  r_term_code_eff           sorwscr.sorwscr_term_code_eff%TYPE,
  r_persona_cde             sorwscr.sorwscr_persona_cde%TYPE,
  r_system_req_ind          sorwscr.sorwscr_system_req_ind%TYPE,
  r_required_ind            sorwscr.sorwscr_required_ind%TYPE,
  r_display_ind             sorwscr.sorwscr_display_ind%TYPE,
  r_display_number          sorwscr.sorwscr_display_number%TYPE,
  r_display_text            sorwscr.sorwscr_display_text%TYPE,
  r_user_id                 sorwscr.sorwscr_user_id%TYPE,
  r_data_origin             sorwscr.sorwscr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

pagefieldconfig_ref

TYPE pagefieldconfig_ref IS REF CURSOR RETURN pagefieldconfig_rec;

Entity cursor variable type

pagefieldconfig_tab

TYPE pagefieldconfig_tab IS TABLE OF pagefieldconfig_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_wspg_code     sorwscr.sorwscr_wspg_code%TYPE,
                  p_term_code_eff sorwscr.sorwscr_term_code_eff%TYPE,
                  p_persona_cde   sorwscr.sorwscr_persona_cde%TYPE,
                  p_wsfd_code     sorwscr.sorwscr_wsfd_code%TYPE,
                  p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_wsfd_code	Code used to identify the page field configured. VARCHAR2(10) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_display_number_exists

Function f_display_number_exists(p_wspg_code      sorwscr.sorwscr_wspg_code%TYPE,
                                 p_term_code_eff  sorwscr.sorwscr_term_code_eff%TYPE,
                                 p_persona_cde    sorwscr.sorwscr_persona_cde%TYPE,
                                 p_display_number sorwscr.sorwscr_display_number%TYPE)
  RETURN VARCHAR2

Checks if a display_number already exists for a term, persona, page.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable.
	p_display_number	The display number to look for.

Returns

Y if found, otherwise N.

f_isequal

Function f_isequal(rec_one pagefieldconfig_rec,
                   rec_two pagefieldconfig_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 pagefieldconfig_rec Required
	rec_two	The second record to compare. Type pagefieldconfig_rec Required

Returns

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

f_query_all

Function f_query_all(p_wspg_code     sorwscr.sorwscr_wspg_code%TYPE,
                     p_term_code_eff sorwscr.sorwscr_term_code_eff%TYPE,
                     p_persona_cde   sorwscr.sorwscr_persona_cde%TYPE,
                     p_wsfd_code     sorwscr.sorwscr_wsfd_code%TYPE)
  RETURN pagefieldconfig_ref

Selects all records for the entity.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_wsfd_code	Code used to identify the registration page field configured. VARCHAR2(10) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_wspg_code     sorwscr.sorwscr_wspg_code%TYPE,
                     p_term_code_eff sorwscr.sorwscr_term_code_eff%TYPE,
                     p_persona_cde   sorwscr.sorwscr_persona_cde%TYPE,
                     p_wsfd_code     sorwscr.sorwscr_wsfd_code%TYPE)
  RETURN pagefieldconfig_ref

Selects one record using key.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_wsfd_code	Code used to identify the registration page field configured. VARCHAR2(10) Required Key

Returns

A cursor variable that will fetch exactly one record.

f_query_by_rowid

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN pagefieldconfig_ref

Selects one record using 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_wspg_code     sorwscr.sorwscr_wspg_code%TYPE,
                          p_term_code_eff sorwscr.sorwscr_term_code_eff%TYPE,
                          p_persona_cde   sorwscr.sorwscr_persona_cde%TYPE,
                          p_wsfd_code     sorwscr.sorwscr_wsfd_code%TYPE,
                          p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN pagefieldconfig_ref

Selects one record and locks it.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_wsfd_code	Code used to identify the page field configured. VARCHAR2(10) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

p_create

Procedure p_create(p_wspg_code      sorwscr.sorwscr_wspg_code%TYPE,
                   p_wsfd_code      sorwscr.sorwscr_wsfd_code%TYPE,
                   p_term_code_eff  sorwscr.sorwscr_term_code_eff%TYPE,
                   p_persona_cde    sorwscr.sorwscr_persona_cde%TYPE,
                   p_system_req_ind sorwscr.sorwscr_system_req_ind%TYPE,
                   p_required_ind   sorwscr.sorwscr_required_ind%TYPE,
                   p_display_ind    sorwscr.sorwscr_display_ind%TYPE,
                   p_display_number sorwscr.sorwscr_display_number%TYPE DEFAULT NULL,
                   p_display_text   sorwscr.sorwscr_display_text%TYPE DEFAULT NULL,
                   p_user_id        sorwscr.sorwscr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    sorwscr.sorwscr_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_wsfd_code	Code used to identify the age field configured. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_system_req_ind	Indicates if this is a system required record. Valid values are (Y)es or (N)o. VARCHAR2(1) Required
	p_required_ind	Indicates if the field is required to be displayed. Valid values are (Y)es or (N)o. VARCHAR2(1) Required
	p_display_ind	Indicates if the field is displayed. Valid values are (Y)es or (N)o. VARCHAR2(1) Required
	p_display_number	The order that the field displays on the page. NUMBER(4)
	p_display_text	The text to display as the label for the field on the page. VARCHAR2(60) Optional
	p_user_id	The user ID of the person who inserted or last updated this record. VARCHAR2(30)
	p_data_origin	Source system that created or updated the data. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_wspg_code     sorwscr.sorwscr_wspg_code%TYPE,
                   p_term_code_eff sorwscr.sorwscr_term_code_eff%TYPE,
                   p_persona_cde   sorwscr.sorwscr_persona_cde%TYPE,
                   p_wsfd_code     sorwscr.sorwscr_wsfd_code%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_wsfd_code	Code used to identify the page field configured. VARCHAR2(10) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_wspg_code     sorwscr.sorwscr_wspg_code%TYPE,
                 p_term_code_eff sorwscr.sorwscr_term_code_eff%TYPE,
                 p_persona_cde   sorwscr.sorwscr_persona_cde%TYPE,
                 p_wsfd_code     sorwscr.sorwscr_wsfd_code%TYPE,
                 p_rowid_inout   IN OUT gb_common.internal_record_id_type)

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_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_wsfd_code	Code used to identify the page field configured. VARCHAR2(10) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_wspg_code      sorwscr.sorwscr_wspg_code%TYPE,
                   p_wsfd_code      sorwscr.sorwscr_wsfd_code%TYPE,
                   p_term_code_eff  sorwscr.sorwscr_term_code_eff%TYPE,
                   p_persona_cde    sorwscr.sorwscr_persona_cde%TYPE,
                   p_system_req_ind sorwscr.sorwscr_system_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_required_ind   sorwscr.sorwscr_required_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_display_ind    sorwscr.sorwscr_display_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_display_number sorwscr.sorwscr_display_number%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_display_text   sorwscr.sorwscr_display_text%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id        sorwscr.sorwscr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    sorwscr.sorwscr_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_wspg_code	Code used to identify the page/panel that the configuration is applicable to. VARCHAR2(10) Required Key
	p_wsfd_code	Code used to identify the page field configured. VARCHAR2(10) Required Key
	p_term_code_eff	The term this configuration becomes effective. VARCHAR2(6) Required Key
	p_persona_cde	The persona to which this configuration is applicable. Valid values are: 01=Anonymous, 02=Student, 03=Faculty, 04=Admin. VARCHAR2(2) Required Key
	p_system_req_ind	Indicates if this is a system required record. Valid values are (Y)es or (N)o. VARCHAR2(1) Required
	p_required_ind	Indicates if the field is required to be displayed. Valid values are (Y)es or (N)o. VARCHAR2(1) Required
	p_display_ind	Indicates if the field is displayed. Valid values are (Y)es or (N)o. VARCHAR2(1) Required
	p_display_number	The order that the field displays on the page. NUMBER(4)
	p_display_text	The text to display as the label for the field on the page. VARCHAR2(60) Optional
	p_user_id	The user ID of the person who inserted or last updated this record. VARCHAR2(30)
	p_data_origin	Source system that created or updated the data. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)