index

Package sb_crse_mutual_exclusion

This package provides the Common Business interface for the Course Mutual Exclusion API (sb_crse_mutual_exclusion).

Program units
f_api_version   Returns the API version number.
f_exists   Checks if a record exists.
f_isequal   Compares two records for equality.
f_query_all   Selects all records for the entity.
f_query_by_rowid   Selects one record using the ROWID.
f_query_one   Selects one record using the key.
f_query_one_lock   Selects one record and locks it.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
crse_mutual_exclusion_rec   Business Entity record type
crse_mutual_exclusion_ref   Entity cursor variable type
crse_mutual_exclusion_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name
M_BASE_TABLE_NAME   Base table name

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(21) := 'CRSE_MUTUAL_EXCLUSION';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

crse_mutual_exclusion_rec 

TYPE crse_mutual_exclusion_rec IS RECORD (
  r_primary_key             scrmexc.scrmexc_primary_key%TYPE,
  r_subj_code               scrmexc.scrmexc_subj_code%TYPE,
  r_crse_numb               scrmexc.scrmexc_crse_numb%TYPE,
  r_eff_term                scrmexc.scrmexc_eff_term%TYPE,
  r_user_id                 scrmexc.scrmexc_user_id%TYPE,
  r_subj_code_mexc          scrmexc.scrmexc_subj_code_mexc%TYPE,
  r_crse_numb_mexc          scrmexc.scrmexc_crse_numb_mexc%TYPE,
  r_levl_code               scrmexc.scrmexc_levl_code%TYPE,
  r_grde_code               scrmexc.scrmexc_grde_code%TYPE,
  r_start_term              scrmexc.scrmexc_start_term%TYPE,
  r_end_term                scrmexc.scrmexc_end_term%TYPE,
  r_data_origin             scrmexc.scrmexc_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

crse_mutual_exclusion_ref 

TYPE crse_mutual_exclusion_ref IS REF CURSOR RETURN crse_mutual_exclusion_rec;

Entity cursor variable type

crse_mutual_exclusion_tab 

TYPE crse_mutual_exclusion_tab IS TABLE OF crse_mutual_exclusion_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_primary_key    scrmexc.scrmexc_primary_key%TYPE DEFAULT NULL,
                  p_subj_code      scrmexc.scrmexc_subj_code%TYPE DEFAULT NULL,
                  p_crse_numb      scrmexc.scrmexc_crse_numb%TYPE DEFAULT NULL,
                  p_eff_term       scrmexc.scrmexc_eff_term%TYPE DEFAULT NULL,
                  p_subj_code_mexc scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                  p_crse_numb_mexc scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                  p_levl_code      scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                  p_start_term     scrmexc.scrmexc_start_term%TYPE DEFAULT NULL,
                  p_rowid          gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER(9) Key
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Key
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) 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 crse_mutual_exclusion_rec,
                   rec_two crse_mutual_exclusion_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 crse_mutual_exclusion_rec Required
rec_two   The second record to compare. Type crse_mutual_exclusion_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      scrmexc.scrmexc_subj_code%TYPE,
                     p_crse_numb      scrmexc.scrmexc_crse_numb%TYPE,
                     p_eff_term       scrmexc.scrmexc_eff_term%TYPE,
                     p_subj_code_mexc scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                     p_crse_numb_mexc scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                     p_levl_code      scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                     p_start_term     scrmexc.scrmexc_start_term%TYPE DEFAULT NULL)
  RETURN crse_mutual_exclusion_ref

Selects all records for the entity.

Parameters
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Required Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Required Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Required Key
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) Key

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

f_query_by_rowid 

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN crse_mutual_exclusion_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 

Function f_query_one(p_primary_key    scrmexc.scrmexc_primary_key%TYPE DEFAULT NULL,
                     p_subj_code      scrmexc.scrmexc_subj_code%TYPE DEFAULT NULL,
                     p_crse_numb      scrmexc.scrmexc_crse_numb%TYPE DEFAULT NULL,
                     p_eff_term       scrmexc.scrmexc_eff_term%TYPE DEFAULT NULL,
                     p_subj_code_mexc scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                     p_crse_numb_mexc scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                     p_levl_code      scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                     p_start_term     scrmexc.scrmexc_start_term%TYPE DEFAULT NULL)
  RETURN crse_mutual_exclusion_ref

Selects one record using the key.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER(9) Key
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Key
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) Key

Returns
A cursor variable that will fetch exactly one record.

f_query_one_lock 

Function f_query_one_lock(p_primary_key    scrmexc.scrmexc_primary_key%TYPE DEFAULT NULL,
                          p_subj_code      scrmexc.scrmexc_subj_code%TYPE DEFAULT NULL,
                          p_crse_numb      scrmexc.scrmexc_crse_numb%TYPE DEFAULT NULL,
                          p_eff_term       scrmexc.scrmexc_eff_term%TYPE DEFAULT NULL,
                          p_subj_code_mexc scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                          p_crse_numb_mexc scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                          p_levl_code      scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                          p_start_term     scrmexc.scrmexc_start_term%TYPE DEFAULT NULL,
                          p_rowid          gb_common.internal_record_id_type DEFAULT NULL)
  RETURN crse_mutual_exclusion_ref

