Package sb_athletic

Package sb_athletic_admissions

This package provides the Common Business interface for the Athletic Admissions API (sb_athletic_admissions).

Admission information may be recorded for an athlete. This information includes Athlete Qualifier Status, SAT and ACT information, and High School Course and GPA information.
An athlete may have one Athletic Admissions record.

Program units

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

athletic_admissions_rec	Business Entity record type
athletic_admissions_ref	Entity cursor variable type
athletic_admissions_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(19) := 'ATHLETIC_ADMISSIONS';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

athletic_admissions_rec

TYPE athletic_admissions_rec IS RECORD (
  r_pidm                    sgratad.sgratad_pidm%TYPE,
  r_user_id                 sgratad.sgratad_user_id%TYPE,
  r_combined_sat            sgratad.sgratad_combined_sat%TYPE,
  r_composite_act           sgratad.sgratad_composite_act%TYPE,
  r_athlete_gpa             sgratad.sgratad_athlete_gpa%TYPE,
  r_saqs_code               sgratad.sgratad_saqs_code%TYPE,
  r_hs_core_courses         sgratad.sgratad_hs_core_courses%TYPE,
  r_data_origin             sgratad.sgratad_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

athletic_admissions_ref

TYPE athletic_admissions_ref IS REF CURSOR RETURN athletic_admissions_rec;

Entity cursor variable type

athletic_admissions_tab

TYPE athletic_admissions_tab IS TABLE OF athletic_admissions_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_pidm  sgratad.sgratad_pidm%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2;

Checks if a record exists.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_isequal

FUNCTION f_isequal(rec_one athletic_admissions_rec,
                   rec_two athletic_admissions_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 athletic_admissions_rec Required
	rec_two	The second record to compare. Type athletic_admissions_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_pidm sgratad.sgratad_pidm%TYPE DEFAULT NULL)
  RETURN athletic_admissions_ref;

Selects all records for the entity.

Parameters

p_pidm

Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm sgratad.sgratad_pidm%TYPE)
  RETURN athletic_admissions_ref;

Selects one record using the key.

Parameters

p_pidm

Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) 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 athletic_admissions_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_pidm  sgratad.sgratad_pidm%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN athletic_admissions_ref;

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) 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_pidm            sgratad.sgratad_pidm%TYPE,
                   p_user_id         sgratad.sgratad_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_combined_sat    sgratad.sgratad_combined_sat%TYPE DEFAULT NULL,
                   p_composite_act   sgratad.sgratad_composite_act%TYPE DEFAULT NULL,
                   p_athlete_gpa     sgratad.sgratad_athlete_gpa%TYPE DEFAULT NULL,
                   p_saqs_code       sgratad.sgratad_saqs_code%TYPE DEFAULT NULL,
                   p_hs_core_courses sgratad.sgratad_hs_core_courses%TYPE DEFAULT NULL,
                   p_data_origin     sgratad.sgratad_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out       OUT gb_common.internal_record_id_type);

Creates a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) Required Key
	p_user_id	ID of the most recent user to create or update the row in the SGRATAD table. VARCHAR2(30) Required
	p_combined_sat	Combined SAT score for the athlete. VARCHAR2(4)
	p_composite_act	Composite ACT score for the athlete. VARCHAR2(4)
	p_athlete_gpa	GPA for the athlete. NUMBER(23,9)
	p_saqs_code	Code for athlete qualifier status. VARCHAR2(2)
	p_hs_core_courses	Number of core courses taken in high school by the athlete. NUMBER(3)
	p_data_origin	Value of the source system that inserted or updated the row. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm  sgratad.sgratad_pidm%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_pidm        sgratad.sgratad_pidm%TYPE,
                 p_rowid_inout IN OUT NOCOPY gb_common.internal_record_id_type);

Locks a record.
If the 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_pidm	Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_pidm            sgratad.sgratad_pidm%TYPE,
                   p_user_id         sgratad.sgratad_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_combined_sat    sgratad.sgratad_combined_sat%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_composite_act   sgratad.sgratad_composite_act%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_athlete_gpa     sgratad.sgratad_athlete_gpa%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_saqs_code       sgratad.sgratad_saqs_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_hs_core_courses sgratad.sgratad_hs_core_courses%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin     sgratad.sgratad_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL);

Updates a record.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the admissions information belongs. NUMBER(8) Required Key
	p_user_id	ID of the most recent user to create or update the row in the SGRATAD table. VARCHAR2(30) Required
	p_combined_sat	Combined SAT score for the athlete. VARCHAR2(4)
	p_composite_act	Composite ACT score for the athlete. VARCHAR2(4)
	p_athlete_gpa	GPA for the athlete. NUMBER(23,9)
	p_saqs_code	Code for athlete qualifier status. VARCHAR2(2)
	p_hs_core_courses	Number of core courses taken in high school by the athlete. NUMBER(3)
	p_data_origin	Value of the source system that inserted or updated the row. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)