index

Package rp_appl_prds_status

Common Business interface for the Applicant Period Status Business Process API (rp_appl_prds_status).
 
This package includes those procedures and functions required in order to function as the business process API for applicant period statuses.
 
There is only one procedure defined: p_update.
In addition, there are three pass-through functions (f_exists, f_query_all and f_query_one) that call the corresponding functions in the rb_appl_prds_status package, returning the same data.

Program units
f_exists   Checks if a record exists.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using key.
p_update   Updates a record.

f_exists 

Function f_exists(p_pidm   rorprst.rorprst_pidm%TYPE,
                  p_period rorprst.rorprst_period%TYPE,
                  p_rowid  gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_period   The period associated with information in this record. VARCHAR2(15) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_query_all 

Function f_query_all(p_pidm   rorprst.rorprst_pidm%TYPE,
                     p_period rorprst.rorprst_period%TYPE DEFAULT NULL)
  RETURN rb_appl_prds_status.appl_prds_status_ref

Selects all records for the entity.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_period   The period associated with information in this record. VARCHAR2(15) Required Key

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

f_query_one 

Function f_query_one(p_pidm   rorprst.rorprst_pidm%TYPE,
                     p_period rorprst.rorprst_period%TYPE)
  RETURN rb_appl_prds_status.appl_prds_status_ref

Selects one record using key.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_period   The period associated with information in this record. VARCHAR2(15) Required Key

Returns
A cursor variable that will fetch exactly one record.

p_update 

Procedure p_update(p_pidm                 rorprst.rorprst_pidm%TYPE,
                   p_period               rorprst.rorprst_period%TYPE,
                   p_period_freeze_ind    rorprst.rorprst_period_freeze_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_xes_lock_ind         rorprst.rorprst_xes_lock_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_xes                  rorprst.rorprst_xes%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_xes_algo_code        rorprst.rorprst_xes_algo_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_xes_seq_no           rorprst.rorprst_xes_seq_no%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id              rorprst.rorprst_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin          rorprst.rorprst_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_yr_in_coll           rorprst.rorprst_yr_in_coll%TYPE DEFAULT dml_common.f_unspecified_string, -- 8220100-1
                   p_yr_in_coll_algo_code rorprst.rorprst_yr_in_coll_algo_code%TYPE DEFAULT dml_common.f_unspecified_string, -- 8220100-1
                   p_yr_in_coll_seq_no    rorprst.rorprst_yr_in_coll_seq_no%TYPE DEFAULT dml_common.f_unspecified_number, -- 8220100-1
                   p_yr_in_coll_lock_ind  rorprst.rorprst_yr_in_coll_lock_ind%TYPE DEFAULT dml_common.f_unspecified_string)

Updates a record.

Parameters
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_period   The period associated with information in this record. VARCHAR2(15) Required Key
p_period_freeze_ind   Identifies if the period is frozen preventing further updates. VARCHAR2(1) Required
p_xes_lock_ind   Identifies if the expected enrollment status is locked preventing further updates. VARCHAR2(1) Required
p_xes   The student's expected enrollment status for the period. VARCHAR2(1)
p_xes_algo_code   The algorithmic rule code used to calculate the expected enrollment status. VARCHAR2(30)
p_xes_seq_no   The sequence number of the rule code used to calculate the expected enrollment status. NUMBER(5)
p_user_id   The user ID of the person who inserted or last updated this record. VARCHAR2(30)
p_data_origin   The latest source for the data contained in this record. VARCHAR2(30)
p_yr_in_coll   The student's year in college for the period. VARCHAR2(1)                                             -- 8220100-1
p_yr_in_coll_algo_code   The algorithmic rule code used to calculate the year in college. VARCHAR2(30)               -- 8220100-1
p_yr_in_coll_seq_no   The sequence number of the rule code used to calculate the year in college. NUMBER(5)          -- 8220100-1
p_yr_in_coll_lock_ind   Identifies if the year in college is locked preventing further updates. VARCHAR2(1) Required -- 8220100-1