index

Package sb_transcript_name_source

This package provides the Common Business interface for the Transcript Name Source API (sb_transcript_name_source).
This has the restrictions for the name sources that are available for selecting names for the transcript. The rules include whether the name source can be used for an EDI transcript or if the name requires additional degree information.
There is also an indicator for whether the name allows entry of a name type. Only the names from the SPRIDEN table allow association with a name type. System-required rows are not updateable nor can they be deleted.

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_source_rec  
transcript_name_source_ref  
transcript_name_source_tab  

Constants
M_ENTITY_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(22) := 'TRANSCRIPT_NAME_SOURCE';

Business Entity Name.

transcript_name_source_rec 

TYPE transcript_name_source_rec IS RECORD (
  r_trns_code               shrtrns.shrtrns_trns_code%TYPE,
  r_sys_req_ind             shrtrns.shrtrns_sys_req_ind%TYPE,
  r_edi_ind                 shrtrns.shrtrns_edi_ind%TYPE,
  r_ntyp_ind                shrtrns.shrtrns_ntyp_ind%TYPE,
  r_degr_ind                shrtrns.shrtrns_degr_ind%TYPE,
  r_data_origin             shrtrns.shrtrns_data_origin%TYPE,
  r_user_id                 shrtrns.shrtrns_user_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type.

transcript_name_source_ref 

TYPE transcript_name_source_ref IS REF CURSOR RETURN transcript_name_source_rec;

Entity cursor variable type.

transcript_name_source_tab 

TYPE transcript_name_source_tab IS TABLE OF transcript_name_source_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_trns_code                 shrtrns.shrtrns_trns_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) 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_source_rec,
    rec_two                     transcript_name_source_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_source_rec Required
rec_two   The second record to compare. Type transcript_name_source_rec Required

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

f_query_all 

Function f_query_all(
    p_trns_code                 shrtrns.shrtrns_trns_code%TYPE DEFAULT NULL) RETURN transcript_name_source_ref

Selects all records for the entity.

Parameters
p_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) Required Key

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

f_query_one 

Function f_query_one(
    p_trns_code                 shrtrns.shrtrns_trns_code%TYPE) RETURN transcript_name_source_ref

Selects one record using the key.

Parameters
p_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) 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_source_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_trns_code                 shrtrns.shrtrns_trns_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN transcript_name_source_ref

Selects one record and locks it.

Parameters
p_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) 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_trns_code                 shrtrns.shrtrns_trns_code%TYPE,
    p_sys_req_ind               shrtrns.shrtrns_sys_req_ind%TYPE,
    p_edi_ind                   shrtrns.shrtrns_edi_ind%TYPE,
    p_ntyp_ind                  shrtrns.shrtrns_ntyp_ind%TYPE,
    p_degr_ind                  shrtrns.shrtrns_degr_ind%TYPE,
    p_data_origin               shrtrns.shrtrns_data_origin%TYPE,
    p_user_id                   shrtrns.shrtrns_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) Required Key
p_sys_req_ind   Y/N indicator for whether the name source is required. VARCHAR2(1) Required
p_edi_ind   Y/N indicator for whether the name source is allowed for EDI transcripts. VARCHAR2(1) Required
p_ntyp_ind   Y/N indicator for whether the name source allows a name type to be entered. VARCHAR2(1) Required
p_degr_ind   Y/N indicator for whether the name source allows a degree sequence to be entered for the diploma name. VARCHAR2(1) Required
p_data_origin   Origin of the data. VARCHAR2(30) Required
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(
    p_trns_code                 shrtrns.shrtrns_trns_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(
    p_trns_code                 shrtrns.shrtrns_trns_code%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_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(
    p_trns_code                 shrtrns.shrtrns_trns_code%TYPE,
    p_sys_req_ind               shrtrns.shrtrns_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_edi_ind                   shrtrns.shrtrns_edi_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_ntyp_ind                  shrtrns.shrtrns_ntyp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_degr_ind                  shrtrns.shrtrns_degr_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_data_origin               shrtrns.shrtrns_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
    p_user_id                   shrtrns.shrtrns_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_trns_code   Source of the name from Banner that is to be printed on the transcript. VARCHAR2(10) Required Key
p_sys_req_ind   Y/N indicator for whether the name source is required. VARCHAR2(1) Required
p_edi_ind   Y/N indicator for whether the name source is allowed for EDI transcripts. VARCHAR2(1) Required
p_ntyp_ind   Y/N indicator for whether the name source allows a name type to be entered. VARCHAR2(1) Required
p_degr_ind   Y/N indicator for whether the name source allows a degree sequence to be entered for the diploma name. VARCHAR2(1) Required
p_data_origin   Origin of the data. VARCHAR2(30) Required
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)