index

Package rp_appl_aidy_comp

Common public Business interface for the APPL_AIDY_COMP API (rp_appl_aidy_comp).

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_create   Creates a record.
p_update   Updates a record.
p_delete   Deletes a record.

f_exists 

Function f_exists(p_aidy_code rbracmp.rbracmp_aidy_code%TYPE,
                  p_pidm      rbracmp.rbracmp_pidm%TYPE,
                  p_btyp_code rbracmp.rbracmp_btyp_code%TYPE,
                  p_comp_code rbracmp.rbracmp_comp_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 information in this record. VARCHAR2(4) Required Key
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_btyp_code   The budget type code associated with this particular budget component. VARCHAR2(4) Required Key
p_comp_code   The code used to identify the source of the expense in the student's budget. VARCHAR2(4) 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_aidy_code rbracmp.rbracmp_aidy_code%TYPE,
                     p_pidm      rbracmp.rbracmp_pidm%TYPE,
                     p_btyp_code rbracmp.rbracmp_btyp_code%TYPE DEFAULT NULL,
                     p_comp_code rbracmp.rbracmp_comp_code%TYPE DEFAULT NULL)
  RETURN rb_appl_aidy_comp.appl_aidy_comp_ref

Selects all records for the entity.

Parameters
p_aidy_code   The aid year associated with information in this record. VARCHAR2(4) Required Key
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_btyp_code   The budget type code associated with this particular budget component. VARCHAR2(4)
p_comp_code   The code used to identify the source of the expense in the student's budget. VARCHAR2(4)

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

f_query_one 

Function f_query_one(p_aidy_code rbracmp.rbracmp_aidy_code%TYPE,
                     p_pidm      rbracmp.rbracmp_pidm%TYPE,
                     p_btyp_code rbracmp.rbracmp_btyp_code%TYPE,
                     p_comp_code rbracmp.rbracmp_comp_code%TYPE)
  RETURN rb_appl_aidy_comp.appl_aidy_comp_ref

Selects one record using key.

Parameters
p_aidy_code   The aid year associated with information in this record. VARCHAR2(4) Required Key
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_btyp_code   The budget type code associated with this particular budget component. VARCHAR2(4) Required Key
p_comp_code   The code used to identify the source of the expense in the student's budget. VARCHAR2(4) Required Key

Returns
A cursor variable that will fetch exactly one record.

p_create 

Procedure p_create(p_aidy_code   rbracmp.rbracmp_aidy_code%TYPE,
                   p_pidm        rbracmp.rbracmp_pidm%TYPE,
                   p_btyp_code   rbracmp.rbracmp_btyp_code%TYPE,
                   p_comp_code   rbracmp.rbracmp_comp_code%TYPE,
                   p_amt         rbracmp.rbracmp_amt%TYPE,
                   p_user_id     rbracmp.rbracmp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_sys_ind     rbracmp.rbracmp_sys_ind%TYPE,
                   p_data_origin rbracmp.rbracmp_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_aidy_code   The aid year associated with information in this record. VARCHAR2(4) Required Key
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_btyp_code   The budget type code associated with this particular budget component. VARCHAR2(4) Required Key
p_comp_code   The code used to identify the source of the expense in the student's budget. VARCHAR2(4) Required Key
p_amt   The amount of this particular budget component. NUMBER(11,2) Required
p_user_id   The user ID of the person who inserted or last updated this record. VARCHAR2(30)
p_sys_ind   Indicates whether the component was created or updated (M)anually by the user , by the (S)ystem through a batch or automatic process, (B)atch by the batch posting process, or by use of a mi(X)ed (averaged) budget definition. VARCHAR2(1) Required
p_data_origin   Source system that created or updated the data. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_update 

Procedure p_update(p_aidy_code   rbracmp.rbracmp_aidy_code%TYPE,
                   p_pidm        rbracmp.rbracmp_pidm%TYPE,
                   p_btyp_code   rbracmp.rbracmp_btyp_code%TYPE,
                   p_comp_code   rbracmp.rbracmp_comp_code%TYPE,
                   p_amt         rbracmp.rbracmp_amt%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id     rbracmp.rbracmp_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_sys_ind     rbracmp.rbracmp_sys_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin rbracmp.rbracmp_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_aidy_code   The aid year associated with information in this record. VARCHAR2(4) Required Key
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_btyp_code   The budget type code associated with this particular budget component. VARCHAR2(4) Required Key
p_comp_code   The code used to identify the source of the expense in the student's budget. VARCHAR2(4) Required Key
p_amt   The amount of this particular budget component. NUMBER(11,2) Required
p_user_id   The user ID of the person who inserted or last updated this record. VARCHAR2(30)
p_sys_ind   Indicates whether the component was created or updated (M)anually by the user , by the (S)ystem through a batch or automatic process, (B)atch by the batch posting process, or by use of a mi(X)ed (averaged) budget definition. VARCHAR2(1) Required
p_data_origin   Source system that created or updated the data. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)

p_delete 

Procedure p_delete(p_aidy_code rbracmp.rbracmp_aidy_code%TYPE,
                   p_pidm      rbracmp.rbracmp_pidm%TYPE,
                   p_btyp_code rbracmp.rbracmp_btyp_code%TYPE,
                   p_comp_code rbracmp.rbracmp_comp_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_aidy_code   The aid year associated with information in this record. VARCHAR2(4) Required Key
p_pidm   The internal system student identification number. NUMBER(8) Required Key
p_btyp_code   The budget type code associated with this particular budget component. VARCHAR2(4) Required Key
p_comp_code   The code used to identify the source of the expense in the student's budget. VARCHAR2(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)