Search Results get_ufk_igs_fi_fee_as_rate




Overview
Explore in AI Chat

Overview

The IGS_FI_ELM_RANGE_RT_PKG package is an Oracle E-Business Suite PL/SQL API belonging to the Student Systems / Financial Aid family of modules within the IGS (Student Systems) schema. Its central responsibility is the maintenance of records in the IGS_FI_ELM_RANGE_RT entity, which stores the range and rate definitions associated with fee assessment. In the Financial Aid and Fee rules engine, fee types are broken down into ranges (for example, bands of income, grade levels, or calculated amounts), and each range carries an associated rate value. This package provides the standard DML wrapper routines, unique-key validation functions, and constraint-checking utilities that guard those records against invalid inserts, updates, and deletes.

The package is declared with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than the definer, and it is owned by APPS. The header identifies the source file as IGSSI67S.pls, version 115.3, last modified in November 2002, indicating that the same API has remained stable across the EBS 11i, 12.1.1, and 12.2.2 releases.

Key Procedures and Functions

  • INSERT_ROW — Inserts a new range/rate row, populating the surrogate key through X_ROWID and accepting the fee type, calendar type, calendar instance sequence, relationship type, range number, rate number, creation date, fee category, and logical delete date. The X_MODE parameter defaults to 'R'.
  • LOCK_ROW — Issues a locking read against an existing row identified by X_ROWID, used to serialize concurrent modifications.
  • UPDATE_ROW — Updates the mutable attributes of an existing range/rate record identified by X_ROWID.
  • ADD_ROW — Convenience routine that combines insert-or-update behavior, returning the affected X_ROWID and X_ERR_ID.
  • DELETE_ROW — Removes the row identified by X_ROWID.
  • GET_PK_FOR_VALIDATION — Validates the primary key, returning a BOOLEAN result based on the supplied error ID.
  • CHECK_CONSTRAINTS — Generic constraint checker that accepts an optional column name and value.
  • GET_UK1_FOR_Validation / GET_UK2_FOR_Validation — Validate the two unique alternate keys defined on the range/rate table.
  • BEFORE_DML — Internal trigger-style routine executed prior to DML to enforce auditing and defaulting.
  • GET_UFK_IGS_FI_ELM_RANGE — Resolves the user-friendly key for a range record.
  • GET_UFK_IGS_FI_FEE_AS_RATE — Resolves the user-friendly key for the fee-assessment rate identity. This is the function most commonly searched by developers troubleshooting fee-rate lookups, and it is typically called to translate a surrogate key into the human-readable combination of fee type, calendar, range, and rate.

Tables Accessed

  • IGS_FI_ELM_RANGE_RT — The primary table holding fee element range and rate rows. All insert, lock, update, delete, and validation work targets this entity.
  • IGS_FI_ELM_RANGE_RT_ERR_ID_S — The sequence object used to generate surrogate error identifiers consumed by the X_ERR_ID parameters.
  • DUAL — Used for single-row arithmetic and sequence probes.

Usage Notes

The package is normally invoked indirectly rather than called by end users. Oracle Forms built on the Fee element range/rate block call these APIs during commit processing, where INSERT_ROW, UPDATE_ROW, LOCK_ROW, DELETE_ROW, and the GET_UFK validation functions operate behind the form's block-level triggers. Concurrent programs that mass-load or migrate fee range and rate data also reference the package. The metadata notes that four other packages depend on it, confirming its role as a shared service API. Custom extensions should follow the same pattern: obtain a rowid, call ADD_ROW or INSERT_ROW, perform validation through GET_PK_FOR_VALIDATION and the unique-key validators, and allow BEFORE_DML to enforce auditing defaults before committing.