Selects one record and locks it.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER(9) Key
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Key
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) 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       scrmexc.scrmexc_subj_code%TYPE,
                   p_crse_numb       scrmexc.scrmexc_crse_numb%TYPE,
                   p_eff_term        scrmexc.scrmexc_eff_term%TYPE,
                   p_user_id         scrmexc.scrmexc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_subj_code_mexc  scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                   p_crse_numb_mexc  scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                   p_levl_code       scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                   p_grde_code       scrmexc.scrmexc_grde_code%TYPE DEFAULT NULL,
                   p_start_term      scrmexc.scrmexc_start_term%TYPE DEFAULT NULL,
                   p_end_term        scrmexc.scrmexc_end_term%TYPE DEFAULT NULL,
                   p_data_origin     scrmexc.scrmexc_data_origin%TYPE DEFAULT NULL,
                   p_primary_key_out OUT scrrdep.scrrdep_primary_key%TYPE,
                   p_rowid_out       OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Required Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Required Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Required Key
p_user_id   Oracle ID of the user who changed the record. VARCHAR2(120) Required
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_grde_code   Minimum grade for the mutual exclusion. VARCHAR2(24)
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) Key
p_end_term   End term for mutually exclusive course definition. VARCHAR2(24)
p_data_origin   Source system that created or updated the row. VARCHAR2(120)
p_primary_key_out   Unique sequence number that identifies the record. NUMBER (9) Required
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_primary_key    scrmexc.scrmexc_primary_key%TYPE DEFAULT NULL,
                   p_subj_code      scrmexc.scrmexc_subj_code%TYPE DEFAULT NULL,
                   p_crse_numb      scrmexc.scrmexc_crse_numb%TYPE DEFAULT NULL,
                   p_eff_term       scrmexc.scrmexc_eff_term%TYPE DEFAULT NULL,
                   p_subj_code_mexc scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                   p_crse_numb_mexc scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                   p_levl_code      scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                   p_start_term     scrmexc.scrmexc_start_term%TYPE DEFAULT NULL,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER(9) Key
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Required Key
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_primary_key    scrmexc.scrmexc_primary_key%TYPE DEFAULT NULL,
                 p_subj_code      scrmexc.scrmexc_subj_code%TYPE DEFAULT NULL,
                 p_crse_numb      scrmexc.scrmexc_crse_numb%TYPE DEFAULT NULL,
                 p_eff_term       scrmexc.scrmexc_eff_term%TYPE DEFAULT NULL,
                 p_subj_code_mexc scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                 p_crse_numb_mexc scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                 p_levl_code      scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                 p_start_term     scrmexc.scrmexc_start_term%TYPE DEFAULT NULL,
                 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_primary_key   Unique sequence number that identifies the record. NUMBER(9) Key
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Key
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_primary_key    scrmexc.scrmexc_primary_key%TYPE DEFAULT NULL,
                   p_subj_code      scrmexc.scrmexc_subj_code%TYPE DEFAULT NULL,
                   p_crse_numb      scrmexc.scrmexc_crse_numb%TYPE DEFAULT NULL,
                   p_eff_term       scrmexc.scrmexc_eff_term%TYPE DEFAULT NULL,
                   p_user_id        scrmexc.scrmexc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_subj_code_mexc scrmexc.scrmexc_subj_code_mexc%TYPE DEFAULT NULL,
                   p_crse_numb_mexc scrmexc.scrmexc_crse_numb_mexc%TYPE DEFAULT NULL,
                   p_levl_code      scrmexc.scrmexc_levl_code%TYPE DEFAULT NULL,
                   p_grde_code      scrmexc.scrmexc_grde_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_start_term     scrmexc.scrmexc_start_term%TYPE DEFAULT NULL,
                   p_end_term       scrmexc.scrmexc_end_term%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin    scrmexc.scrmexc_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER(9) Key
p_subj_code   Subject code of the course with mutual exclusions. VARCHAR2(16) Key
p_crse_numb   Course number of the course with mutual exclusions. VARCHAR2(20) Key
p_eff_term   Term code for which this exclusion becomes effective. VARCHAR2(24) Key
p_user_id   Oracle ID of the user who changed the record. VARCHAR2(120) Required
p_subj_code_mexc   Subject Code for the course that is considered mutually exclusive. VARCHAR2(16) Key
p_crse_numb_mexc   Course field is used to specify the course number for the course that is considered mutually exclusive. VARCHAR2(20) Key
p_levl_code   Level for which the minimum grade will be established. VARCHAR2(8) Key
p_grde_code   Minimum grade for the mutual exclusion. VARCHAR2(24)
p_start_term   Start term for mutually exclusive course definition. VARCHAR2(24) Key
p_end_term   End term for mutually exclusive course definition. VARCHAR2(24)
p_data_origin   Source system that created or updated the row. VARCHAR2(120)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)