Package sb_athletic

Package sb_athletic_eligibility

This package is the Common Business interface for the Athletic Eligibility API (sb_athletic_eligibility).

An athlete may have eligibility information that is not specific to a term or a sport. Only one record for an athlete may exist. This record may be updated and deleted.

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_eligibility_rec	Business Entity record type
athletic_eligibility_ref	Entity cursor variable type
athletic_eligibility_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(20) := 'ATHLETIC_ELIGIBILITY';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

athletic_eligibility_rec

TYPE athletic_eligibility_rec IS RECORD (
  r_pidm                    sgrathe.sgrathe_pidm%TYPE,
  r_user_id                 sgrathe.sgrathe_user_id%TYPE,
  r_recruit_ind             sgrathe.sgrathe_recruit_ind%TYPE,
  r_attend_from_date        sgrathe.sgrathe_attend_from_date%TYPE,
  r_initial_enroll_date     sgrathe.sgrathe_initial_enroll_date%TYPE,
  r_total_terms_attend      sgrathe.sgrathe_total_terms_attend%TYPE,
  r_data_origin             sgrathe.sgrathe_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

athletic_eligibility_ref

TYPE athletic_eligibility_ref IS REF CURSOR RETURN athletic_eligibility_rec;

Entity cursor variable type

athletic_eligibility_tab

TYPE athletic_eligibility_tab IS TABLE OF athletic_eligibility_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  sgrathe.sgrathe_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 eligibility 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_eligibility_rec,
                   rec_two athletic_eligibility_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_eligibility_rec Required
	rec_two	The second record to compare. Type athletic_eligibility_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                sgrathe.sgrathe_pidm%TYPE DEFAULT NULL,
                     p_recruit_ind         sgrathe.sgrathe_recruit_ind%TYPE DEFAULT NULL,
                     p_attend_from_date    sgrathe.sgrathe_attend_from_date%TYPE DEFAULT NULL,
                     p_initial_enroll_date sgrathe.sgrathe_initial_enroll_date%TYPE DEFAULT NULL,
                     p_total_terms_attend  sgrathe.sgrathe_total_terms_attend%TYPE DEFAULT NULL)
  RETURN athletic_eligibility_ref;

Selects all records for the entity.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the eligibility information belongs. NUMBER(8) Required Key
	p_recruit_ind	Indicator for whether the athlete was recruited. VARCHAR2(1) Required
	p_attend_from_date	Date the athlete first attended an institution. DATE
	p_initial_enroll_date	Date the athlete first enrolled at this institution. DATE
	p_total_terms_attend	Number of terms the athlete has attended. NUMBER(4)

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm sgrathe.sgrathe_pidm%TYPE)
  RETURN athletic_eligibility_ref;

Selects one record using the key.

Parameters

p_pidm

Internal identification number (PIDM) of the athlete for which the eligibility 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_eligibility_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  sgrathe.sgrathe_pidm%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN athletic_eligibility_ref;

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the eligibility 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                sgrathe.sgrathe_pidm%TYPE,
                   p_user_id             sgrathe.sgrathe_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_recruit_ind         sgrathe.sgrathe_recruit_ind%TYPE,
                   p_attend_from_date    sgrathe.sgrathe_attend_from_date%TYPE DEFAULT NULL,
                   p_initial_enroll_date sgrathe.sgrathe_initial_enroll_date%TYPE DEFAULT NULL,
                   p_total_terms_attend  sgrathe.sgrathe_total_terms_attend%TYPE DEFAULT NULL,
                   p_data_origin         sgrathe.sgrathe_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 eligibility information belongs. NUMBER(8) Required Key
	p_user_id	ID of the most recent user to create or update the row in the SGRATHE table. VARCHAR2(30) Required
	p_recruit_ind	Indicator for whether the athlete was recruited. VARCHAR2(1) Required
	p_attend_from_date	Date the athlete first attended an institution. DATE
	p_initial_enroll_date	Date the athlete first enrolled at this institution. DATE
	p_total_terms_attend	Number of terms the athlete has attended. NUMBER(4)
	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  sgrathe.sgrathe_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 eligibility 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        sgrathe.sgrathe_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 eligibility 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                sgrathe.sgrathe_pidm%TYPE,
                   p_user_id             sgrathe.sgrathe_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_recruit_ind         sgrathe.sgrathe_recruit_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attend_from_date    sgrathe.sgrathe_attend_from_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_initial_enroll_date sgrathe.sgrathe_initial_enroll_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_total_terms_attend  sgrathe.sgrathe_total_terms_attend%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin         sgrathe.sgrathe_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 eligibility information belongs. NUMBER(8) Required Key
	p_user_id	ID of the most recent user to create or update the row in the SGRATHE table. VARCHAR2(30) Required
	p_recruit_ind	Indicator for whether the athlete was recruited. VARCHAR2(1) Required
	p_attend_from_date	Date the athlete first attended an institution. DATE
	p_initial_enroll_date	Date the athlete first enrolled at this institution. DATE
	p_total_terms_attend	Number of terms the athlete has attended. NUMBER(4)
	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)