index

Package sb_fieldofstudy_allowed

This package provides the Common Business interface for the Field of Study Maximum Current and Active API (sb_fieldofstudy_allowed).
 
This defines the maximum current and active field of study allowed for a curriculum and learner module. The number of current and active fields of study is validated when new rows are added to the SORLFOS table.
 
This table allows entry of a zero for all non-major type fields of study.
The Number Allowed column is the only updateable field on rows that are marked system required. System-required rows cannot be deleted.

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

Types
fieldofstudy_allowed_rec  
fieldofstudy_allowed_ref  
fieldofstudy_allowed_tab  

Constants
M_ENTITY_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(20) := 'FIELDOFSTUDY_ALLOWED';

Business Entity Name

fieldofstudy_allowed_rec 

TYPE fieldofstudy_allowed_rec IS RECORD (
  r_lmod_code               sorlmfs.sorlmfs_lmod_code%TYPE,
  r_lfst_code               sorlmfs.sorlmfs_lfst_code%TYPE,
  r_tran_web_ind            sorlmfs.sorlmfs_tran_web_ind%TYPE,
  r_sys_req_ind             sorlmfs.sorlmfs_sys_req_ind%TYPE,
  r_max_number              sorlmfs.sorlmfs_max_number%TYPE,
  r_user_id                 sorlmfs.sorlmfs_user_id%TYPE,
  r_data_origin             sorlmfs.sorlmfs_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

fieldofstudy_allowed_ref 

TYPE fieldofstudy_allowed_ref IS REF CURSOR RETURN fieldofstudy_allowed_rec;

Entity cursor variable type

fieldofstudy_allowed_tab 

TYPE fieldofstudy_allowed_tab IS TABLE OF fieldofstudy_allowed_rec INDEX BY BINARY_INTEGER;

Entity Field of Study Allowed

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_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) 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                     fieldofstudy_allowed_rec,
    rec_two                     fieldofstudy_allowed_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 fieldofstudy_allowed_rec Required
rec_two   The second record to compare. Type fieldofstudy_allowed_rec Required

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

f_query_all 

Function f_query_all(
    p_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE DEFAULT NULL) RETURN fieldofstudy_allowed_ref

Selects all records for the entity.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) Required Key

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

f_query_one 

Function f_query_one(
    p_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE) RETURN fieldofstudy_allowed_ref

Selects one record using the key.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) 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 fieldofstudy_allowed_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_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN fieldofstudy_allowed_ref

Selects one record and locks it.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) 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_get_count 

Function f_get_count(
    p_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE, 
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE) RETURN NUMBER

Selects the number allowed for a field of study and learner module and returns the field number allowed.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) Required Key

Returns
Y/N value.

p_create 

Procedure p_create(
    p_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE,
    p_tran_web_ind              sorlmfs.sorlmfs_tran_web_ind%TYPE,
    p_sys_req_ind               sorlmfs.sorlmfs_sys_req_ind%TYPE,
    p_max_number                sorlmfs.sorlmfs_max_number%TYPE,
    p_user_id                   sorlmfs.sorlmfs_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_data_origin               sorlmfs.sorlmfs_data_origin%TYPE,
    p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) Required Key
p_tran_web_ind   Y/N indicator for whether the field of study will be printed on the transcript. VARCHAR2(1) Required
p_sys_req_ind   Y/N indicator for whether the curriculum module is required. VARCHAR2(1) Required
p_max_number   Count of current and active fields of study per module. NUMBER(8) Required
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_data_origin   Data origin of the insert or update to the record. VARCHAR2(30) Required
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(
    p_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.
Delete is not allowed if the system required indicator is Y.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(
    p_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE,
    p_rowid_inout        IN OUT 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 the p_rowid_inout.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(
    p_lmod_code                 sorlmfs.sorlmfs_lmod_code%TYPE,
    p_lfst_code                 sorlmfs.sorlmfs_lfst_code%TYPE,
    p_tran_web_ind              sorlmfs.sorlmfs_tran_web_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_sys_req_ind               sorlmfs.sorlmfs_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_max_number                sorlmfs.sorlmfs_max_number%TYPE DEFAULT dml_common.f_unspecified_number,
    p_user_id                   sorlmfs.sorlmfs_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_data_origin               sorlmfs.sorlmfs_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.
If the system required indicator is Y, the only updateable column is the maximum number allowed.

Parameters
p_lmod_code   Banner learner module code. VARCHAR2(15) Required Key
p_lfst_code   Learner field of study type code. VARCHAR2(15) Required Key
p_tran_web_ind   Y/N indicator for whether the field of study will be printed on the transcript. VARCHAR2(1) Required
p_sys_req_ind   Y/N indicator for whether the curriculum module is required. VARCHAR2(1) Required
p_max_number   Count of current and active fields of study per module. NUMBER(8) Required
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_data_origin   Data origin of the insert or update to the record. VARCHAR2(30) Required
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)