index

Package sb_transfer_equiv

This package provides the Common Business interface for the Transfer Equivalents API (sb_transfer_equiv).

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
transfer_equiv_rec  
transfer_equiv_ref  
transfer_equiv_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(14) := 'TRANSFER_EQUIV';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

transfer_equiv_rec 

TYPE transfer_equiv_rec IS RECORD (
  r_sbgi_code               shrtatc.shrtatc_sbgi_code%TYPE,
  r_program                 shrtatc.shrtatc_program%TYPE,
  r_tlvl_code               shrtatc.shrtatc_tlvl_code%TYPE,
  r_subj_code_trns          shrtatc.shrtatc_subj_code_trns%TYPE,
  r_crse_numb_trns          shrtatc.shrtatc_crse_numb_trns%TYPE,
  r_term_code_eff_trns      shrtatc.shrtatc_term_code_eff_trns%TYPE,
  r_seqno                   shrtatc.shrtatc_seqno%TYPE,
  r_connector               shrtatc.shrtatc_connector%TYPE,
  r_inst_lparen_conn        shrtatc.shrtatc_inst_lparen_conn%TYPE,
  r_subj_code_inst          shrtatc.shrtatc_subj_code_inst%TYPE,
  r_crse_numb_inst          shrtatc.shrtatc_crse_numb_inst%TYPE,
  r_inst_title              shrtatc.shrtatc_inst_title%TYPE,
  r_inst_credits_used       shrtatc.shrtatc_inst_credits_used%TYPE,
  r_inst_rparen             shrtatc.shrtatc_inst_rparen%TYPE,
  r_group                   shrtatc.shrtatc_group%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

transfer_equiv_ref 

TYPE transfer_equiv_ref IS REF CURSOR RETURN transfer_equiv_rec;

Entity cursor variable type

transfer_equiv_tab 

TYPE transfer_equiv_tab IS TABLE OF transfer_equiv_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          shrtatc.shrtatc_sbgi_code%TYPE,
                  p_program            shrtatc.shrtatc_program%TYPE,
                  p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                  p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                  p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                  p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                  p_seqno              shrtatc.shrtatc_seqno%TYPE,
                  p_group              shrtatc.shrtatc_group%TYPE,
                  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 the transferring course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transferring course. VARCHAR2(2) Required Key
p_subj_code_trns   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_seqno   Sequence number associated with the equivalent course. NUMBER(23,20) Required Key
p_group   Group of which the transfer subject and course has been designated a member. 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_equiv_rec, rec_two transfer_equiv_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_equiv_rec Required
rec_two   The second record to compare. Type transfer_equiv_rec Required

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

f_query_all 

Function f_query_all(p_sbgi_code          shrtatc.shrtatc_sbgi_code%TYPE,
                     p_program            shrtatc.shrtatc_program%TYPE,
                     p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                     p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                     p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                     p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                     p_group              shrtatc.shrtatc_group%TYPE)
  RETURN transfer_equiv_ref

Selects all records for the entity.
Does not use parameter p_seqno because multiples of this may exist for each parent record in SHRTATC.

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   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_group   Group of which the transfer subject and course has been designated a member. VARCHAR2(2) Key

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

f_query_one 

Function f_query_one(p_sbgi_code          shrtatc.shrtatc_sbgi_code%TYPE,
                     p_program            shrtatc.shrtatc_program%TYPE,
                     p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                     p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                     p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                     p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                     p_seqno              shrtatc.shrtatc_seqno%TYPE,
                     p_group              shrtatc.shrtatc_group%TYPE)
  RETURN transfer_equiv_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   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_seqno   Sequence number associated with the equivalent course. NUMBER(23,20) Required Key
p_group   Group of which the transfer subject and course has been designated a member. 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_equiv_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          shrtatc.shrtatc_sbgi_code%TYPE,
                          p_program            shrtatc.shrtatc_program%TYPE,
                          p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                          p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                          p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                          p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                          p_seqno              shrtatc.shrtatc_seqno%TYPE,
                          p_group              shrtatc.shrtatc_group%TYPE,
                          p_rowid              gb_common.internal_record_id_type DEFAULT NULL)
  RETURN transfer_equiv_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   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_seqno   Sequence number associated with the equivalent course. NUMBER(23,20) Required Key
p_group   Group of which the transfer subject and course has been designated a member. 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_create 

