index

Package sb_transfer_crse

This package provides the Common Business interface for the Transfer Course API (sb_transfer_crse).

Program units
f_api_version  
f_exists  
f_isequal  
f_partial_match  
f_partial_match_term  
f_query_partial  
f_query_all  
f_query_one  
f_query_by_rowid  
f_query_one_lock  
p_default_copy  
p_default_copy_equiv  
p_create  
p_delete  
p_lock  
p_update  

Types
transfer_crse_rec  
transfer_crse_ref  
transfer_crse_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

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

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

transfer_crse_rec 

TYPE transfer_crse_rec IS RECORD (
  r_sbgi_code               shbtatc.shbtatc_sbgi_code%TYPE,
  r_program                 shbtatc.shbtatc_program%TYPE,
  r_tlvl_code               shbtatc.shbtatc_tlvl_code%TYPE,
  r_subj_code_trns          shbtatc.shbtatc_subj_code_trns%TYPE,
  r_crse_numb_trns          shbtatc.shbtatc_crse_numb_trns%TYPE,
  r_term_code_eff_trns      shbtatc.shbtatc_term_code_eff_trns%TYPE,
  r_trns_title              shbtatc.shbtatc_trns_title%TYPE,
  r_trns_low_hrs            shbtatc.shbtatc_trns_low_hrs%TYPE,
  r_trns_high_hrs           shbtatc.shbtatc_trns_high_hrs%TYPE,
  r_trns_review_ind         shbtatc.shbtatc_trns_review_ind%TYPE,
  r_tast_code               shbtatc.shbtatc_tast_code%TYPE,
  r_trns_catalog            shbtatc.shbtatc_trns_catalog%TYPE,
  r_tgrd_code_min           shbtatc.shbtatc_tgrd_code_min%TYPE,
  r_group                   shbtatc.shbtatc_group%TYPE,
  r_group_primary_ind       shbtatc.shbtatc_group_primary_ind%TYPE,
  r_protect_ind             shbtatc.shbtatc_protect_ind%TYPE,
  r_crse_desc               shbtatc.shbtatc_crse_desc%TYPE,
  r_user_id                 shbtatc.shbtatc_user_id%TYPE,
  r_data_origin             shbtatc.shbtatc_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

transfer_crse_ref 

TYPE transfer_crse_ref IS REF CURSOR RETURN transfer_crse_rec;

Entity cursor variable type

transfer_crse_tab 

TYPE transfer_crse_tab IS TABLE OF transfer_crse_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_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                  p_program            shbtatc.shbtatc_program%TYPE,
                  p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                  p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                  p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                  p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE,
                  p_group              shbtatc.shbtatc_group%TYPE DEFAULT NULL,
                  p_rowid              gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key
p_group   Group connector for many-to-one transfer course relationships. VARCHAR2(2) 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 transfer_crse_rec, rec_two transfer_crse_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 transfer_crse_rec Required
rec_two   The second record to compare. Type transfer_crse_rec Required

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

f_partial_match 

Function f_partial_match(p_sbgi_code      shbtatc.shbtatc_sbgi_code%TYPE,
                         p_tlvl_code      shbtatc.shbtatc_tlvl_code%TYPE,
                         p_subj_code_trns shbtatc.shbtatc_subj_code_trns%TYPE,
                         p_crse_numb_trns shbtatc.shbtatc_crse_numb_trns%TYPE)
  RETURN VARCHAR2

Checks if a record exists that partially matches an incoming record.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6)
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2)
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60)
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60)

Returns
Y if found, otherwise N.

f_partial_match_term 

Function f_partial_match_term(p_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                              p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                              p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                              p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                              p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE)
  RETURN VARCHAR2

Checks if a record exists that partially matches an incoming record.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6)
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2)
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60)
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60)
p_term_code_eff_trns   Term code of the transferring course. VARCHAR2(6)

Returns
Y if found, otherwise N.

f_query_partial 

Function f_query_partial(p_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                         p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                         p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                         p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                         p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE)
  RETURN transfer_crse_ref

Selects all records that partially match the incoming record for a term.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key

Returns
A cursor variable that will fetch all records for a term that do not have the default program and group fields applied.

f_query_all 

Function f_query_all(p_sbgi_code shbtatc.shbtatc_sbgi_code%TYPE,
                     p_program   shbtatc.shbtatc_program%TYPE DEFAULT NULL)
  RETURN transfer_crse_ref

