index

Package sb_transfer_crse_attr

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

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

Types
transfer_crse_attr_rec  
transfer_crse_attr_ref  
transfer_crse_attr_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(18) := 'TRANSFER_CRSE_ATTR';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

transfer_crse_attr_rec 

TYPE transfer_crse_attr_rec IS RECORD (
  r_primary_key             shrtcat.shrtcat_primary_key%TYPE,
  r_sbgi_code               shrtcat.shrtcat_sbgi_code%TYPE,
  r_program                 shrtcat.shrtcat_program%TYPE,
  r_tlvl_code               shrtcat.shrtcat_tlvl_code%TYPE,
  r_subj_cde_trns           shrtcat.shrtcat_subj_cde_trns%TYPE,
  r_crse_numb_trns          shrtcat.shrtcat_crse_numb_trns%TYPE,
  r_term_code_eff_trns      shrtcat.shrtcat_term_code_eff_trns%TYPE,
  r_attr_cde                shrtcat.shrtcat_attr_cde%TYPE,
  r_attr_desc               shrtcat.shrtcat_attr_desc%TYPE,
  r_user_id                 shrtcat.shrtcat_user_id%TYPE,
  r_group                   shrtcat.shrtcat_group%TYPE,
  r_data_origin             shrtcat.shrtcat_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

transfer_crse_attr_ref 

TYPE transfer_crse_attr_ref IS REF CURSOR RETURN transfer_crse_attr_rec;

Entity cursor variable type

transfer_crse_attr_tab 

TYPE transfer_crse_attr_tab IS TABLE OF transfer_crse_attr_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        shrtcat.shrtcat_primary_key%TYPE DEFAULT NULL,
                  p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE DEFAULT NULL,
                  p_program            shrtcat.shrtcat_program%TYPE DEFAULT NULL,
                  p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE DEFAULT NULL,
                  p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE DEFAULT NULL,
                  p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE DEFAULT NULL,
                  p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE DEFAULT NULL,
                  p_attr_cde           shrtcat.shrtcat_attr_cde%TYPE DEFAULT NULL,
                  p_group              shrtcat.shrtcat_group%TYPE DEFAULT NULL,
                  p_rowid              gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Check to see if at least one primary key or unique key record exists

Parameters
p_primary_key   Primary key of the transfer course record. NUMBER(9) Key
p_sbgi_code   Transferring institution code. VARCHAR2(6) Key
p_program   Degree program (if any) associated with transferring course. VARCHAR2(12) Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Key
p_term_code_eff_trns   Effective term of transferring course. VARCHAR2(6) Key
p_attr_cde   Attribute code of the transferring course. VARCHAR2(4) 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)

f_isequal 

Function f_isequal(rec_one transfer_crse_attr_rec,
                   rec_two transfer_crse_attr_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_attr_rec Required
rec_two   The second record to compare. Type transfer_crse_attr_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 shrtcat.shrtcat_primary_key%TYPE)
  RETURN transfer_crse_attr_ref

Selects all records for the entity.

Parameters
p_primary_key   Primary key of the transfer course record. NUMBER(9) Required Key

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

f_query_all 

Function f_query_all(p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE,
                     p_program            shrtcat.shrtcat_program%TYPE,
                     p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE,
                     p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE,
                     p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE,
                     p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE,
                     p_group              shrtcat.shrtcat_group%TYPE DEFAULT NULL)
  RETURN transfer_crse_attr_ref

Selects all records for the entity matching the unique key.

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 transferring course. VARCHAR2(6) Required Key
p_group   Group connector for many to one transfer course relationships. VARCHAR2(2) Key

f_query_one 

Function f_query_one(p_primary_key        shrtcat.shrtcat_primary_key%TYPE DEFAULT NULL,
                     p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE DEFAULT NULL,
                     p_program            shrtcat.shrtcat_program%TYPE DEFAULT NULL,
                     p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE DEFAULT NULL,
                     p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE DEFAULT NULL,
                     p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE DEFAULT NULL,
                     p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE DEFAULT NULL,
                     p_attr_cde           shrtcat.shrtcat_attr_cde%TYPE DEFAULT NULL,
                     p_group              shrtcat.shrtcat_group%TYPE DEFAULT NULL)
  RETURN transfer_crse_attr_ref

Selects one record for the entity matching either the primary key or the unique key.

Parameters
p_primary_key   Primary key of the transfer course record. NUMBER(9) Key
p_sbgi_code   Transferring institution code. VARCHAR2(6) Key
p_program   Degree program (if any) associated with transferring course. VARCHAR2(12) Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Key
p_term_code_eff_trns   Effective term of transferring course. VARCHAR2(6) Key
p_attr_cde   Attribute code of the transferring course. VARCHAR2(4) Key
p_group   Group connector for many to one transfer course relationships. VARCHAR2(2) Key

f_query_by_rowid 

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN transfer_crse_attr_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 shrtcat.shrtcat_primary_key%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN transfer_crse_attr_ref

Selects one record and locks it.

Parameters
p_primary_key   Primary key of the transfer course record. 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.

f_query_one_lock 

Function f_query_one_lock(p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE,
                          p_program            shrtcat.shrtcat_program%TYPE,
                          p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE,
                          p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE,
                          p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE,
                          p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE,
                          p_attr_cde           shrtcat.shrtcat_attr_cde%TYPE DEFAULT NULL,
                          p_group              shrtcat.shrtcat_group%TYPE DEFAULT NULL,
                          p_rowid              gb_common.internal_record_id_type DEFAULT NULL)
  RETURN transfer_crse_attr_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 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 transferring course. VARCHAR2(6) Required Key