Procedure p_create(p_sbgi_code          shrtatc.shrtatc_sbgi_code%TYPE,
                   p_program            shrtatc.shrtatc_program%TYPE,
                   p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                   p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                   p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                   p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                   p_seqno              shrtatc.shrtatc_seqno%TYPE,
                   p_connector          shrtatc.shrtatc_connector%TYPE DEFAULT NULL,
                   p_inst_lparen_conn   shrtatc.shrtatc_inst_lparen_conn%TYPE DEFAULT NULL,
                   p_subj_code_inst     shrtatc.shrtatc_subj_code_inst%TYPE DEFAULT NULL,
                   p_crse_numb_inst     shrtatc.shrtatc_crse_numb_inst%TYPE DEFAULT NULL,
                   p_inst_title         shrtatc.shrtatc_inst_title%TYPE DEFAULT NULL,
                   p_inst_credits_used  shrtatc.shrtatc_inst_credits_used%TYPE DEFAULT NULL,
                   p_inst_rparen        shrtatc.shrtatc_inst_rparen%TYPE DEFAULT NULL,
                   p_group              shrtatc.shrtatc_group%TYPE,
                   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   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_seqno   Sequence number associated with the equivalent course. NUMBER(23,20) Required Key
p_connector   AND/OR connector.  A=And, O=Or. VARCHAR2(1)
p_inst_lparen_conn   Left parenthesis. VARCHAR2(1)
p_subj_code_inst   Institution equivalent subject code of the transferring subject. VARCHAR2(4)
p_crse_numb_inst   Institution equivalent course number of the transferring course. VARCHAR2(5)
p_inst_title   Institution equivalent title of the transferring course. VARCHAR2(30)
p_inst_credits_used   Default credit hours to be used when articulating the course. NUMBER(7,3)
p_inst_rparen   Right parenthesis. VARCHAR2(1)
p_group   Group of which the transfer subject and course has been designated a member. VARCHAR2(2) Key
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_sbgi_code          shrtatc.shrtatc_sbgi_code%TYPE,
                   p_program            shrtatc.shrtatc_program%TYPE,
                   p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                   p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                   p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                   p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                   p_seqno              shrtatc.shrtatc_seqno%TYPE,
                   p_group              shrtatc.shrtatc_group%TYPE,
                   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   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_seqno   Sequence number associated with the equivalent course. NUMBER(23,20) Required Key
p_group   Group of which the transfer subject and course has been designated a member. VARCHAR2(2) Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_sbgi_code          shrtatc.shrtatc_sbgi_code%TYPE,
                 p_program            shrtatc.shrtatc_program%TYPE,
                 p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                 p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                 p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                 p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                 p_seqno              shrtatc.shrtatc_seqno%TYPE,
                 p_group              shrtatc.shrtatc_group%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_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   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_seqno   Sequence number associated with the equivalent course. NUMBER(23,20) Required Key
p_group   Group of which the transfer subject and course has been designated a member. 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          shrtatc.shrtatc_sbgi_code%TYPE,
                   p_program            shrtatc.shrtatc_program%TYPE,
                   p_tlvl_code          shrtatc.shrtatc_tlvl_code%TYPE,
                   p_subj_code_trns     shrtatc.shrtatc_subj_code_trns%TYPE,
                   p_crse_numb_trns     shrtatc.shrtatc_crse_numb_trns%TYPE,
                   p_term_code_eff_trns shrtatc.shrtatc_term_code_eff_trns%TYPE,
                   p_seqno              shrtatc.shrtatc_seqno%TYPE,
                   p_connector          shrtatc.shrtatc_connector%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_inst_lparen_conn   shrtatc.shrtatc_inst_lparen_conn%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_subj_code_inst     shrtatc.shrtatc_subj_code_inst%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_crse_numb_inst     shrtatc.shrtatc_crse_numb_inst%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_inst_title         shrtatc.shrtatc_inst_title%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_inst_credits_used  shrtatc.shrtatc_inst_credits_used%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_inst_rparen        shrtatc.shrtatc_inst_rparen%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_group              shrtatc.shrtatc_group%TYPE,
                   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   Transferring subject code. VARCHAR2(60) Required Key
p_crse_numb_trns   Transferring course number. VARCHAR2(60) Required Key
p_term_code_eff_trns   Transferring effective term associated with the course. VARCHAR2(6) Required Key
p_seqno   Sequence number associated with the equivalent course. NUMBER(23,20) Required Key
p_connector   AND/OR connector.  A=And, O=Or. VARCHAR2(1)
p_inst_lparen_conn   Left parenthesis. VARCHAR2(1)
p_subj_code_inst   Institution equivalent subject code of the transferring subject. VARCHAR2(4)
p_crse_numb_inst   Institution equivalent course number of the transferring course. VARCHAR2(5)
p_inst_title   Institution equivalent title of the transferring course. VARCHAR2(30)
p_inst_credits_used   Default credit hours to be used when articulating the course. NUMBER(7,3)
p_inst_rparen   Right parenthesis. VARCHAR2(1)
p_group   Group of which the transfer subject and course has been designated a member. VARCHAR2(2) Key
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)