index

Package sb_athletic_compliance

This package is the Common Business interface for the Athletic Compliance API (sb_athletic_compliance).
 
Athlete sport information may be recorded for an athlete for a term.  An athlete may have multiple sports records within a term.  The sport records may be updated.  The sport records may be deleted, but only in certain circumstances.  A sport record may not be deleted if competition data exists.
When attributes and athletic comments exist for the sport in the term, they must be deleted before the sport record is 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.
f_copy_sport   Copies the sport information.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
athletic_compliance_rec   Business Entity record type
athletic_compliance_ref   Entity cursor variable type
athletic_compliance_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_COMPLIANCE';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

athletic_compliance_rec 

TYPE athletic_compliance_rec IS RECORD (
  r_pidm                    sgrsprt.sgrsprt_pidm%TYPE,
  r_term_code               sgrsprt.sgrsprt_term_code%TYPE,
  r_actc_code               sgrsprt.sgrsprt_actc_code%TYPE,
  r_spst_code               sgrsprt.sgrsprt_spst_code%TYPE,
  r_elig_code               sgrsprt.sgrsprt_elig_code%TYPE,
  r_athl_aid_ind            sgrsprt.sgrsprt_athl_aid_ind%TYPE,
  r_user_id                 sgrsprt.sgrsprt_user_id%TYPE,
  r_sael_code               sgrsprt.sgrsprt_sael_code%TYPE,
  r_data_origin             sgrsprt.sgrsprt_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

athletic_compliance_ref 

TYPE athletic_compliance_ref IS REF CURSOR RETURN athletic_compliance_rec;

Entity cursor variable type

athletic_compliance_tab 

TYPE athletic_compliance_tab IS TABLE OF athletic_compliance_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      sgrsprt.sgrsprt_pidm%TYPE,
                  p_term_code sgrsprt.sgrsprt_term_code%TYPE,
                  p_actc_code sgrsprt.sgrsprt_actc_code%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 compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(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_compliance_rec,
                   rec_two athletic_compliance_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_compliance_rec Required
rec_two   The second record to compare. Type athletic_compliance_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         sgrsprt.sgrsprt_pidm%TYPE DEFAULT NULL,
                     p_term_code    sgrsprt.sgrsprt_term_code%TYPE DEFAULT NULL,
                     p_actc_code    sgrsprt.sgrsprt_actc_code%TYPE DEFAULT NULL,
                     p_spst_code    sgrsprt.sgrsprt_spst_code%TYPE DEFAULT NULL,
                     p_elig_code    sgrsprt.sgrsprt_elig_code%TYPE DEFAULT NULL,
                     p_athl_aid_ind sgrsprt.sgrsprt_athl_aid_ind%TYPE DEFAULT NULL,
                     p_sael_code    sgrsprt.sgrsprt_sael_code%TYPE DEFAULT NULL)
  RETURN athletic_compliance_ref;

Selects all records for the entity.

Parameters
p_pidm   Internal identification number (PIDM) of the athlete for which the compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(8) Required Key
p_spst_code   Sport status code for the athletic compliance. VARCHAR2(2)
p_elig_code   Eligibility code for the athletic compliance. VARCHAR2(2)
p_athl_aid_ind   Indicator for whether the athlete receives athletic aid. VARCHAR2(1)
p_sael_code   Athletic official eligibility code for the athletic compliance. VARCHAR2(2)

Returns
A cursor variable that will fetch a set of records.

f_query_one 

FUNCTION f_query_one(p_pidm      sgrsprt.sgrsprt_pidm%TYPE,
                     p_term_code sgrsprt.sgrsprt_term_code%TYPE,
                     p_actc_code sgrsprt.sgrsprt_actc_code%TYPE)
  RETURN athletic_compliance_ref;

Selects one record using the key.

Parameters
p_pidm   Internal identification number (PIDM) of the athlete for which the compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(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_compliance_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      sgrsprt.sgrsprt_pidm%TYPE,
                          p_term_code sgrsprt.sgrsprt_term_code%TYPE,
                          p_actc_code sgrsprt.sgrsprt_actc_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN athletic_compliance_ref;

Selects one record and locks it.

Parameters
p_pidm   Internal identification number (PIDM) of the athlete for which the compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(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.

f_copy_sport 

FUNCTION f_copy_sport(p_pidm           IN SGRSPRT.SGRSPRT_PIDM%TYPE,
                      p_actc_code      IN SGRSPRT.SGRSPRT_ACTC_CODE%TYPE,
                      p_from_term_code IN SGRSPRT.SGRSPRT_TERM_CODE%TYPE,
                      p_to_term_code   IN SGRSPRT.SGRSPRT_TERM_CODE%TYPE,
                      p_copy_attrs     IN VARCHAR2 DEFAULT 'N')
  RETURN VARCHAR2;

Copies the sport information.
@p_copy_attrs Indicates if attributes will also be copied.  VARCHAR2(1)

Parameters
p_pidm   Internal identification number (PIDM) of the athlete for which the compliance information belongs. NUMBER(8) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(8) Required Key
p_from_term_code   Term code for the athletic compliance to copy from. VARCHAR2(6) Required Key
p_to_term_code   Term code for the athletic compliance to copy to. VARCHAR2(6) Required Key

Returns
S(uccess) or F(ailure).

p_create 

PROCEDURE p_create(p_pidm         sgrsprt.sgrsprt_pidm%TYPE,
                   p_term_code    sgrsprt.sgrsprt_term_code%TYPE,
                   p_actc_code    sgrsprt.sgrsprt_actc_code%TYPE,
                   p_spst_code    sgrsprt.sgrsprt_spst_code%TYPE DEFAULT NULL,
                   p_elig_code    sgrsprt.sgrsprt_elig_code%TYPE DEFAULT NULL,
                   p_athl_aid_ind sgrsprt.sgrsprt_athl_aid_ind%TYPE DEFAULT NULL,
                   p_user_id      sgrsprt.sgrsprt_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_sael_code    sgrsprt.sgrsprt_sael_code%TYPE DEFAULT NULL,
                   p_data_origin  sgrsprt.sgrsprt_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 compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(8) Required Key
p_spst_code   Sport status code for the athletic compliance. VARCHAR2(2)
p_elig_code   Eligibility code for the athletic compliance. VARCHAR2(2)
p_athl_aid_ind   Indicator for whether the athlete receives athletic aid. VARCHAR2(1)
p_user_id   ID of the most recent user to create or update the row in the SGRSPRT table. VARCHAR2(30) Required
p_sael_code   Athletic official eligibility code for the athletic compliance. VARCHAR2(2)
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      sgrsprt.sgrsprt_pidm%TYPE,
                   p_term_code sgrsprt.sgrsprt_term_code%TYPE,
                   p_actc_code sgrsprt.sgrsprt_actc_code%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 compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(8) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

PROCEDURE p_lock(p_pidm        sgrsprt.sgrsprt_pidm%TYPE,
                 p_term_code   sgrsprt.sgrsprt_term_code%TYPE,
                 p_actc_code   sgrsprt.sgrsprt_actc_code%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 compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(8) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

PROCEDURE p_update(p_pidm         sgrsprt.sgrsprt_pidm%TYPE,
                   p_term_code    sgrsprt.sgrsprt_term_code%TYPE,
                   p_actc_code    sgrsprt.sgrsprt_actc_code%TYPE,
                   p_spst_code    sgrsprt.sgrsprt_spst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_elig_code    sgrsprt.sgrsprt_elig_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_athl_aid_ind sgrsprt.sgrsprt_athl_aid_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id      sgrsprt.sgrsprt_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_sael_code    sgrsprt.sgrsprt_sael_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin  sgrsprt.sgrsprt_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 compliance information belongs. NUMBER(8) Required Key
p_term_code   Term code for the athletic compliance. VARCHAR2(6) Required Key
p_actc_code   Activity code for the athletic compliance. VARCHAR2(8) Required Key
p_spst_code   Sport status code for the athletic compliance. VARCHAR2(2)
p_elig_code   Eligibility code for the athletic compliance. VARCHAR2(2)
p_athl_aid_ind   Indicator for whether the athlete receives athletic aid. VARCHAR2(1)
p_user_id   ID of the most recent user to create or update the row in the SGRSPRT table. VARCHAR2(30) Required
p_sael_code   Athletic official eligibility code. VARCHAR2(2)
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)