index

Package sb_athletic_degc_comp

This package provides the Common Business interface for the Athletic Degree Completion API (sb_athletic_degc_comp).
 
Athletic Degree Completion information may be recorded for an athlete.  Records may not be deleted for audit purposes.
Multiple records per Banner ID per term may exist and a reason code must be entered when adding a new record for the term.

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_degc_comp_rec   Business Entity record type
athletic_degc_comp_ref   Entity cursor variable type
athletic_degc_comp_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_DEGC_COMP';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

athletic_degc_comp_rec 

TYPE athletic_degc_comp_rec IS RECORD (
  r_pidm                    sgbdcpr.sgbdcpr_pidm%TYPE,
  r_term_code               sgbdcpr.sgbdcpr_term_code%TYPE,
  r_levl_code               sgbdcpr.sgbdcpr_levl_code%TYPE,
  r_lcur_seqno              sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
  r_key_seqno               sgbdcpr.sgbdcpr_key_seqno%TYPE,
  r_user_id                 sgbdcpr.sgbdcpr_user_id%TYPE,
  r_required_hours          sgbdcpr.sgbdcpr_required_hours%TYPE,
  r_completed_hours         sgbdcpr.sgbdcpr_completed_hours%TYPE,
  r_dcpr_code               sgbdcpr.sgbdcpr_dcpr_code%TYPE,
  r_data_origin             sgbdcpr.sgbdcpr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

athletic_degc_comp_ref 

TYPE athletic_degc_comp_ref IS REF CURSOR RETURN athletic_degc_comp_rec;

Entity cursor variable type

athletic_degc_comp_tab 

TYPE athletic_degc_comp_tab IS TABLE OF athletic_degc_comp_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       sgbdcpr.sgbdcpr_pidm%TYPE,
                  p_lcur_seqno sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                  p_key_seqno  sgbdcpr.sgbdcpr_key_seqno%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 degree completion percentage is being reported. NUMBER(8) Required Key
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Key sequence number for which the record was added. NUMBER(4) 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_degc_comp_rec,
                   rec_two athletic_degc_comp_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_degc_comp_rec Required
rec_two   The second record to compare. Type athletic_degc_comp_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       sgbdcpr.sgbdcpr_pidm%TYPE,
                     p_lcur_seqno sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                     p_key_seqno  sgbdcpr.sgbdcpr_key_seqno%TYPE)
  RETURN athletic_degc_comp_ref;

Selects all records for the entity.

Parameters
p_pidm   Internal Banner ID for which the degree completion percentage is being reported. NUMBER(8) Required Key
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Key sequence number for which the record was added. NUMBER(4) Required Key

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

f_query_one 

FUNCTION f_query_one(p_pidm       sgbdcpr.sgbdcpr_pidm%TYPE,
                     p_lcur_seqno sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                     p_key_seqno  sgbdcpr.sgbdcpr_key_seqno%TYPE)
  RETURN athletic_degc_comp_ref;

Selects one record using the key.

Parameters
p_pidm   Internal Banner ID for which the degree completion percentage is being reported. NUMBER(8) Required Key
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Key sequence number for which the record was added. NUMBER(4) 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_degc_comp_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       sgbdcpr.sgbdcpr_pidm%TYPE,
                          p_lcur_seqno sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                          p_key_seqno  sgbdcpr.sgbdcpr_key_seqno%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN athletic_degc_comp_ref;

Selects one record and locks it.

Parameters
p_pidm   Internal Banner ID for which the degree completion percentage is being reported. NUMBER(8) Required Key
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Key sequence number for which the record was added. NUMBER(4) 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            sgbdcpr.sgbdcpr_pidm%TYPE,
                   p_term_code       sgbdcpr.sgbdcpr_term_code%TYPE,
                   p_levl_code       sgbdcpr.sgbdcpr_levl_code%TYPE,
                   p_lcur_seqno      sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                   p_key_seqno       sgbdcpr.sgbdcpr_key_seqno%TYPE DEFAULT NULL,
                   p_user_id         sgbdcpr.sgbdcpr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_required_hours  sgbdcpr.sgbdcpr_required_hours%TYPE DEFAULT NULL,
                   p_completed_hours sgbdcpr.sgbdcpr_completed_hours%TYPE DEFAULT NULL,
                   p_dcpr_code       sgbdcpr.sgbdcpr_dcpr_code%TYPE DEFAULT NULL,
                   p_data_origin     sgbdcpr.sgbdcpr_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 degree completion percentage is being reported. NUMBER(8) Required Key
p_term_code   Term code for which the degree completion percentage is being reported. VARCHAR2(24) Required
p_levl_code   Student level code for which the degree completion percentage is being reported. VARCHAR2(8) Required
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Key sequence number for which the record was added. NUMBER(4) Required Key
p_user_id   ID of the user who entered the record. VARCHAR2(120) Required
p_required_hours   Number of hours required for degree completion. NUMBER(7,3)
p_completed_hours   Number of hours completed toward the degree. NUMBER(7,3)
p_dcpr_code   Reason code for a change in the degree completion percentage. VARCHAR2(20)
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       sgbdcpr.sgbdcpr_pidm%TYPE,
                   p_lcur_seqno sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                   p_key_seqno  sgbdcpr.sgbdcpr_key_seqno%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL);

Deletes a record.

Parameters
p_pidm   Internal Banner ID for which the degree completion percentage is being reported. NUMBER(8) Required Key
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Key sequence number for which the record was added. NUMBER(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

PROCEDURE p_lock(p_pidm        sgbdcpr.sgbdcpr_pidm%TYPE,
                 p_lcur_seqno  sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                 p_key_seqno   sgbdcpr.sgbdcpr_key_seqno%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 degree completion percentage is being reported. NUMBER(8) Required Key
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Sequence number for which the record was added. NUMBER(4) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

PROCEDURE p_update(p_pidm            sgbdcpr.sgbdcpr_pidm%TYPE,
                   p_term_code       sgbdcpr.sgbdcpr_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_levl_code       sgbdcpr.sgbdcpr_levl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lcur_seqno      sgbdcpr.sgbdcpr_lcur_seqno%TYPE,
                   p_key_seqno       sgbdcpr.sgbdcpr_key_seqno%TYPE,
                   p_user_id         sgbdcpr.sgbdcpr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_required_hours  sgbdcpr.sgbdcpr_required_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_completed_hours sgbdcpr.sgbdcpr_completed_hours%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_dcpr_code       sgbdcpr.sgbdcpr_dcpr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin     sgbdcpr.sgbdcpr_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 degree completion percentage is being reported. NUMBER(8) Required Key
p_term_code   Term code for which the degree completion percentage is being reported. VARCHAR2(24) Required
p_levl_code   Level code for which the degree completion percentage is being reported. VARCHAR2(8) Required
p_lcur_seqno   Learner curriculum sequence number which corresponds to the record. NUMBER(4) Required Key
p_key_seqno   Sequence number for which the record was added. NUMBER(4) Required Key
p_user_id   ID of the user who last updated the record. VARCHAR2(120) Required
p_required_hours   Number of hours required for degree completion. NUMBER(7,3)
p_completed_hours   Number of hours completed toward the degree. NUMBER(7,3)
p_dcpr_code   Reason code for a change in the degree completion percentage. VARCHAR2(20)
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)