index

Package sb_catlg_int_partner

This package provides the Common Business interface for the Catalog Integration Partner API (sb_catlg_integration_partner).
 
The integration partners are for defining the courses that are part of a process integration.  A site may have several partners that a course is defined for.

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
catlg_int_partner_rec  
catlg_int_partner_ref  
catlg_int_partner_tab  

Constants
M_ENTITY_NAME  

M_ENTITY_NAME 

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

Business Entity Name

catlg_int_partner_rec 

TYPE catlg_int_partner_rec IS RECORD (
  r_subj_code               scrintg.scrintg_subj_code%TYPE,
  r_crse_numb               scrintg.scrintg_crse_numb%TYPE,
  r_term_code_eff           scrintg.scrintg_term_code_eff%TYPE,
  r_user_id                 scrintg.scrintg_user_id%TYPE,
  r_intg_cde                scrintg.scrintg_intg_cde%TYPE,
  r_data_origin             scrintg.scrintg_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

catlg_int_partner_ref 

TYPE catlg_int_partner_ref IS REF CURSOR RETURN catlg_int_partner_rec;

Entity cursor variable type

catlg_int_partner_tab 

TYPE catlg_int_partner_tab IS TABLE OF catlg_int_partner_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_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner code. VARCHAR2(5) 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                     catlg_int_partner_rec,
    rec_two                     catlg_int_partner_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 catlg_int_partner_rec Required
rec_two   The second record to compare. Type catlg_int_partner_rec Required

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

f_query_all 

Function f_query_all(
    p_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE DEFAULT NULL,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE DEFAULT NULL) RETURN catlg_int_partner_ref

Selects all records for the entity.

Parameters
p_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner code. VARCHAR2(5) Required Key

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

f_query_one 

Function f_query_one(
    p_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE) RETURN catlg_int_partner_ref

Selects one record using the key.

Parameters
p_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner code. VARCHAR2(5) 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 catlg_int_partner_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_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN catlg_int_partner_ref

Selects one record and locks it.

Parameters
p_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner code. VARCHAR2(5) 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_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE,
    p_user_id                   scrintg.scrintg_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE,
    p_data_origin               scrintg.scrintg_data_origin%TYPE DEFAULT NULL,
    p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner code. VARCHAR2(5) Required Key
p_data_origin   Origin of the data. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(
    p_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner code. VARCHAR2(5) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(
    p_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE,
    p_rowid_inout        IN OUT 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_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner Code. VARCHAR2(5) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(
    p_subj_code                 scrintg.scrintg_subj_code%TYPE,
    p_crse_numb                 scrintg.scrintg_crse_numb%TYPE,
    p_term_code_eff             scrintg.scrintg_term_code_eff%TYPE,
    p_user_id                   scrintg.scrintg_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_intg_cde                  scrintg.scrintg_intg_cde%TYPE,
    p_data_origin               scrintg.scrintg_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_subj_code   Identifies the subject code of the course that the integration partner is attached to. VARCHAR2(4) Required Key
p_crse_numb   Identifies the course number of the course that the integration partner is attached to. VARCHAR2(5) Required Key
p_term_code_eff   Identifies the term for which the integration partner is effective. VARCHAR2(6) Required Key
p_user_id   Most recent user to create or update the record. VARCHAR2(30) Required
p_intg_cde   Code defined on the GORINTG table that is associated with the integration partner code. VARCHAR2(5) Required Key
p_data_origin   Origin of the data. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)