index

Package rp_applicant_holds

Common Business interface for the Applicant Holds Business Process API (rp_applicant_holds).
 
This package includes those procedures and functions required in order to function as the business process API for applicant holds.
 
There are two procedures defined (p_create and p_update) and one pass-through procedure (p_delete) that calls the corresponding procedure in the rb_applicant_holds package, returning the same data.
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_applicant_holds package, returning the same data.

Program units
f_api_version   Returns the API version number.
f_exists   Checks if a record exists.
f_exists   Checks if a record exists.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using the key.
p_create   Creates a record.
p_delete   Deletes a record.
p_delete   Deletes a record.
p_update   Updates a record.

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_aidy_code rorhold.rorhold_aidy_code%TYPE,
                  p_pidm      rorhold.rorhold_pidm%TYPE,
                  p_hold_code rorhold.rorhold_hold_code%TYPE,
                  p_from_date rorhold.rorhold_from_date%TYPE,
                  p_term_code rorhold.rorhold_term_code%TYPE,
                  p_fund_code rorhold.rorhold_fund_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_term_code   The term code associated with the hold. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_exists 

Function f_exists(p_aidy_code rorhold.rorhold_aidy_code%TYPE,
                  p_pidm      rorhold.rorhold_pidm%TYPE,
                  p_hold_code rorhold.rorhold_hold_code%TYPE,
                  p_from_date rorhold.rorhold_from_date%TYPE,
                  p_period    rorhold.rorhold_period%TYPE, -- 080900-1
                  p_term_code rorhold.rorhold_term_code%TYPE DEFAULT NULL, -- 080900-1
                  p_fund_code rorhold.rorhold_fund_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_period   The period associated with the hold. VARCHAR2(15)
p_term_code   The term associated with the accounts receivable indicator for the period. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)
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_aidy_code   rorhold.rorhold_aidy_code%TYPE,
                     p_pidm        rorhold.rorhold_pidm%TYPE,
                     p_hold_code   rorhold.rorhold_hold_code%TYPE,
                     p_from_date   rorhold.rorhold_from_date%TYPE,
                     p_to_date     rorhold.rorhold_to_date%TYPE,
                     p_release_ind rorhold.rorhold_release_ind%TYPE,
                     p_term_code   rorhold.rorhold_term_code%TYPE,
                     p_fund_code   rorhold.rorhold_fund_code%TYPE)
  RETURN rb_applicant_holds.applicant_holds_ref

Selects all records for the entity.
   - The more parameters that are entered, the fewer the records returned.
   - Pidm is always required and if only a pidm is entered, all applicant status records for the pidm will be returned.

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_to_date   The last date the hold is effective. DATE Required
p_release_ind   Indicates if only the User ID of the person who set the hold can release it. VARCHAR2(1) Required
p_term_code   The term code associated with the hold. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)

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

f_query_one 

Function f_query_one(p_aidy_code rorhold.rorhold_aidy_code%TYPE,
                     p_pidm      rorhold.rorhold_pidm%TYPE,
                     p_hold_code rorhold.rorhold_hold_code%TYPE,
                     p_from_date rorhold.rorhold_from_date%TYPE,
                     p_term_code rorhold.rorhold_term_code%TYPE,
                     p_fund_code rorhold.rorhold_fund_code%TYPE)
  RETURN rb_applicant_holds.applicant_holds_ref

Selects one record using the key.

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_term_code   The term code associated with the hold. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)

Returns
A cursor variable that will fetch exactly one record.

p_create 

Procedure p_create(p_aidy_code   rorhold.rorhold_aidy_code%TYPE DEFAULT NULL,
                   p_pidm        rorhold.rorhold_pidm%TYPE,
                   p_hold_code   rorhold.rorhold_hold_code%TYPE,
                   p_from_date   rorhold.rorhold_from_date%TYPE,
                   p_to_date     rorhold.rorhold_to_date%TYPE DEFAULT NULL,
                   p_release_ind rorhold.rorhold_release_ind%TYPE DEFAULT NULL,
                   p_user_id     rorhold.rorhold_user_id%TYPE DEFAULT NULL,
                   p_reason      rorhold.rorhold_reason%TYPE DEFAULT NULL,
                   p_period      rorhold.rorhold_period%TYPE DEFAULT NULL, -- 080900-1
                   p_term_code   rorhold.rorhold_term_code%TYPE DEFAULT NULL,
                   p_fund_code   rorhold.rorhold_fund_code%TYPE DEFAULT NULL,
                   p_data_origin rorhold.rorhold_data_origin%TYPE DEFAULT NULL)

