Package sb_athletic_acad

Package sb_athletic_acad_prog

This package provides the Common Business interface for the Athletic Academic Progress API (sb_athletic_acad_prog).

Academic Progress information may be recorded for an athlete. Records may not be deleted for audit purposes.
Multiple records per Banner ID per term may exist, but only one record per ID per term may be marked active.

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.
f_same_as_other	Compares the insert to the current record.
p_create	Creates a record.
p_delete	Deletes a record.
p_lock	Locks a record.
p_update	Updates a record.

Types

athletic_acad_prog_rec	Business Entity record type
athletic_acad_prog_ref	Entity cursor variable type
athletic_acad_prog_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(18) := 'ATHLETIC_ACAD_PROG';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

athletic_acad_prog_rec

TYPE athletic_acad_prog_rec IS RECORD (
  r_pidm                    sgbaprg.sgbaprg_pidm%TYPE,
  r_term_code               sgbaprg.sgbaprg_term_code%TYPE,
  r_seq_no                  sgbaprg.sgbaprg_seq_no%TYPE,
  r_active_ind              sgbaprg.sgbaprg_active_ind%TYPE,
  r_user_id                 sgbaprg.sgbaprg_user_id%TYPE,
  r_single_term_hours       sgbaprg.sgbaprg_single_term_hours%TYPE,
  r_term_1_hours            sgbaprg.sgbaprg_term_1_hours%TYPE,
  r_term_2_hours            sgbaprg.sgbaprg_term_2_hours%TYPE,
  r_term_3_hours            sgbaprg.sgbaprg_term_3_hours%TYPE,
  r_total_year_hours        sgbaprg.sgbaprg_total_year_hours%TYPE,
  r_data_origin             sgbaprg.sgbaprg_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

athletic_acad_prog_ref

TYPE athletic_acad_prog_ref IS REF CURSOR RETURN athletic_acad_prog_rec;

Entity cursor variable type

athletic_acad_prog_tab

TYPE athletic_acad_prog_tab IS TABLE OF athletic_acad_prog_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      sgbaprg.sgbaprg_pidm%TYPE,
                  p_term_code sgbaprg.sgbaprg_term_code%TYPE,
                  p_seq_no    sgbaprg.sgbaprg_seq_no%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2;

Checks if a record exists.

Parameters

	p_pidm	Internal Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) 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_acad_prog_rec,
                   rec_two athletic_acad_prog_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_acad_prog_rec Required
	rec_two	The second record to compare. Type athletic_acad_prog_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      sgbaprg.sgbaprg_pidm%TYPE,
                     p_term_code sgbaprg.sgbaprg_term_code%TYPE,
                     p_seq_no    sgbaprg.sgbaprg_seq_no%TYPE DEFAULT NULL)
  RETURN athletic_acad_prog_ref;

Selects all records for the entity.

Parameters

	p_pidm	Internal Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm      sgbaprg.sgbaprg_pidm%TYPE,
                     p_term_code sgbaprg.sgbaprg_term_code%TYPE,
                     p_seq_no    sgbaprg.sgbaprg_seq_no%TYPE)
  RETURN athletic_acad_prog_ref;

Selects one record using the key.

Parameters

	p_pidm	Internal Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) 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_acad_prog_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      sgbaprg.sgbaprg_pidm%TYPE,
                          p_term_code sgbaprg.sgbaprg_term_code%TYPE,
                          p_seq_no    sgbaprg.sgbaprg_seq_no%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN athletic_acad_prog_ref;

Selects one record and locks it.

Parameters

	p_pidm	Internal Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

f_same_as_other

FUNCTION f_same_as_other(p_pidm              sgbaprg.sgbaprg_pidm%TYPE,
                         p_term_code         sgbaprg.sgbaprg_term_code%TYPE,
                         p_single_term_hours sgbaprg.sgbaprg_single_term_hours%TYPE DEFAULT NULL,
                         p_term_1_hours      sgbaprg.sgbaprg_term_1_hours%TYPE DEFAULT NULL,
                         p_term_2_hours      sgbaprg.sgbaprg_term_2_hours%TYPE DEFAULT NULL,
                         p_term_3_hours      sgbaprg.sgbaprg_term_3_hours%TYPE DEFAULT NULL,
                         p_total_year_hours  sgbaprg.sgbaprg_total_year_hours%TYPE DEFAULT NULL)
  RETURN VARCHAR2;

Compares the insert to the current record.

