index

Package sb_sect_chrt_restriction

This package provides the common business interface for the Section Cohort Restriction API (sb_sect_chrt_restriction).

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  
p_copy_restrictions  

Types
sect_chrt_restriction_rec  
sect_chrt_restriction_ref  
sect_chrt_restriction_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

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

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

sect_chrt_restriction_rec 

TYPE sect_chrt_restriction_rec IS RECORD (
  r_primary_key             ssrrchr.ssrrchr_primary_key%TYPE,
  r_term_code               ssrrchr.ssrrchr_term_code%TYPE,
  r_crn                     ssrrchr.ssrrchr_crn%TYPE,
  r_rec_type                ssrrchr.ssrrchr_rec_type%TYPE,
  r_user_id                 ssrrchr.ssrrchr_user_id%TYPE,
  r_chrt_ie_cde             ssrrchr.ssrrchr_chrt_ie_cde%TYPE,
  r_chrt_code               ssrrchr.ssrrchr_chrt_code%TYPE,
  r_data_origin             ssrrchr.ssrrchr_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

sect_chrt_restriction_ref 

TYPE sect_chrt_restriction_ref IS REF CURSOR RETURN sect_chrt_restriction_rec;

Entity cursor variable type

sect_chrt_restriction_tab 

TYPE sect_chrt_restriction_tab IS TABLE OF sect_chrt_restriction_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 ssrrchr.ssrrchr_primary_key%TYPE DEFAULT NULL,
                  p_term_code   ssrrchr.ssrrchr_term_code%TYPE DEFAULT NULL,
                  p_crn         ssrrchr.ssrrchr_crn%TYPE DEFAULT NULL,
                  p_rec_type    ssrrchr.ssrrchr_rec_type%TYPE DEFAULT NULL,
                  p_chrt_code   ssrrchr.ssrrchr_chrt_code%TYPE DEFAULT NULL,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists using the unique index or ROWID.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER (9) Key
p_term_code   Term in which the section registration cohort restriction exists. VARCHAR2(6) Key
p_crn   Course reference number for which the section registration cohort restriction exists. VARCHAR2(5) Key
p_rec_type   Indicator for whether the record contains a cohort indicator or a cohort code. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Key
p_chrt_code   Code of a cohort for which registration restrictions exist.  The Include/Exclude field will determine how the cohort is restricted. An unlimited number of cohorts may be defined. VARCHAR2(10) 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 sect_chrt_restriction_rec,
                   rec_two sect_chrt_restriction_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 sect_chrt_restriction_rec Required
rec_two   The second record to compare. Type sect_chrt_restriction_rec Required

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

f_query_all 

Function f_query_all(p_term_code ssrrchr.ssrrchr_term_code%TYPE,
                     p_crn       ssrrchr.ssrrchr_crn%TYPE,
                     p_rec_type  ssrrchr.ssrrchr_rec_type%TYPE DEFAULT NULL)
  RETURN sect_chrt_restriction_ref

Selects all records for the entity.

Parameters
p_term_code   Term in which the section registration cohort restriction exists. VARCHAR2(6) Required Key
p_crn   Course reference number for which the section registration cohort restriction exists. VARCHAR2(5) Required Key
p_rec_type   Indicator for whether the record contains a cohort indicator or a cohort code. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Required Key

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

f_query_one 

Function f_query_one(p_primary_key ssrrchr.ssrrchr_primary_key%TYPE DEFAULT NULL,
                     p_term_code   ssrrchr.ssrrchr_term_code%TYPE DEFAULT NULL,
                     p_crn         ssrrchr.ssrrchr_crn%TYPE DEFAULT NULL,
                     p_rec_type    ssrrchr.ssrrchr_rec_type%TYPE DEFAULT NULL,
                     p_chrt_code   ssrrchr.ssrrchr_chrt_code%TYPE DEFAULT NULL)
  RETURN sect_chrt_restriction_ref

Selects one record using the primary key or unique index.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER (9) Key
p_term_code   Term in which the section registration cohort restriction exists. VARCHAR2(6) Key
p_crn   Course reference number for which the section registration cohort restriction exists. VARCHAR2(5) Key
p_rec_type   Indicator for whether the record contains a cohort indicator or a cohort code. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Key
p_chrt_code   Code of a cohort for which registration restrictions exist.  The Include/Exclude field will determine how the cohort is restricted. An unlimited number of cohorts may be defined. VARCHAR2(10) 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 sect_chrt_restriction_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_primary_key ssrrchr.ssrrchr_primary_key%TYPE DEFAULT NULL,
                          p_term_code   ssrrchr.ssrrchr_term_code%TYPE DEFAULT NULL,
                          p_crn         ssrrchr.ssrrchr_crn%TYPE DEFAULT NULL,
                          p_rec_type    ssrrchr.ssrrchr_rec_type%TYPE DEFAULT NULL,
                          p_chrt_code   ssrrchr.ssrrchr_chrt_code%TYPE DEFAULT NULL,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN sect_chrt_restriction_ref

Selects one record and locks it.

Parameters
p_primary_key   Unique sequence number that identifies the record. NUMBER (9) Key
p_term_code   Term in which the section registration cohort restriction exists. VARCHAR2(6) Key
p_crn   Course reference number for which the section registration cohort restriction exists. VARCHAR2(5) Key
p_rec_type   Indicator for whether the record contains a cohort indicator or a cohort code. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Key
p_chrt_code   Code of a cohort for which registration restrictions exist.  The Include/Exclude field will determine how the cohort is restricted. An unlimited number of cohorts may be defined. VARCHAR2(10) 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_term_code       ssrrchr.ssrrchr_term_code%TYPE,
                   p_crn             ssrrchr.ssrrchr_crn%TYPE,
                   p_rec_type        ssrrchr.ssrrchr_rec_type%TYPE,
                   p_user_id         ssrrchr.ssrrchr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_chrt_ie_cde     ssrrchr.ssrrchr_chrt_ie_cde%TYPE DEFAULT NULL,
                   p_chrt_code       ssrrchr.ssrrchr_chrt_code%TYPE DEFAULT NULL,
                   p_data_origin     ssrrchr.ssrrchr_data_origin%TYPE DEFAULT NULL,
                   p_primary_key_out OUT ssrrchr.ssrrchr_primary_key%TYPE,
                   p_rowid_out       OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_term_code   Term in which the section registration cohort restriction is being created. VARCHAR2(6) Required Key
p_crn   Course reference number for which the section registration cohort restriction is being created. VARCHAR2(5) Required Key
p_rec_type   Indicator for whether a cohort indicator record or a cohort code record is being created. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Required Key
p_user_id   ID of the user who is creating the record. VARCHAR2(30) Required
p_chrt_ie_cde   Indicator for whether the cohort codes entered should be included or excluded in restricting the section.  Valid values are:  I - Include, E - Exclude. VARCHAR2(1)
p_chrt_code   Code of a cohort for which the registration restrictions is being created.  The Include/Exclude field will determine how the cohort is restricted. An unlimited number of cohorts may be defined. VARCHAR2(10) Key
p_data_origin   Source system that is generating the data. VARCHAR2(30)
p_primary_key_out   Unique sequence number that identifies the record being created. NUMBER (9) Required
p_rowid_out   Database ROWID of the record being created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_primary_key ssrrchr.ssrrchr_primary_key%TYPE DEFAULT NULL,
                   p_term_code   ssrrchr.ssrrchr_term_code%TYPE DEFAULT NULL,
                   p_crn         ssrrchr.ssrrchr_crn%TYPE DEFAULT NULL,
                   p_rec_type    ssrrchr.ssrrchr_rec_type%TYPE DEFAULT NULL,
                   p_chrt_code   ssrrchr.ssrrchr_chrt_code%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_term_code   Term in which the section registration cohort restriction exists. VARCHAR2(6) Key
p_crn   Course reference number for which the section registration cohort restriction exists. VARCHAR2(5) Key
p_rec_type   Indicator for whether the record contains a cohort indicator or a cohort code. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Key
p_chrt_code   Code of a cohort for which registration restrictions exist.  The Include/Exclude field will determine how the cohort is restricted. An unlimited number of cohorts may be defined. VARCHAR2(10) Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_primary_key ssrrchr.ssrrchr_primary_key%TYPE DEFAULT NULL,
                 p_term_code   ssrrchr.ssrrchr_term_code%TYPE DEFAULT NULL,
                 p_crn         ssrrchr.ssrrchr_crn%TYPE DEFAULT NULL,
                 p_rec_type    ssrrchr.ssrrchr_rec_type%TYPE DEFAULT NULL,
                 p_chrt_code   ssrrchr.ssrrchr_chrt_code%TYPE DEFAULT NULL,
                 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_primary_key   Unique sequence number that identifies the record. NUMBER (9) Key
p_term_code   Term in which the section registration cohort restriction exists. VARCHAR2(6) Key
p_crn   Course reference number for which the section registration cohort restriction exists. VARCHAR2(5) Key
p_rec_type   Indicator for whether the record contains a cohort indicator or a cohort code. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Key
p_chrt_code   Code of a cohort for which registration restrictions exist.  The Include/Exclude field will determine how the cohort is restricted. An unlimited number of cohorts may be defined. VARCHAR2(10) Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_primary_key ssrrchr.ssrrchr_primary_key%TYPE DEFAULT NULL,
                   p_term_code   ssrrchr.ssrrchr_term_code%TYPE DEFAULT NULL,
                   p_crn         ssrrchr.ssrrchr_crn%TYPE DEFAULT NULL,
                   p_rec_type    ssrrchr.ssrrchr_rec_type%TYPE DEFAULT NULL,
                   p_user_id     ssrrchr.ssrrchr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_chrt_ie_cde ssrrchr.ssrrchr_chrt_ie_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_chrt_code   ssrrchr.ssrrchr_chrt_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin ssrrchr.ssrrchr_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_term_code   Term in which the section registration cohort restriction exists. VARCHAR2(6) Key
p_crn   Course reference number for which the section registration cohort restriction exists. VARCHAR2(5) Key
p_rec_type   Indicator for whether the record contains a cohort indicator or a cohort code. Valid values are: 1 - Cohort indicator, 2 - Cohort code. VARCHAR2(1) Key
p_user_id   ID of the user who changed the record. VARCHAR2(30) Required
p_chrt_ie_cde   Indicator for whether the cohort codes entered should be included or excluded in restricting the course.  Valid values are:  I - Include, E - Exclude. VARCHAR2(1)
p_chrt_code   Code of a cohort for which registration restrictions exist.  The Include/Exclude field will determine how the cohort is restricted. An unlimited number of cohorts may be defined. VARCHAR2(10) Key
p_data_origin   Source system that generated the data. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)

p_copy_restrictions 

Procedure p_copy_restrictions(p_from_term   ssrrchr.ssrrchr_term_code%TYPE,
                              p_from_crn    ssrrchr.ssrrchr_crn%TYPE,
                              p_to_term     ssrrchr.ssrrchr_term_code%TYPE,
                              p_to_crn      ssrrchr.ssrrchr_crn%TYPE,
                              p_user_id     ssrrchr.ssrrchr_user_id%TYPE DEFAULT gb_common.f_sct_user,
                              p_data_origin ssrrchr.ssrrchr_data_origin%TYPE DEFAULT NULL)

Copies cohort restrictions from one section to another.

Parameters
p_from_term   Term from which the section registration cohort restrictions are being copied. VARCHAR2(6) Required Key
p_from_crn   Course reference number of the section from which the cohort restrictions are being copied. VARCHAR2(5) Required Key
p_to_term   Term to which the section registration cohort restrictions are being copied. VARCHAR2(6) Required Key
p_to_crn   Course reference number of the section to which the cohort restrictions are being copied. VARCHAR2(5) Required Key
p_user_id   ID of the user who changed the record. VARCHAR2(30)
p_data_origin   Source system that generated the data. VARCHAR2(30)