Selects all records for the entity for a given institution.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12)

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

f_query_one 

Function f_query_one(p_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                     p_program            shbtatc.shbtatc_program%TYPE,
                     p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                     p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                     p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                     p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE,
                     p_group              shbtatc.shbtatc_group%TYPE DEFAULT NULL)
  RETURN transfer_crse_ref

Selects one record using the key.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key
p_group   Group connector for many-to-one transfer course relationships. VARCHAR2(2) 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 transfer_crse_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_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                          p_program            shbtatc.shbtatc_program%TYPE,
                          p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                          p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                          p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                          p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE,
                          p_group              shbtatc.shbtatc_group%TYPE DEFAULT NULL,
                          p_rowid              gb_common.internal_record_id_type DEFAULT NULL)
  RETURN transfer_crse_ref

Selects one record and locks it.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key
p_group   Group connector for many-to-one transfer course relationships. VARCHAR2(2) Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.

p_default_copy 

Procedure p_default_copy(p_sbgi_code_def shbtatc.shbtatc_sbgi_code%TYPE,
                         p_sbgi_code     shbtatc.shbtatc_sbgi_code%TYPE,
                         p_program       shbtatc.shbtatc_program%TYPE DEFAULT NULL,
                         p_copy_comments VARCHAR2 DEFAULT 'N',
                         p_count_only    VARCHAR2 DEFAULT 'N',
                         p_count_out     OUT NUMBER)

Copies all course records from the default to a new institution, optionally including attributes and comments.
If program is specified, only records with that program will be copied.

Parameters
p_sbgi_code_def   Transferring institution code to be copied. VARCHAR2(6) Required
p_sbgi_code   New transferring institution code. VARCHAR2(6) Required
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12)
p_copy_comments   Indicator for whether comments/attributes associated with the transferring course are to be copied. VARCHAR2(1)

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

p_default_copy_equiv 

Procedure p_default_copy_equiv(p_sbgi_code_def shbtatc.shbtatc_sbgi_code%TYPE,
                               p_sbgi_code     shbtatc.shbtatc_sbgi_code%TYPE,
                               p_program       shbtatc.shbtatc_program%TYPE DEFAULT NULL,
                               p_copy_comments VARCHAR2 DEFAULT 'N')

Copies all equivalency records from the default to a new institution, optionally including attributes and comments.
If program is specified, only records with that program will be copied.

Parameters
p_sbgi_code_def   Transferring institution code to be copied. VARCHAR2(6) Required
p_sbgi_code   New transferring institution code. VARCHAR2(6) Required
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12)
p_copy_comments   Indicator for whether comments/attributes associated with the transferring course are to be copied. VARCHAR2(1)

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

p_create 

