index

Package tb_term_control_ar

Common Business interface for the Accounts Receivable Term Control API (TERM_CONTROL_AR).

Program units
f_api_version   Returns the API version number.
f_exists   Checks to see 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 key.
f_query_by_rowid   Selects one record using 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
term_control_ar_rec   Business Entity record type
term_control_ar_ref   Entity cursor variable type
term_control_ar_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(15) := 'TERM_CONTROL_AR';

Business Entity Name

term_control_ar_rec 

TYPE term_control_ar_rec IS RECORD (
  r_term_code               tbbterm.tbbterm_term_code%TYPE,
  r_detail_web_disp_ind     tbbterm.tbbterm_detail_web_disp_ind%TYPE,
  r_web_eff_date            tbbterm.tbbterm_web_eff_date%TYPE,
  r_sum_detc_ind            tbbterm.tbbterm_sum_detc_ind%TYPE,
  r_aid_auth_disp_ind       tbbterm.tbbterm_aid_auth_disp_ind%TYPE,
  r_aid_memo_disp_ind       tbbterm.tbbterm_aid_memo_disp_ind%TYPE,
  r_oth_memo_disp_ind       tbbterm.tbbterm_oth_memo_disp_ind%TYPE,
  r_pay_btn_ind             tbbterm.tbbterm_pay_btn_ind%TYPE,
  r_accd_due_cde            tbbterm.tbbterm_accd_due_cde%TYPE,
  r_auth_due_cde            tbbterm.tbbterm_auth_due_cde%TYPE,
  r_memo_due_cde            tbbterm.tbbterm_memo_due_cde%TYPE,
  r_aid_calc_ind            tbbterm.tbbterm_aid_calc_ind%TYPE,
  r_data_origin             tbbterm.tbbterm_data_origin%TYPE,
  r_user_id                 tbbterm.tbbterm_user_id%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

term_control_ar_ref 

TYPE term_control_ar_ref IS REF CURSOR RETURN term_control_ar_rec;

Entity cursor variable type

term_control_ar_tab 

TYPE term_control_ar_tab IS TABLE OF term_control_ar_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_term_code tbbterm.tbbterm_term_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required 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 term_control_ar_rec,
                   rec_two term_control_ar_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 term_control_ar_rec Required
rec_two   The second record to compare. Type term_control_ar_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 tbbterm.tbbterm_term_code%TYPE)
  RETURN term_control_ar_ref

Selects all records for the entity.

Parameters
p_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required Key

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

f_query_one 

Function f_query_one(p_term_code tbbterm.tbbterm_term_code%TYPE)
  RETURN term_control_ar_ref

Selects one record using key.

Parameters
p_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required 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 term_control_ar_ref

Selects one record using 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_term_code tbbterm.tbbterm_term_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN term_control_ar_ref

Selects one record and locks it.

Parameters
p_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required 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           tbbterm.tbbterm_term_code%TYPE,
                   p_detail_web_disp_ind tbbterm.tbbterm_detail_web_disp_ind%TYPE DEFAULT 'N',
                   p_web_eff_date        tbbterm.tbbterm_web_eff_date%TYPE DEFAULT NULL,
                   p_sum_detc_ind        tbbterm.tbbterm_sum_detc_ind%TYPE DEFAULT 'N',
                   p_aid_auth_disp_ind   tbbterm.tbbterm_aid_auth_disp_ind%TYPE DEFAULT 'N',
                   p_aid_memo_disp_ind   tbbterm.tbbterm_aid_memo_disp_ind%TYPE DEFAULT 'N',
                   p_oth_memo_disp_ind   tbbterm.tbbterm_oth_memo_disp_ind%TYPE DEFAULT 'N',
                   p_pay_btn_ind         tbbterm.tbbterm_pay_btn_ind%TYPE DEFAULT 'N',
                   p_accd_due_cde        tbbterm.tbbterm_accd_due_cde%TYPE DEFAULT 'A',
                   p_auth_due_cde        tbbterm.tbbterm_auth_due_cde%TYPE DEFAULT 'N',
                   p_memo_due_cde        tbbterm.tbbterm_memo_due_cde%TYPE DEFAULT 'N',
                   p_aid_calc_ind        tbbterm.tbbterm_aid_calc_ind%TYPE DEFAULT 'N',
                   p_data_origin         tbbterm.tbbterm_data_origin%TYPE DEFAULT NULL,
                   p_user_id             tbbterm.tbbterm_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid_out           OUT gb_common.internal_record_id_type)

Creates a record.
 
Calculations in Authorized Aid section must be (N)o when Authorized Aid displayed is (N)o.
Calculations in Memo section must be (N)o when both Financial Aid and Other memos displayed are (N)o.

Parameters
p_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required Key
p_detail_web_disp_ind   Display of self-service Account Detail for Term is enabled for this term. VARCHAR2(1) Required
Y   Include term in choices available for display
N   Term not available for display (default)

p_web_eff_date   Effective date for calculation of Current Due and memo Release of deposits. DATE
p_sum_detc_ind   Account detail is summarized by detail code. VARCHAR2(1) Required
Y   Summarize Account Detail section by Detail Code
N   Show each receivable record with date (default)

