Package sb_athletic

Package sb_athletic_transfer

This package is the Common Business interface for the Athletic Transfer API (sb_athletic_transfer).

An athlete may have transfer 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_transfer_rec	Business Entity record type
athletic_transfer_ref	Entity cursor variable type
athletic_transfer_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(17) := 'ATHLETIC_TRANSFER';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

athletic_transfer_rec

TYPE athletic_transfer_rec IS RECORD (
  r_pidm                    sgratht.sgratht_pidm%TYPE,
  r_trans_eligible_ind      sgratht.sgratht_trans_eligible_ind%TYPE,
  r_res_req_ind             sgratht.sgratht_res_req_ind%TYPE,
  r_met_credit_yr_ind       sgratht.sgratht_met_credit_yr_ind%TYPE,
  r_user_id                 sgratht.sgratht_user_id%TYPE,
  r_trans_quality_points    sgratht.sgratht_trans_quality_points%TYPE,
  r_trans_gpa               sgratht.sgratht_trans_gpa%TYPE,
  r_trans_terms_attended    sgratht.sgratht_trans_terms_attended%TYPE,
  r_trans_hours_attempted   sgratht.sgratht_trans_hours_attempted%TYPE,
  r_trans_hours_earned      sgratht.sgratht_trans_hours_earned%TYPE,
  r_trans_accept_date       sgratht.sgratht_trans_accept_date%TYPE,
  r_satr_code               sgratht.sgratht_satr_code%TYPE,
  r_sarx_code               sgratht.sgratht_sarx_code%TYPE,
  r_data_origin             sgratht.sgratht_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

athletic_transfer_ref

TYPE athletic_transfer_ref IS REF CURSOR RETURN athletic_transfer_rec;

Entity cursor variable type

athletic_transfer_tab

TYPE athletic_transfer_tab IS TABLE OF athletic_transfer_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  sgratht.sgratht_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 transfer 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_transfer_rec,
                   rec_two athletic_transfer_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_transfer_rec Required
	rec_two	The second record to compare. Type athletic_transfer_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               sgratht.sgratht_pidm%TYPE,
                     p_trans_eligible_ind sgratht.sgratht_trans_eligible_ind%TYPE,
                     p_res_req_ind        sgratht.sgratht_res_req_ind%TYPE,
                     p_met_credit_yr_ind  sgratht.sgratht_met_credit_yr_ind%TYPE,
                     p_satr_code          sgratht.sgratht_satr_code%TYPE,
                     p_sarx_code          sgratht.sgratht_sarx_code%TYPE,
                     p_trans_accept_date  sgratht.sgratht_trans_accept_date%TYPE)
  RETURN athletic_transfer_ref;

Selects all records for the entity.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the transfer information belongs. NUMBER(8) Required Key
	p_trans_eligible_ind	Indicator for whether the athlete is eligible to transfer. VARCHAR2(1) Required
	p_res_req_ind	Indicator for whether the athlete meets the residency requirement. VARCHAR2(1) Required
	p_met_credit_yr_ind	Indicator for whether the athlete met the academic credit year requirement. VARCHAR2(1) Required
	p_satr_code	Transfer status of the athlete. VARCHAR2(4)
	p_sarx_code	Residency exception of the athlete. VARCHAR2(4)
	p_trans_accept_date	Date the transfer was accepted. DATE

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm sgratht.sgratht_pidm%TYPE)
  RETURN athletic_transfer_ref;

Selects one record using the key.

Parameters

p_pidm