Parameters

	p_pidm	Internal Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_single_term_hours	Number of hours reported for a single term. NUMBER(7,3)
	p_term_1_hours	Number of hours reported for the first term of the academic year. NUMBER(7,3)
	p_term_2_hours	Number of hours reported for the second term of the academic year. NUMBER(7,3)
	p_term_3_hours	Number of hours reported for the third term of the academic year. NUMBER(7,3)
	p_total_year_hours	Total number of hours reported for the academic year. NUMBER(7,3)

p_create

PROCEDURE p_create(p_pidm              sgbaprg.sgbaprg_pidm%TYPE,
                   p_term_code         sgbaprg.sgbaprg_term_code%TYPE,
                   p_seq_no            sgbaprg.sgbaprg_seq_no%TYPE DEFAULT NULL,
                   p_active_ind        sgbaprg.sgbaprg_active_ind%TYPE,
                   p_user_id           sgbaprg.sgbaprg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_single_term_hours sgbaprg.sgbaprg_single_term_hours%TYPE DEFAULT NULL,
                   p_term_1_hours      sgbaprg.sgbaprg_term_1_hours%TYPE DEFAULT NULL,
                   p_term_2_hours      sgbaprg.sgbaprg_term_2_hours%TYPE DEFAULT NULL,
                   p_term_3_hours      sgbaprg.sgbaprg_term_3_hours%TYPE DEFAULT NULL,
                   p_total_year_hours  sgbaprg.sgbaprg_total_year_hours%TYPE DEFAULT NULL,
                   p_data_origin       sgbaprg.sgbaprg_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out         OUT gb_common.internal_record_id_type);

Creates a record.

Parameters

	p_pidm	Internal Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) Required Key
	p_active_ind	Indicator for whether the record is the active record for the term. VARCHAR2(4) Required
	p_user_id	ID of the user who entered the record. VARCHAR2(120) Required
	p_single_term_hours	Number of hours reported for a single term. NUMBER(7,3)
	p_term_1_hours	Number of hours reported for the first term of the academic year. NUMBER(7,3)
	p_term_2_hours	Number of hours reported for the second term of the academic year. NUMBER(7,3)
	p_term_3_hours	Number of hours reported for the third term of the academic year. NUMBER(7,3)
	p_total_year_hours	Total number of hours reported for the academic year. NUMBER(7,3)
	p_data_origin	Source system that created or updated the row. VARCHAR2(120)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_pidm      sgbaprg.sgbaprg_pidm%TYPE,
                   p_term_code sgbaprg.sgbaprg_term_code%TYPE,
                   p_seq_no    sgbaprg.sgbaprg_seq_no%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters

	p_pidm	Internal Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_pidm        sgbaprg.sgbaprg_pidm%TYPE,
                 p_term_code   sgbaprg.sgbaprg_term_code%TYPE,
                 p_seq_no      sgbaprg.sgbaprg_seq_no%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 Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_pidm              sgbaprg.sgbaprg_pidm%TYPE,
                   p_term_code         sgbaprg.sgbaprg_term_code%TYPE,
                   p_seq_no            sgbaprg.sgbaprg_seq_no%TYPE,
                   p_active_ind        sgbaprg.sgbaprg_active_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id           sgbaprg.sgbaprg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_single_term_hours sgbaprg.sgbaprg_single_term_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_term_1_hours      sgbaprg.sgbaprg_term_1_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_term_2_hours      sgbaprg.sgbaprg_term_2_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_term_3_hours      sgbaprg.sgbaprg_term_3_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_total_year_hours  sgbaprg.sgbaprg_total_year_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin       sgbaprg.sgbaprg_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 Banner ID for which the athletic credit requirements are being reported. NUMBER(8) Required Key
	p_term_code	Term code for which the athletic credit requirements are being reported. VARCHAR2(24) Required Key
	p_seq_no	Sequence number for which the record was added. NUMBER(2) Required Key
	p_active_ind	Indicator for whether the record is the active record for the term. VARCHAR2(4) Required
	p_user_id	ID of the user who last updated the record. VARCHAR2(120) Required
	p_single_term_hours	Number of hours reported for a single term. NUMBER(7,3)
	p_term_1_hours	Number of hours reported for the first term of the academic year. NUMBER(7,3)
	p_term_2_hours	Number of hours reported for the second term of the academic year. NUMBER(7,3)
	p_term_3_hours	Number of hours reported for the third term of the academic year. NUMBER(7,3)
	p_total_year_hours	Total number of hours reported for the academic year. NUMBER(7,3)
	p_data_origin	Source system that created or updated the row. VARCHAR2(120)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)