Procedure p_create(p_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                   p_program            shbtatc.shbtatc_program%TYPE,
                   p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                   p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                   p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                   p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE,
                   p_trns_title         shbtatc.shbtatc_trns_title%TYPE,
                   p_trns_low_hrs       shbtatc.shbtatc_trns_low_hrs%TYPE DEFAULT NULL,
                   p_trns_high_hrs      shbtatc.shbtatc_trns_high_hrs%TYPE DEFAULT NULL,
                   p_trns_review_ind    shbtatc.shbtatc_trns_review_ind%TYPE DEFAULT NULL,
                   p_tast_code          shbtatc.shbtatc_tast_code%TYPE,
                   p_trns_catalog       shbtatc.shbtatc_trns_catalog%TYPE DEFAULT NULL,
                   p_tgrd_code_min      shbtatc.shbtatc_tgrd_code_min%TYPE DEFAULT NULL,
                   p_group              shbtatc.shbtatc_group%TYPE DEFAULT NULL,
                   p_group_primary_ind  shbtatc.shbtatc_group_primary_ind%TYPE DEFAULT NULL,
                   p_protect_ind        shbtatc.shbtatc_protect_ind%TYPE DEFAULT 'N',
                   p_crse_desc          shbtatc.shbtatc_crse_desc%TYPE DEFAULT NULL,
                   p_user_id            shbtatc.shbtatc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin        shbtatc.shbtatc_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out          OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key
p_trns_title   Course title of the transferring course. VARCHAR2(30) Required
p_trns_low_hrs   Transferring course low hours. NUMBER(7,3)
p_trns_high_hrs   Transferring course high hours. NUMBER(7,3)
p_trns_review_ind   Transferring review indicator.  Y means the course has equivalent(s), N means the course has no equivalents, null means the course has not yet been reviewed. VARCHAR2(1)
p_tast_code   Status of the transferring course. VARCHAR2(2) Required
p_trns_catalog   Transferring source catalog. VARCHAR2(4)
p_tgrd_code_min   Minimum transfer grade allowed for the course. VARCHAR2(6)
p_group   Group connector for many-to-one transfer course relationships. VARCHAR2(2) Key
p_group_primary_ind   Group primary indicator.  Must be Y or null.  Only one per group is allowed. VARCHAR2(1)
p_protect_ind   Indicator for whether to protect from import process updates.  Must be Y or N.  VARCHAR2(1)
p_crse_desc   Narrative text that provides more descriptive information than can fit into the title field. CLOB
p_user_id   User ID of the user who created or last updated the record. VARCHAR2(30)
p_data_origin   Source system that created 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_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                   p_program            shbtatc.shbtatc_program%TYPE,
                   p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                   p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                   p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                   p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE,
                   p_group              shbtatc.shbtatc_group%TYPE DEFAULT NULL,
                   p_rowid              gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key
p_group   Group connector for many-to-one transfer course relationships. VARCHAR2(2) Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                 p_program            shbtatc.shbtatc_program%TYPE,
                 p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                 p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                 p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                 p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE,
                 p_group              shbtatc.shbtatc_group%TYPE DEFAULT NULL,
                 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_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key
p_group   Group connector for many-to-one transfer course relationships. VARCHAR2(2) Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_sbgi_code          shbtatc.shbtatc_sbgi_code%TYPE,
                   p_program            shbtatc.shbtatc_program%TYPE,
                   p_tlvl_code          shbtatc.shbtatc_tlvl_code%TYPE,
                   p_subj_code_trns     shbtatc.shbtatc_subj_code_trns%TYPE,
                   p_crse_numb_trns     shbtatc.shbtatc_crse_numb_trns%TYPE,
                   p_term_code_eff_trns shbtatc.shbtatc_term_code_eff_trns%TYPE,
                   p_trns_title         shbtatc.shbtatc_trns_title%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trns_low_hrs       shbtatc.shbtatc_trns_low_hrs%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trns_high_hrs      shbtatc.shbtatc_trns_high_hrs%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_trns_review_ind    shbtatc.shbtatc_trns_review_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tast_code          shbtatc.shbtatc_tast_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_trns_catalog       shbtatc.shbtatc_trns_catalog%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tgrd_code_min      shbtatc.shbtatc_tgrd_code_min%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_group              shbtatc.shbtatc_group%TYPE DEFAULT NULL,
                   p_group_primary_ind  shbtatc.shbtatc_group_primary_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_protect_ind        shbtatc.shbtatc_protect_ind%TYPE DEFAULT 'N',
                   p_crse_desc          shbtatc.shbtatc_crse_desc%TYPE DEFAULT dml_common.f_unspecified_clob,
                   p_user_id            shbtatc.shbtatc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin        shbtatc.shbtatc_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid              gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_sbgi_code   Transferring institution code. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Required Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Required Key
p_term_code_eff_trns   Effective term of the transferring course. VARCHAR2(6) Required Key
p_trns_title   Course title of the transferring course. VARCHAR2(30) Required
p_trns_low_hrs   Transferring course low hours. NUMBER(7,3)
p_trns_high_hrs   Transferring course high hours. NUMBER(7,3)
p_trns_review_ind   Transferring review indicator.  Y means the course has equivalent(s), N means the course has no equivalents, null means the course has not yet been reviewed. VARCHAR2(1)
p_tast_code   Status of the transferring course. VARCHAR2(2) Required
p_trns_catalog   Transferring source catalog. VARCHAR2(4)
p_tgrd_code_min   Minimum transfer grade allowed for the course. VARCHAR2(6)
p_group   Group connector for many-to-one transfer course relationships. VARCHAR2(2) Key
p_group_primary_ind   Group primary indicator.  Must be Y or null.  Only one per group allowed. VARCHAR2(1)
p_protect_ind   Indicator for whether to protect from import process updates.  Must be Y or N.  VARCHAR2(1)
p_crse_desc   Narrative text that provides more descriptive information than can fit into the title field. CLOB
p_user_id   User ID of the user who created or last updated the record. VARCHAR2(30)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)