index

Package sb_transfer_crse_cmt

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

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_crse_cmt_rec  
transfer_crse_cmt_ref  
transfer_crse_cmt_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(17) := 'TRANSFER_CRSE_CMT';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

transfer_crse_cmt_rec 

TYPE transfer_crse_cmt_rec IS RECORD (
  r_sbgi_code               shrtcmt.shrtcmt_sbgi_code%TYPE,
  r_program                 shrtcmt.shrtcmt_program%TYPE,
  r_tlvl_code               shrtcmt.shrtcmt_tlvl_code%TYPE,
  r_subj_code_trns          shrtcmt.shrtcmt_subj_code_trns%TYPE,
  r_crse_numb_trns          shrtcmt.shrtcmt_crse_numb_trns%TYPE,
  r_term_code_eff           shrtcmt.shrtcmt_term_code_eff%TYPE,
  r_seqno                   shrtcmt.shrtcmt_seqno%TYPE,
  r_text                    shrtcmt.shrtcmt_text%TYPE,
  r_group                   shrtcmt.shrtcmt_group%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

transfer_crse_cmt_ref 

TYPE transfer_crse_cmt_ref IS REF CURSOR RETURN transfer_crse_cmt_rec;

Entity cursor variable type

transfer_crse_cmt_tab 

TYPE transfer_crse_cmt_tab IS TABLE OF transfer_crse_cmt_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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                  p_program        shrtcmt.shrtcmt_program%TYPE,
                  p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                  p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                  p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                  p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                  p_seqno          shrtcmt.shrtcmt_seqno%TYPE,
                  p_group          shrtcmt.shrtcmt_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. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) 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_crse_cmt_rec,
                   rec_two transfer_crse_cmt_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_cmt_rec Required
rec_two   The second record to compare. Type transfer_crse_cmt_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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                     p_program        shrtcmt.shrtcmt_program%TYPE,
                     p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                     p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                     p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                     p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                     p_group          shrtcmt.shrtcmt_group%TYPE)
  RETURN transfer_crse_cmt_ref

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

Parameters
p_sbgi_code   Transferring institution. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) 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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                     p_program        shrtcmt.shrtcmt_program%TYPE,
                     p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                     p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                     p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                     p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                     p_seqno          shrtcmt.shrtcmt_seqno%TYPE,
                     p_group          shrtcmt.shrtcmt_group%TYPE)
  RETURN transfer_crse_cmt_ref

Selects one record using the key.

Parameters
p_sbgi_code   Transferring institution. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) 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_crse_cmt_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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                          p_program        shrtcmt.shrtcmt_program%TYPE,
                          p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                          p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                          p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                          p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                          p_seqno          shrtcmt.shrtcmt_seqno%TYPE,
                          p_group          shrtcmt.shrtcmt_group%TYPE,
                          p_rowid          gb_common.internal_record_id_type DEFAULT NULL)
  RETURN transfer_crse_cmt_ref

Selects one record and locks it.

Parameters
p_sbgi_code   Transferring institution. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) 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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                   p_program        shrtcmt.shrtcmt_program%TYPE,
                   p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                   p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                   p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                   p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                   p_seqno          shrtcmt.shrtcmt_seqno%TYPE,
                   p_text           shrtcmt.shrtcmt_text%TYPE DEFAULT NULL,
                   p_group          shrtcmt.shrtcmt_group%TYPE,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_sbgi_code   Transferring institution. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) Key
p_text   Text of a transfer course comment. VARCHAR2(60)
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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                   p_program        shrtcmt.shrtcmt_program%TYPE,
                   p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                   p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                   p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                   p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                   p_seqno          shrtcmt.shrtcmt_seqno%TYPE,
                   p_group          shrtcmt.shrtcmt_group%TYPE,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_sbgi_code   Transferring institution. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) 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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                 p_program        shrtcmt.shrtcmt_program%TYPE,
                 p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                 p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                 p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                 p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                 p_seqno          shrtcmt.shrtcmt_seqno%TYPE,
                 p_group          shrtcmt.shrtcmt_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. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) 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      shrtcmt.shrtcmt_sbgi_code%TYPE,
                   p_program        shrtcmt.shrtcmt_program%TYPE,
                   p_tlvl_code      shrtcmt.shrtcmt_tlvl_code%TYPE,
                   p_subj_code_trns shrtcmt.shrtcmt_subj_code_trns%TYPE,
                   p_crse_numb_trns shrtcmt.shrtcmt_crse_numb_trns%TYPE,
                   p_term_code_eff  shrtcmt.shrtcmt_term_code_eff%TYPE,
                   p_seqno          shrtcmt.shrtcmt_seqno%TYPE,
                   p_text           shrtcmt.shrtcmt_text%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_group          shrtcmt.shrtcmt_group%TYPE,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_sbgi_code   Transferring institution. VARCHAR2(6) Required Key
p_program   Degree program (if any) associated with the transfer course. VARCHAR2(12) Required Key
p_tlvl_code   Level associated with the transfer course. VARCHAR2(4) Required Key
p_subj_code_trns   Transfer subject. VARCHAR2(60) Required Key
p_crse_numb_trns   Transfer course. VARCHAR2(60) Required Key
p_term_code_eff   Transfer term effective associated with the transfer course. VARCHAR2(6) Required Key
p_seqno   Internal sequence number associated with each line of text. NUMBER(23,20) Key
p_text   Text of a transfer course comment. VARCHAR2(60)
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)