Internal identification number (PIDM) of the athlete for which the transfer 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_transfer_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  sgratht.sgratht_pidm%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN athletic_transfer_ref;

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number (PIDM) of the athlete for which the transfer 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                  sgratht.sgratht_pidm%TYPE,
                   p_trans_eligible_ind    sgratht.sgratht_trans_eligible_ind%TYPE,
                   p_res_req_ind           sgratht.sgratht_res_req_ind%TYPE,
                   p_met_credit_yr_ind     sgratht.sgratht_met_credit_yr_ind%TYPE,
                   p_user_id               sgratht.sgratht_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_trans_quality_points  sgratht.sgratht_trans_quality_points%TYPE DEFAULT NULL,
                   p_trans_gpa             sgratht.sgratht_trans_gpa%TYPE DEFAULT NULL,
                   p_trans_terms_attended  sgratht.sgratht_trans_terms_attended%TYPE DEFAULT NULL,
                   p_trans_hours_attempted sgratht.sgratht_trans_hours_attempted%TYPE DEFAULT NULL,
                   p_trans_hours_earned    sgratht.sgratht_trans_hours_earned%TYPE DEFAULT NULL,
                   p_trans_accept_date     sgratht.sgratht_trans_accept_date%TYPE DEFAULT NULL,
                   p_satr_code             sgratht.sgratht_satr_code%TYPE DEFAULT NULL,
                   p_sarx_code             sgratht.sgratht_sarx_code%TYPE DEFAULT NULL,
                   p_data_origin           sgratht.sgratht_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 transfer information belongs. NUMBER(8) Required Key
	p_trans_eligible_ind	Indicator for whether the athlete is eligible to transfer. VARCHAR2(1) Required
	p_res_req_ind	Indicator for whether the athlete meets the residency requirement. VARCHAR2(1) Required
	p_met_credit_yr_ind	Indicator for whether the athlete met the academic credit year requirement. VARCHAR2(1) Required
	p_user_id	ID of the most recent user to create or update the row in the SGRATHT table. VARCHAR2(30) Required
	p_trans_quality_points	Transfer quality points for the athlete. NUMBER(15,6)
	p_trans_gpa	Transfer GPA for the athlete. NUMBER(21,9)
	p_trans_terms_attended	Number of transfer terms attended. NUMBER(4)
	p_trans_hours_attempted	Number of transfer hours attempted. NUMBER(9,3)
	p_trans_hours_earned	Number of transfer hours earned. NUMBER(9,3)
	p_trans_accept_date	Date the transfer was accepted. DATE
	p_satr_code	Transfer status of the athlete. VARCHAR2(4)
	p_sarx_code	Residency exception of the athlete. VARCHAR2(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  sgratht.sgratht_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 transfer 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        sgratht.sgratht_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 transfer 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                  sgratht.sgratht_pidm%TYPE,
                   p_trans_eligible_ind    sgratht.sgratht_trans_eligible_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_res_req_ind           sgratht.sgratht_res_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_met_credit_yr_ind     sgratht.sgratht_met_credit_yr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id               sgratht.sgratht_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_trans_quality_points  sgratht.sgratht_trans_quality_points%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trans_gpa             sgratht.sgratht_trans_gpa%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trans_terms_attended  sgratht.sgratht_trans_terms_attended%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trans_hours_attempted sgratht.sgratht_trans_hours_attempted%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trans_hours_earned    sgratht.sgratht_trans_hours_earned%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trans_accept_date     sgratht.sgratht_trans_accept_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_satr_code             sgratht.sgratht_satr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sarx_code             sgratht.sgratht_sarx_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin           sgratht.sgratht_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 transfer information belongs. NUMBER(8) Required Key
	p_trans_eligible_ind	Indicator for whether the athlete is eligible to transfer. VARCHAR2(1) Required
	p_res_req_ind	Indicator for whether the athlete meets the residency requirement. VARCHAR2(1) Required
	p_met_credit_yr_ind	Indicator for whether the athlete met the academic credit year requirement. VARCHAR2(1) Required
	p_user_id	ID of the most recent user to create or update the row in the SGRATHT table. VARCHAR2(30) Required
	p_trans_quality_points	Transfer quality points for the athlete. NUMBER(15,6)
	p_trans_gpa	Transfer GPA for the athlete. NUMBER(21,9)
	p_trans_terms_attended	Number of transfer terms attended. NUMBER(4)
	p_trans_hours_attempted	Number of transfer hours attempted. NUMBER(9,3)
	p_trans_hours_earned	Number of transfer hours earned. NUMBER(9,3)
	p_trans_accept_date	Date the transfer was accepted. DATE
	p_satr_code	Transfer status of the athlete. VARCHAR2(4)
	p_sarx_code	Residency exception of the athlete. VARCHAR2(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)