index

Package sb_transcript_name

Common Business interface for the Transcript Type Name Hierarchy API (sb_transcript_name).
 
This hierarchy defines the name that will be printed on the transcript.
 
If there is no name match found or no hierarchy entered for the type, the learner¿s current name is used for the transcript.
 
If the transcript is an EDI transcript, the hierarchy rules for sources that are not allowed for EDI are ignored.
 
An EDI transcript requires a last and first name.
 
Name sources such as the legal and diploma do not have these two pieces separated and cannot be used on an EDI transcript.
 
The degree with the most recent graduation date or term will be used to select the diploma name if the transcript source is diploma.
 
If no graduation information is available, the diploma name will not be selected.

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
transcript_name_rec  
transcript_name_ref  
transcript_name_tab  

Constants
M_ENTITY_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(15) := 'TRANSCRIPT_NAME';

Business Entity Name

transcript_name_rec 

TYPE transcript_name_rec IS RECORD (
  r_tprt_code               shrtrnm.shrtrnm_tprt_code%TYPE,
  r_name_seqno              shrtrnm.shrtrnm_name_seqno%TYPE,
  r_trns_code               shrtrnm.shrtrnm_trns_code%TYPE,
  r_user_id                 shrtrnm.shrtrnm_user_id%TYPE,
  r_data_origin             shrtrnm.shrtrnm_data_origin%TYPE,
  r_ntyp_code               shrtrnm.shrtrnm_ntyp_code%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

transcript_name_ref 

TYPE transcript_name_ref IS REF CURSOR RETURN transcript_name_rec;

Entity cursor variable type

transcript_name_tab 

TYPE transcript_name_tab IS TABLE OF transcript_name_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_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) 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                     transcript_name_rec,
    rec_two                     transcript_name_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 transcript_name_rec Required
rec_two   The second record to compare. Type transcript_name_rec Required

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

f_query_all 

Function f_query_all(
    p_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE DEFAULT NULL) RETURN transcript_name_ref

Selects all records for the entity.

Parameters
p_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) Optional

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

f_query_one 

Function f_query_one(
    p_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE) RETURN transcript_name_ref

Selects one record using the key.

Parameters
p_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) 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 transcript_name_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_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN transcript_name_ref

Selects one record and locks it.

Parameters
p_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) Required 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_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE,
    p_trns_code                 shrtrnm.shrtrnm_trns_code%TYPE,
    p_user_id                   shrtrnm.shrtrnm_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_data_origin               shrtrnm.shrtrnm_data_origin%TYPE,
    p_ntyp_code                 shrtrnm.shrtrnm_ntyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
    p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) Required Key
p_trns_code   Source of name from Banner that is to be printed on the transcript. VARCHAR2(10) 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_ntyp_code   Name type code for sources that require a name type. VARCHAR2(4)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(
    p_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(
    p_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE,
    p_rowid_inout        IN OUT gb_common.internal_record_id_type)

Locks a record.
If 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_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(
    p_tprt_code                 shrtrnm.shrtrnm_tprt_code%TYPE,
    p_name_seqno                shrtrnm.shrtrnm_name_seqno%TYPE,
    p_trns_code                 shrtrnm.shrtrnm_trns_code%TYPE DEFAULT dml_common.f_unspecified_string,
    p_user_id                   shrtrnm.shrtrnm_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_data_origin               shrtrnm.shrtrnm_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
    p_ntyp_code                 shrtrnm.shrtrnm_ntyp_code%TYPE DEFAULT dml_common.f_unspecified_string,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_tprt_code   Transcript type code. VARCHAR2(4) Required Key
p_name_seqno   Priority order in which the name sources are to be used. NUMBER(4) Required Key
p_trns_code   Source of name from Banner that is to be printed on the transcript. VARCHAR2(10) 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_ntyp_code   Name type code for sources that require a name type. VARCHAR2(4)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)