Search Results igs_az_students_pkg




Overview
Explore in AI Chat

Overview

IGS_AZ_STUDENTS_PKG is a PL/SQL package owned by the APPS schema within the Oracle E-Business Suite, classified under the ETRM "OTHER" API category. It belongs to the IGS (Student System) product family, and its naming and header footprint (IGSHI02S.pls, dated 2003) place it within the older student administration/data-model generation of the Student System schema. The package provides the canonical data-access layer over the IGS_AZ_STUDENTS entity and its shadow/audit counterpart IGS_AZ_STUDENTS_S, encapsulating the standard insert, update, delete, lock, and validation logic that would otherwise be duplicated across forms and batch processes. Declared AUTHID CURRENT_USER, the package executes with the privileges of the invoking session and is intended to be called by other application code rather than invoked directly by end users.

Key Procedures and Functions

The package exposes nine documented program units. They follow the conventional Oracle Forms-generated table-handler pattern, where each DML verb is paired with validation and lock helpers:

  • INSERT_ROW — Performs a direct insert into the base table, accepting the full column set (including GROUP_STUDENT_ID, GROUP_NAME, STUDENT_PERSON_ID, date ranges, advising hold attributes, and the ACCEPT_ADD_FLAG / ACCEPT_DELETE_FLAG indicators) and returning an out ROWID plus standardized RETURN_STATUS, MSG_DATA, and MSG_COUNT diagnostics.
  • UPDATE_ROW — Applies modifications to an existing row identified by ROWID, with the same message-out convention.
  • ADD_ROW — The higher-level create operation, typically used where the primary key is generated or resolved by the package logic rather than supplied by the caller.
  • DELETE_ROW — Removes the identified record from the entity.
  • LOCK_ROW — Obtains the row-level lock required to serialize concurrent modification, returning status and message data.
  • GET_PK_FOR_VALIDATION — Resolves/validates the primary key value for the entity.
  • GET_UK_FOR_VALIDATION — Validates the unique key, guarding against duplicate student/group assignments.
  • GET_FK_IGS_AZ_GROUPS — Validates the foreign key relationship to the IGS_AZ_GROUPS parent entity.
  • BEFORE_DML — A pre-DML hook used to enforce derived columns, defaults, and business rules before the insert or update is committed.

Tables Accessed

Two documented tables are referenced through APPS synonyms. IGS_AZ_STUDENTS is the primary base table holding the group-student assignment records, and it is the target of INSERT_ROW, UPDATE_ROW, ADD_ROW, and DELETE_ROW. IGS_AZ_STUDENTS_S is the corresponding shadow (audit) table, populated by the standard Student System shadow-table trigger mechanism to preserve historical row images. The GET_FK_IGS_AZ_GROUPS routine implies validation against the IGS_AZ_GROUPS parent table, though that object is referenced as a validation source rather than a DML target.

Usage Notes

IGS_AZ_STUDENTS_PKG is invoked by three other packages within the EBS code base and is the standard entry point for programmatic maintenance of the students entity. Typical call sites include the associated Oracle Forms block handlers (which call LOCK_ROW before edit and ADD_ROW/UPDATE_ROW/DELETE_ROW on save), concurrent programs that bulk-load student group or advising hold data, and custom extensions that must insert records while preserving the package's validation and message-handling contract. Callers should honor the X_RETURN_STATUS, X_MSG_DATA, and X_MSG_COUNT out parameters to detect success or failure, and should invoke BEFORE_DML and the GET_*_FOR_VALIDATION routines rather than writing directly to the base table, so that unique-key, foreign-key, and business-rule checks remain enforced. Because the package is AUTHID CURRENT_USER, the calling session requires the appropriate grants on the IGS synonyms.