p_attr_cde   Attribute code of the transferring course. VARCHAR2(4) Required Key
p_group   Group connector for many to one transfer course relationships. VARCHAR2(2) Key

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

p_create 

Procedure p_create(p_primary_key        OUT shrtcat.shrtcat_primary_key%TYPE,
                   p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE,
                   p_program            shrtcat.shrtcat_program%TYPE,
                   p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE,
                   p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE,
                   p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE,
                   p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE,
                   p_attr_cde           shrtcat.shrtcat_attr_cde%TYPE,
                   p_attr_desc          shrtcat.shrtcat_attr_desc%TYPE,
                   p_user_id            shrtcat.shrtcat_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_group              shrtcat.shrtcat_group%TYPE DEFAULT NULL,
                   p_data_origin        shrtcat.shrtcat_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out          OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_primary_key   Generated primary key of the transfer course record. NUMBER(9) Required
p_sbgi_code   Sending institutions ID code. VARCHAR2(6) Required
p_program   Program code associated with the transfer course. VARCHAR2(12) Required
p_tlvl_code   Level code of the transfer course. VARCHAR2(2) Required
p_subj_cde_trns   Subject code of the transfer course. VARCHAR2(60) Required
p_crse_numb_trns   Course number of the transfer course. VARCHAR2(60) Required
p_term_code_eff_trns   Effective term of the transfer course. VARCHAR2(6) Required
p_attr_cde   Attribute code of the transfer course. VARCHAR2(4) Required
p_attr_desc   Description of the attribute code of the transfer course. VARCHAR2(30) Required
p_user_id   User ID of the user who created or last updated the record. VARCHAR2(30) Required
p_group   Group code associated with the transfer course. VARCHAR2(2)
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_primary_key        shrtcat.shrtcat_primary_key%TYPE DEFAULT NULL,
                   p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE DEFAULT NULL,
                   p_program            shrtcat.shrtcat_program%TYPE DEFAULT NULL,
                   p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE DEFAULT NULL,
                   p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE DEFAULT NULL,
                   p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE DEFAULT NULL,
                   p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE DEFAULT NULL,
                   p_attr_cde           shrtcat.shrtcat_attr_cde%TYPE DEFAULT NULL,
                   p_group              shrtcat.shrtcat_group%TYPE DEFAULT NULL,
                   p_rowid              gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_primary_key   Primary key of the transfer course record. NUMBER(9) Key
p_sbgi_code   Transferring institution code. VARCHAR2(6) Key
p_program   Degree program (if any) associated with transferring course. VARCHAR2(12) Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Key
p_subj_code_trns   Subject code of the transferring course. VARCHAR2(60) Key
p_crse_numb_trns   Course number of the transferring course. VARCHAR2(60) Key
p_term_code_eff_trns   Effective term of transferring course. VARCHAR2(6) Key
p_attr_cde   Attribute code of the transferring course. VARCHAR2(4) 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_primary_key shrtcat.shrtcat_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   Primary key of the transfer course record. NUMBER(9) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_lock 

Procedure p_lock(p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE,
                 p_program            shrtcat.shrtcat_program%TYPE,
                 p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE,
                 p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE,
                 p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE,
                 p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE,
                 p_attr_cde           shrtcat.shrtcat_attr_cde%TYPE DEFAULT NULL,
                 p_group              shrtcat.shrtcat_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 unique 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 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 transferring course. VARCHAR2(6) Required Key
p_attr_cde   Attribute code of the transferring course. VARCHAR2(4) 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_primary_key        shrtcat.shrtcat_primary_key%TYPE DEFAULT NULL,
                   p_sbgi_code          shrtcat.shrtcat_sbgi_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_program            shrtcat.shrtcat_program%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_tlvl_code          shrtcat.shrtcat_tlvl_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_subj_cde_trns      shrtcat.shrtcat_subj_cde_trns%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_crse_numb_trns     shrtcat.shrtcat_crse_numb_trns%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_eff_trns shrtcat.shrtcat_term_code_eff_trns%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_cde           shrtcat.shrtcat_attr_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_desc          shrtcat.shrtcat_attr_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id            shrtcat.shrtcat_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_group              shrtcat.shrtcat_group%TYPE DEFAULT NULL,
                   p_data_origin        shrtcat.shrtcat_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid              gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_primary_key   Primary key of the transfer course record. NUMBER(9) Required Key
p_sbgi_code   Sending institutions ID code. VARCHAR2(6) Required
p_program   Program code associated with the transfer course. VARCHAR2(12) Required
p_tlvl_code   Level code of the transfer course. VARCHAR2(2) Required
p_subj_cde_trns   Subject code of the transfer course. VARCHAR2(60) Required
p_crse_numb_trns   Course number of the transfer course. VARCHAR2(60) Required
p_term_code_eff_trns   Effective term of the transfer course. VARCHAR2(6) Required
p_attr_cde   Attribute code of the transfer course. VARCHAR2(4) Required
p_attr_desc   Description of the attribute code of the transfer course. VARCHAR2(30) Required
p_user_id   User ID of the user who created or last updated the record. VARCHAR2(30) Required
p_group   Group code associated with the transfer course. VARCHAR2(2)
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)