index

Package sb_scp_ruletimestat

Common Business interface for the SCP_RULETIMESTAT API (sb_scp_ruletimestat).

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_one   Selects one record using the key.
f_query_by_rowid   Selects one record using the ROWID.
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
scp_ruletimestat_rec   Business Entity record type
scp_ruletimestat_ref   Entity cursor variable type
scp_ruletimestat_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(16) := 'SCP_RULETIMESTAT';

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

scp_ruletimestat_rec 

TYPE scp_ruletimestat_rec IS RECORD (
  r_tmst_code               sfrstst.sfrstst_tmst_code%TYPE,
  r_scps_code_eff            sfrstst.sfrstst_scps_code_eff%TYPE,
  r_camp_code               sfrstst.sfrstst_camp_code%TYPE,
  r_levl_code               sfrstst.sfrstst_levl_code%TYPE,
  r_coll_code               sfrstst.sfrstst_coll_code%TYPE,
  r_majr_code               sfrstst.sfrstst_majr_code%TYPE,
  r_styp_code               sfrstst.sfrstst_styp_code%TYPE,
  r_degc_code               sfrstst.sfrstst_degc_code%TYPE,
  r_min_credits             sfrstst.sfrstst_min_credits%TYPE,
  r_max_credits             sfrstst.sfrstst_max_credits%TYPE,
  r_rule_numb               sfrstst.sfrstst_rule_numb%TYPE,
  r_tax_ind                 sfrstst.sfrstst_tax_ind%TYPE,
  r_numb_credits            sfrstst.sfrstst_numb_credits%TYPE,
  r_numb_courses            sfrstst.sfrstst_numb_courses%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

scp_ruletimestat_ref 

TYPE scp_ruletimestat_ref IS REF CURSOR RETURN scp_ruletimestat_rec;

Entity cursor variable type

scp_ruletimestat_tab 

TYPE scp_ruletimestat_tab IS TABLE OF scp_ruletimestat_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_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                  p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                  p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                  p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                  p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                  p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                  p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                  p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                  p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                  p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                  p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                  p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                  p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE,
                  p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) 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 scp_ruletimestat_rec,
                   rec_two scp_ruletimestat_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 scp_ruletimestat_rec Required
rec_two   The second record to compare. Type scp_ruletimestat_rec Required

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

f_query_all 

Function f_query_all(p_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                     p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                     p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                     p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                     p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                     p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                     p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                     p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                     p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                     p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                     p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                     p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                     p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE)
  RETURN scp_ruletimestat_ref

Selects all records for the entity.

Parameters
p_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) Key

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

f_query_one 

Function f_query_one(p_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                     p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                     p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                     p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                     p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                     p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                     p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                     p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                     p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                     p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                     p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                     p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                     p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE)
  RETURN scp_ruletimestat_ref

Selects one record using the key.

Parameters
p_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) 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 scp_ruletimestat_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_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                          p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                          p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                          p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                          p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                          p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                          p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                          p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                          p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                          p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                          p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                          p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                          p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE,
                          p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN scp_ruletimestat_ref

Selects one record and locks it.

Parameters
p_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) 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_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                   p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                   p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                   p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                   p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                   p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                   p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                   p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                   p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                   p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                   p_rule_numb     sfrstst.sfrstst_rule_numb%TYPE DEFAULT NULL,
                   p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                   p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                   p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE,
                   p_rowid_out     OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_rule_numb   Rule number. NUMBER(5)
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) Key
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                   p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                   p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                   p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                   p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                   p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                   p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                   p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                   p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                   p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                   p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                   p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                   p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                 p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                 p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                 p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                 p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                 p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                 p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                 p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                 p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                 p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                 p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                 p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                 p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE,
                 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_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_tmst_code     sfrstst.sfrstst_tmst_code%TYPE,
                   p_scps_code_eff sfrstst.sfrstst_scps_code_eff%TYPE,
                   p_camp_code     sfrstst.sfrstst_camp_code%TYPE,
                   p_levl_code     sfrstst.sfrstst_levl_code%TYPE,
                   p_coll_code     sfrstst.sfrstst_coll_code%TYPE,
                   p_majr_code     sfrstst.sfrstst_majr_code%TYPE,
                   p_styp_code     sfrstst.sfrstst_styp_code%TYPE,
                   p_degc_code     sfrstst.sfrstst_degc_code%TYPE,
                   p_min_credits   sfrstst.sfrstst_min_credits%TYPE,
                   p_max_credits   sfrstst.sfrstst_max_credits%TYPE,
                   p_rule_numb     sfrstst.sfrstst_rule_numb%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_tax_ind       sfrstst.sfrstst_tax_ind%TYPE,
                   p_numb_credits  sfrstst.sfrstst_numb_credits%TYPE,
                   p_numb_courses  sfrstst.sfrstst_numb_courses%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_tmst_code   Time Status Code; Valid values are in the STVTMST table. VARCHAR2(8) Required Key
p_scps_code_eff   The effective student centric period for the time status rule. VARCHAR2(24) Required Key
p_camp_code   The campus code; valid values are in the STVCAMP table. VARCHAR2(12) Key
p_levl_code   The level code; valid values arein the STVLEVL table. VARCHAR2(8) Key
p_coll_code   The college code; valid values are in the STVCOLL table. VARCHAR2(8) Key
p_majr_code   The major code; valid values arein the STVMAJR table. VARCHAR2(16) Key
p_styp_code   The student type code; valid values are in the STVSTYP table. VARCHAR2(4) Key
p_degc_code   The degree code; valid values are in the STVDEGC table. VARCHAR2(24) Key
p_min_credits   The minimum credit hours associated with the time status rule. NUMBER(9,3) Key
p_max_credits   The maximum credit hours associated with the time status rule. NUMBER(9,3) Key
p_rule_numb   Rule number. NUMBER(5)
p_tax_ind   This field identifies a rule which will be used to determine full time status for the Education Tax Credits. VARCHAR2(4) Key
p_numb_credits   The number of credit hours a student must have in order to receive the Education Tax Credits. NUMBER(9,3) Key
p_numb_courses   The number of courses a student must take in order to receive the Education Tax Credits. NUMBER(2) Key
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)