Creates a record.
 
The following are the minimum parameters required to create an applicant hold entry:
       P_PIDM
       P_HOLD_CODE
       P_FROM_DATE
 
This procedure will:
     - Create an entry in the Applicant Holds Table (RORHOLD).
     - If necessary (when p_aidy_code is not null and an applicant status does not exist),
       create an entry in the Applicant Status Table (RORSTAT).

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_to_date   The last date the hold is effective. DATE Required
p_release_ind   Indicates if only the User ID of the person who set the hold can release it. VARCHAR2(1) Required
p_user_id   The user ID of the person who inserted or last updated this record. VARCHAR2(30)
p_reason   The reason the hold was placed on the student record. VARCHAR2(30)
p_period   The period associated with the hold. VARCHAR2(15)
p_term_code   The term associated with the accounts receivable indicator for the period. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)
p_data_origin   The latest source for the data contained in this record. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_aidy_code rorhold.rorhold_aidy_code%TYPE,
                   p_pidm      rorhold.rorhold_pidm%TYPE,
                   p_hold_code rorhold.rorhold_hold_code%TYPE,
                   p_from_date rorhold.rorhold_from_date%TYPE,
                   p_term_code rorhold.rorhold_term_code%TYPE,
                   p_fund_code rorhold.rorhold_fund_code%TYPE)

Deletes a record.

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_term_code   The term code associated with the hold. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_delete 

Procedure p_delete(p_aidy_code rorhold.rorhold_aidy_code%TYPE,
                   p_pidm      rorhold.rorhold_pidm%TYPE,
                   p_hold_code rorhold.rorhold_hold_code%TYPE,
                   p_from_date rorhold.rorhold_from_date%TYPE,
                   p_period    rorhold.rorhold_period%TYPE, -- 080900-1
                   p_term_code rorhold.rorhold_term_code%TYPE DEFAULT NULL, -- 080900-1
                   p_fund_code rorhold.rorhold_fund_code%TYPE)

Deletes a record.

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_period   The period associated with the hold. VARCHAR2(15)
p_term_code   The term associated with the accounts receivable indicator for the period. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_update 

Procedure p_update(p_aidy_code   rorhold.rorhold_aidy_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pidm        rorhold.rorhold_pidm%TYPE,
                   p_hold_code   rorhold.rorhold_hold_code%TYPE,
                   p_from_date   rorhold.rorhold_from_date%TYPE,
                   p_to_date     rorhold.rorhold_to_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_release_ind rorhold.rorhold_release_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     rorhold.rorhold_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_reason      rorhold.rorhold_reason%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_period      rorhold.rorhold_period%TYPE DEFAULT dml_common.f_unspecified_string, -- 080900-1
                   p_term_code   rorhold.rorhold_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fund_code   rorhold.rorhold_fund_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin rorhold.rorhold_data_origin%TYPE DEFAULT dml_common.f_unspecified_string)

Updates a record.
 
This procedure will:
     - Update an entry in the Applicant Holds Table (RORHOLD).
     - If necessary (when an aid year is being added or changed and an applicant status does not exist),
       create an entry in the Applicant Status Table (RORSTAT).

Parameters
p_aidy_code   The aid year associated with with the information in this record. VARCHAR2(4)
p_pidm   The internal system student identification number. NUMBER(8) Required
p_hold_code   The code associated with the type of hold on the student record. VARCHAR2(2) Required
p_from_date   The effective date of the hold. DATE Required
p_to_date   The last date the hold is effective. DATE Required
p_release_ind   Indicates if only the User ID of the person who set the hold can release it. VARCHAR2(1) Required
p_user_id   The user ID of the person who inserted or last updated this record. VARCHAR2(30)
p_reason   The reason the hold was placed on the student record. VARCHAR2(30)
p_period   The period associated with the hold. VARCHAR2(15)
p_term_code   The term associated with the accounts receivable indicator for the period. VARCHAR2(6)
p_fund_code   The fund code associated with the hold. VARCHAR2(6)
p_data_origin   The latest source for the data contained in this record. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)