p_aid_auth_disp_ind   Authorized Aid is displayed for this term. VARCHAR2(1) Required
Y   Display Authorized Aid information
N   Do not display Authorized Aid information (default)

p_aid_memo_disp_ind   Financial Aid memos are displayed for this term. VARCHAR2(1) Required
Y   Display Financial Aid Memo information
N   Do not display Financial Aid Memo information (default)

p_oth_memo_disp_ind   Other memos are displayed for this term. VARCHAR2(1) Required
Y   Display Other Memo information
N   Do not display Other Memo information (default)

p_pay_btn_ind   Display Pay Now buttons. VARCHAR2(1) Required
Y   Display Pay Now buttons on page
N   Do not display Pay Now buttons (default)

p_accd_due_cde   Calculations in Account Detail section. VARCHAR2(1) Required
A   Display Account Balance only in account detail section (default)
B   Display both Account Balance and Current Due (excluding future dated items) in account detail section

p_auth_due_cde   Calculations in Authorized Aid section. VARCHAR2(1) Required
N   Do not display calculated totals in authorized aid section (default)
A   Display Adjusted Account Balance only in authorized aid section
B   Display both Adjusted Account Balance and Current Due in authorized aid section

p_memo_due_cde   Calculations in Memo section. VARCHAR2(1) Required
N   Do not display calculated totals in memo section (default)
A   Display Adjusted Account Balance only in memo section
B   Display both Adjusted Account Balance and Current Due in memo section

p_aid_calc_ind   Reserved for future use. VARCHAR2(1) Required
Y  
N   (default)

p_data_origin   Source system that last created or updated the data. VARCHAR2(30)
p_user_id   User who created or last updated the record. VARCHAR2(30) Required
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_term_code tbbterm.tbbterm_term_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_term_code   tbbterm.tbbterm_term_code%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks a record.
If 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_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_term_code           tbbterm.tbbterm_term_code%TYPE,
                   p_detail_web_disp_ind tbbterm.tbbterm_detail_web_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_web_eff_date        tbbterm.tbbterm_web_eff_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_sum_detc_ind        tbbterm.tbbterm_sum_detc_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_aid_auth_disp_ind   tbbterm.tbbterm_aid_auth_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_aid_memo_disp_ind   tbbterm.tbbterm_aid_memo_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_oth_memo_disp_ind   tbbterm.tbbterm_oth_memo_disp_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_pay_btn_ind         tbbterm.tbbterm_pay_btn_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_accd_due_cde        tbbterm.tbbterm_accd_due_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_auth_due_cde        tbbterm.tbbterm_auth_due_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_memo_due_cde        tbbterm.tbbterm_memo_due_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_aid_calc_ind        tbbterm.tbbterm_aid_calc_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin         tbbterm.tbbterm_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id             tbbterm.tbbterm_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_rowid               gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.
 
Calculations in Authorized Aid section must be (N)o when Authorized Aid displayed is (N)o.
Calculations in Memo section must be (N)o when both Financial Aid and Other memos displayed are (N)o.

Parameters
p_term_code   Unique term code that identifies the base term record. VARCHAR2(6) Required Key
p_detail_web_disp_ind   Display of self-service Account Detail for Term is enabled for this term. VARCHAR2(1)
Y   Include term in choices available for display
N   Term not available for display

p_web_eff_date   Effective date for calculation of Current Due and memo Release of deposits. DATE
p_sum_detc_ind   Account detail is summarized by detail code. VARCHAR2(1)
Y   Summarize Account Detail section by Detail Code
N   Show each receivable record with date

p_aid_auth_disp_ind   Authorized Aid is displayed for this term. VARCHAR2(1)
Y   Display Authorized Aid information
N   Do not display Authorized Aid information

p_aid_memo_disp_ind   Financial Aid memos are displayed for this term. VARCHAR2(1)
Y   Display Financial Aid Memo information
N   Do not display Financial Aid Memo information

p_oth_memo_disp_ind   Other memos are displayed for this term (Y/N). VARCHAR2(1)
Y   Display Other Memo information
N   Do not display Other Memo information

p_pay_btn_ind   Display Pay Now buttons. VARCHAR2(1) Required
Y   Display Pay Now buttons on page
N   Do not display Pay Now buttons (default)

p_accd_due_cde   Calculations in Account Detail section. VARCHAR2(1) Required
A   Display Account Balance only in account detail section (default)
B   Display both Account Balance and Current Due (excluding future dated items) in account detail section

p_auth_due_cde   Calculations in Authorized Aid section. VARCHAR2(1) Required
N   Do not display calculated totals in authorized aid section (default)
A   Display Adjusted Account Balance only in authorized aid section
B   Display both Adjusted Account Balance and Current Due in authorized aid section

p_memo_due_cde   Calculations in Memo section. VARCHAR2(1) Required
N   Do not display calculated totals in memo section (default)
A   Display Adjusted Account Balance only in memo section
B   Display both Adjusted Account Balance and Current Due in memo section

p_aid_calc_ind   Reserved for future use. VARCHAR2(1)
Y  
N   (default)

p_data_origin   Source system that last created or updated the data. VARCHAR2(30)
p_user_id   User who created or last updated the record. VARCHAR2(30) Required
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)