Search Results get_fk_igs_ru_group_msg

Overview

IGS_RU_NAMED_RULE_GR_PKG belongs to the Oracle E-Business Suite product family commonly identified as IGS (Student Systems / Records and Registration data model) and, more specifically, to the IGS_RU subsystem that supports named rule processing. The package supplies the standard table-handler application programming interface for the IGS_RU_NAMED_RULE_GR entity. This entity stores the group-level definition of named rules, including the group code, the name code, a description, a return type indicator, an internal RU group sequence number, and select and message group flags.

The package is declared with AUTHID CURRENT_USER, so all unqualified object references resolve through the calling user's schema and privileges — in practice, through the APPS synonyms that point to the underlying IGS_RU_NAMED_RULE_GR table. Its API classification is OTHER rather than a public or private user-exit API, indicating that it is intended primarily as internal infrastructure exercised by the owning forms, other IGS packages, and generated code rather than as a documented integration point.

The header comment in the package source references the script IGSUI17S.pls at version 115.6, dated 29-Nov-2002, which places the package within the long-lived IGS code line carried forward into both Oracle EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

The package exposes thirteen documented program units. The core DML procedures are INSERT_ROW, LOCK_ROW, UPDATE_ROW, ADD_ROW, and DELETE_ROW, which together implement the standard Oracle Forms–style row lifecycle for the IGS_RU_NAMED_RULE_GR entity. INSERT_ROW and ADD_ROW create a new group-level named rule definition and return the ROWID of the inserted row; LOCK_ROW acquires and validates a row lock with optimistic locking semantics; UPDATE_ROW and DELETE_ROW modify and remove an existing row identified by its ROWID. The insert, update, and add procedures accept an X_MODE parameter defaulting to 'R'.

GET_PK_FOR_VALIDATION is a Boolean function that validates a candidate primary key combination, taking the group code and name code, so that callers can confirm uniqueness before attempting DML. It is the primary-key counterpart of the foreign-key validation routines.

Five foreign-key validation procedures are provided: GET_FK_IGS_RU_RET_TYPE, GET_FK_IGS_RU_NRG_GROUP_CD, GET_FK_IGS_RU_GROUP_SG, GET_FK_IGS_RU_GROUP_MSG, and GET_FK_IGS_RU_GROUP_SEQ. The procedure named in the user's search, GET_FK_IGS_RU_GROUP_SEQ, validates a supplied sequence number against the IGS_RU_GROUP_SEQ reference entity, ensuring that the RU group sequence referenced by the named rule group actually exists. The sibling routines perform equivalent existence checks against the return type, the NRG group code, and the select-group and message-group references.

CHECK_CONSTRAINTS applies the column-level constraint definitions associated with the entity, accepting an optional column name and value so that Forms can validate a single item or the full row. BEFORE_DML is the internal trigger helper invoked ahead of insert, update, and delete operations to enforce consistent defaults and derived values.

Tables Accessed

The single documented table referenced by this package is IGS_RU_NAMED_RULE_GR, accessed through an APPS synonym. All five DML procedures operate on this table: INSERT_ROW and ADD_ROW write new rows, UPDATE_ROW modifies them, DELETE_ROW removes them, and LOCK_ROW selects the row for update to detect concurrent modification. The validation routines query the table by primary key or by the relevant foreign-key column to confirm that the referenced parent value exists, and CHECK_CONSTRAINTS and BEFORE_DML examine column values in the same table before the DML statement executes.

Usage Notes

The package is referenced by three other packages within the IGS_RU module, which typically call the validation functions and procedures before performing their own DML, and which may delegate row maintenance to INSERT_ROW, UPDATE_ROW, and DELETE_ROW rather than writing to IGS_RU_NAMED_RULE_GR directly. Oracle Forms-based maintenance of named rule groups invokes the package through the standard table-handler pattern: LOCK_ROW on record navigation and query, ADD_ROW or INSERT_ROW on record creation, UPDATE_ROW on save, and DELETE_ROW on record removal, with CHECK_CONSTRAINTS driven by item-level validation triggers. GET_PK_FOR_VALIDATION and the GET_FK_* procedures are typically called from WHEN-VALIDATE-ITEM triggers or from the pre-insert and pre-update processing of the form to enforce referential integrity before the DML is issued.

Because the package is classified as OTHER and is not a published open interface, custom code should prefer the documented entry points only when extending IGS named-rule functionality, and direct DML against IGS_RU_NAMED_RULE_GR should be avoided in favor of these procedures so that locking, constraint checking, and BEFORE_DML logic remain consistent.