index

Package tb_memo_rules

Support subprograms for MEMO.


Program units
p_register_entity   Register the attribute/value pairs to the message cache for delete operations.
p_register_entity   Register the attribute/value pairs to the message cache for create and update operations.
p_valid_create   Validates data entered, sets defaults, and processes edits and security for insert.
p_valid_update   Validates data entered, and processes edits and comparisons for update.


p_register_entity

Procedure p_register_entity(p_operation_type     NUMBER,
                            p_internal_record_id gb_common.internal_record_id_type)

Register the attribute/value pairs to the message cache for delete operations.
This signature uses the ROWID only, for the delete operations.

Parameters
p_operation_type   Type of DML operation: create,update,delete. NUMBER Required
p_internal_record_id   Database ROWID VARCHAR2(18) required


p_register_entity

Procedure p_register_entity(p_operation_type       NUMBER,
                            p_pidm                 tbrmemo.tbrmemo_pidm%TYPE,
                            p_tran_number          tbrmemo.tbrmemo_tran_number%TYPE,
                            p_term_code            tbrmemo.tbrmemo_term_code%TYPE,
                            p_detail_code          tbrmemo.tbrmemo_detail_code%TYPE,
                            p_amount               tbrmemo.tbrmemo_amount%TYPE,
                            p_user                 tbrmemo.tbrmemo_user%TYPE,
                            p_entry_date           tbrmemo.tbrmemo_entry_date%TYPE,
                            p_billing_ind          tbrmemo.tbrmemo_billing_ind%TYPE,
                            p_desc                 tbrmemo.tbrmemo_desc%TYPE,
                            p_release_date         tbrmemo.tbrmemo_release_date%TYPE,
                            p_expiration_date      tbrmemo.tbrmemo_expiration_date%TYPE,
                            p_effective_date       tbrmemo.tbrmemo_effective_date%TYPE,
                            p_srce_code            tbrmemo.tbrmemo_srce_code%TYPE,
                            p_crossref_pidm        tbrmemo.tbrmemo_crossref_pidm%TYPE,
                            p_crossref_number      tbrmemo.tbrmemo_crossref_number%TYPE,
                            p_crossref_detail_code tbrmemo.tbrmemo_crossref_detail_code%TYPE,
                            p_crossref_srce_code   tbrmemo.tbrmemo_crossref_srce_code%TYPE,
                            p_atyp_code            tbrmemo.tbrmemo_atyp_code%TYPE,
                            p_atyp_seqno           tbrmemo.tbrmemo_atyp_seqno%TYPE,
                            p_data_origin          tbrmemo.tbrmemo_data_origin%TYPE,
                            p_create_user          tbrmemo.tbrmemo_create_user%TYPE,
                            p_crossref_dcat_code   tbrmemo.tbrmemo_crossref_dcat_code%TYPE,
                            p_aidy_code            tbrmemo.tbrmemo_aidy_code%TYPE,
                            p_period               tbrmemo.tbrmemo_period%TYPE,
                            p_internal_record_id   gb_common.internal_record_id_type)

Register the attribute/value pairs to the message cache for create and update operations.
 
This signature registers all parameters.

Parameters
p_operation_type   Type of DML operation: create,update,delete. NUMBER Required
p_pidm   Internal Identification Number of the person or non-person account, valid in SPRIDEN. NUMBER(8) Required Key
p_tran_number   Transaction number (one-up within entity) of the memo. NUMBER(8) Required Key
p_term_code   Term associated with the memo. For student memos valid in STVTERM, or ARTERM for non-student memos. VARCHAR2(6) Required
p_detail_code   Detail Code associated with the memo, valid in TBBDETC. VARCHAR2(4) Required
p_amount   Amount of the memo. NUMBER(7,2) Required
p_user   Most recent user to create or update a record. VARCHAR2(30) Required
p_entry_date   Date the memo was created. DATE Required
p_billing_ind   Memo may be included when billing (Y/N). VARCHAR2(1) Required
p_desc   Free-Form description associated with the memo.  Default value comes from the Detail Code description (TBBDETC). VARCHAR2(30)
p_release_date   Release Date, currently not used. DATE
p_expiration_date   Date the memo item expires, will no longer appear on the bill, and may not be released onto an account. DATE
p_effective_date   Date the memo was created or released on account. DATE
p_srce_code   Source of the memo when created, for example (F)inancial Aid, (C)ontract, (E)xemption, (D)eposit, or T (default) if user entered, valid in TTVSRCE. VARCHAR2(1) Required
p_crossref_pidm   Cross Reference internal identification number for third party memos.  For the third party account, refers to the associated student.  For the student account, refers to the third party. NUMBER(8)
p_crossref_number   Number of the contract associated with the transaction. NUMBER(8)
p_crossref_detail_code   Cross Reference Detail Code for contract or exemption credits calculated based on detail code rules, valid in TBBDETC. VARCHAR2(4)
p_crossref_srce_code   Source code of the detail code that will be paid by the contract. VARCHAR2(1)
p_atyp_code   Address Type Code, which in combination with ATYP_SEQNO identifies the address associated with the memo. Required for non-student memos; not allowed for student memos. Valid in STVATYP. VARCHAR2(2)
p_atyp_seqno   Address Type Sequence Number, which in combination with ATYP_CODE identifies the address associated with the memo. Required for non-student memos; not allowed for student memos. Combination valid and active in SPRADDR. NUMBER(2 )
p_data_origin   Source system that last created or updated the data. VARCHAR2(30)
p_create_user   User which created the memo. VARCHAR2(30)
p_crossref_dcat_code   Cross Reference Category Code for contract or exemption credits calculated based on category code rules, valid in TTVDCAT. VARCHAR2(3)
p_aidy_code   The aid year associated with the Financial Aid memo disbursement. VARCHAR2(4)
p_period   The enrollment period code for Financial Aid disbursement. VARCHAR2(15)
p_internal_record_id   Database ROWID VARCHAR2(18) required


p_valid_create

Procedure p_valid_create(lv_tbrmemo_row_inout IN OUT tbrmemo%ROWTYPE,
                         p_override_hold      VARCHAR2)

Validates data entered, sets defaults, and processes edits and security for insert.

Parameters
lv_tbrmemo_rec_inout   TBRMEMO record with parameter values entered, returned with additional data.
p_override_hold   Parameter to override Accounts Receivable hold. VARCHAR2(1)
N   Check for AR hold
Y   Bypass hold checking



p_valid_update

Procedure p_valid_update(lv_validation_rec_inout IN OUT tb_memo.memo_rec,
                         lv_existing_rec         tb_memo.memo_rec)

Validates data entered, and processes edits and comparisons for update.

Parameters
lv_validation_rec_inout   Proposed TBRMEMO record with update values.
lv_existing_rec   Current TBRMEMO record before updates.