index

Package sb_incmp_grading

This package provides the Common Business interface for the Incomplete Grade Rule API (sb_incmp_grading).


Program units
f_api_version  
f_exists  
f_isequal  
f_query_all  
f_query_one  
f_query_by_rowid  
f_query_one_lock  
p_create  
p_delete  
p_lock  
p_update  

Types
incmp_grading_rec  
incmp_grading_ref  
incmp_grading_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  


M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(13) := 'INCMP_GRADING';

Business Entity Name


M_BASE_TABLE_NAME

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

Base table name


incmp_grading_rec

TYPE incmp_grading_rec IS RECORD (
  r_primary_key             shrincg.shrincg_primary_key%TYPE,
  r_term_code_eff           shrincg.shrincg_term_code_eff%TYPE,
  r_incmp_grading_ind       shrincg.shrincg_incmp_grading_ind%TYPE,
  r_incmp_grde_over_ind     shrincg.shrincg_incmp_grde_over_ind%TYPE,
  r_incmp_date_over_type    shrincg.shrincg_incmp_date_over_type%TYPE,
  r_disp_web_ind            shrincg.shrincg_disp_web_ind%TYPE,
  r_system_req_ind          shrincg.shrincg_system_req_ind%TYPE,
  r_user_id                 shrincg.shrincg_user_id%TYPE,
  r_levl_code               shrincg.shrincg_levl_code%TYPE,
  r_data_origin             shrincg.shrincg_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


incmp_grading_ref

TYPE incmp_grading_ref IS REF CURSOR RETURN incmp_grading_rec;

Entity cursor variable type


incmp_grading_tab

TYPE incmp_grading_tab IS TABLE OF incmp_grading_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_primary_key shrincg.shrincg_primary_key%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_primary_key   Unique sequence number to identify the incomplete grade rule. NUMBER(9) 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 incmp_grading_rec, rec_two incmp_grading_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 incmp_grading_rec Required
rec_two   The second record to compare. Type incmp_grading_rec Required

Returns
Y if all values in records are equal, otherwise N. Nulls match Nulls.


f_query_all

Function f_query_all(p_primary_key shrincg.shrincg_primary_key%TYPE)
  RETURN incmp_grading_ref

Selects all records for the entity.

Parameters
p_primary_key   Unique sequence number to identify the incomplete grade rule. NUMBER(9) Required Key

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


f_query_one

Function f_query_one(p_primary_key shrincg.shrincg_primary_key%TYPE)
  RETURN incmp_grading_ref

Selects one record using the key.

Parameters
p_primary_key   Unique sequence number to identify the incomplete grade rule. NUMBER(9) 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 incmp_grading_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_primary_key shrincg.shrincg_primary_key%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN incmp_grading_ref

Selects one record and locks it.

Parameters
p_primary_key   Unique sequence number to identify the incomplete grade rule. NUMBER(9) 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_term_code_eff        shrincg.shrincg_term_code_eff%TYPE,
                   p_incmp_grading_ind    shrincg.shrincg_incmp_grading_ind%TYPE,
                   p_incmp_grde_over_ind  shrincg.shrincg_incmp_grde_over_ind%TYPE,
                   p_incmp_date_over_type shrincg.shrincg_incmp_date_over_type%TYPE,
                   p_disp_web_ind         shrincg.shrincg_disp_web_ind%TYPE,
                   p_system_req_ind       shrincg.shrincg_system_req_ind%TYPE,
                   p_user_id              shrincg.shrincg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_levl_code            shrincg.shrincg_levl_code%TYPE DEFAULT NULL,
                   p_data_origin          shrincg.shrincg_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out            OUT gb_common.internal_record_id_type)

* Creates a record.
* @param p_term_code_eff Term code to identify when the incomplete grade rule becomes effective. VARCHAR2(6) Required
* @param p_incmp_grading_ind Indicator for whether the incomplete grading logic is active for this rule. Valid values ar
e "Y" or "N". VARCHAR2(1) Required
 
* @param p_incmp_grde_over_ind Indicator for whether faculty can override the default incomplete final grades. Valid val
ues are "Y" or "N". VARCHAR2(1) Required
 
* @param p_incmp_date_over_type Indicator for whether instructors can override the extension date for incompletes. Value
s are "S"-allow only to shorten, "L"-allow only to lengthen, "A"-allow any date or "N"-not allowed. VARCHAR2(1) Required
 
 
* @param p_disp_web_ind Indicator for whether the default final grade and extension date are to be displayed on the web
for students with incomplete grades. Valid values are "Y" or "N". VARCHAR2(1) Required
 
* @param p_system_req_ind System required indicator. VARCHAR2(1) Required
* @param p_user_id ID of the user who inserted or last updated the data. VARCHAR2(30) Required
* @param p_levl_code Level code associated with a term; defines an incomplete grade rule. VARCHAR2(2)
* @param p_data_origin Source system that created or updated the row. VARCHAR2(30)
* @param p_rowid_out Database ROWID of the record to be created. VARCHAR2(18) Required


p_delete

Procedure p_delete(p_primary_key shrincg.shrincg_primary_key%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_primary_key   Unique sequence number to identify the incomplete grade rule. NUMBER(9) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

Procedure p_lock(p_primary_key shrincg.shrincg_primary_key%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_primary_key   Unique sequence number to identify the incomplete grade rule. NUMBER(9) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

Procedure p_update(p_primary_key          shrincg.shrincg_primary_key%TYPE,
                   p_term_code_eff        shrincg.shrincg_term_code_eff%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_incmp_grading_ind    shrincg.shrincg_incmp_grading_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_incmp_grde_over_ind  shrincg.shrincg_incmp_grde_over_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_incmp_date_over_type shrincg.shrincg_incmp_date_over_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_disp_web_ind         shrincg.shrincg_disp_web_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_system_req_ind       shrincg.shrincg_system_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id              shrincg.shrincg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_levl_code            shrincg.shrincg_levl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin          shrincg.shrincg_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                gb_common.internal_record_id_type DEFAULT NULL)

* Updates a record.
* @param p_primary_key Unique sequence number to identify the incomplete grade rule. NUMBER(9) Required Key
* @param p_term_code_eff Term code to identify when the incomplete grade rule becomes effective. VARCHAR2(6) Required
* @param p_incmp_grading_ind Indicator for whether incomplete grading logic is active for this rule. Valid values are "Y
" or "N". VARCHAR2(1) Required
 
* @param p_incmp_grde_over_ind Indicator for whether faculty can override the default incomplete final grades. Valid val
ues are "Y" or "N". VARCHAR2(1) Required
 
* @param p_incmp_date_over_type Indicator for whether instructors can override the extension date for incompletes. Value
s are "S"-allow only to shorten, "L"-allow only to lengthen, "A"-allow any date or "N"-not allowed. VARCHAR2(1) Required
 
 
* @param p_disp_web_ind Indicator for whether the default final grade and extension date are to be displayed on the web
for students with incomplete grades. Valid values are "Y" or "N". VARCHAR2(1) Required
 
* @param p_system_req_ind System required indicator. VARCHAR2(1) Required
* @param p_user_id ID of the user who inserted or last updated the data. VARCHAR2(30) Required
* @param p_levl_code Level code associated with a term; defines an incomplete grade rule. VARCHAR2(2)
* @param p_data_origin Source system that created or updated the row. VARCHAR2(30)
* @param p_rowid Database ROWID of the record to be updated. VARCHAR2(18)