index

Package tb_contract_auth

Common Business interface for the Contract Authorization API (CONTRACT_AUTH).


Program units
f_api_version   Returns the API version number.
f_contract_defined   Checks if a contract has been defined.
f_contract_processed   Determines if credits have been processed for a student assigned to the contract.
f_contract_memo_exists   Determines if memos have been created for student assigned to the contract.
f_student_text_exists   Determines if a student has text associated with the contract.
f_exists   Checks if a record exists.
f_isequal   Compares two records for equality.
f_max_priority   Returns the maximum priority for the student and term.
f_query_all_by_cont   Selects authorization records for a given contract.
f_query_all_by_stu   Selects authorization records for a given student.
f_query_one   Selects one record using the key.
f_query_by_rowid   Selects one record using the ROWID.
f_query_one_lock   Selects one record and locks it.
f_student_assigned   Determines if a student is assigned to the contract.
f_sum_charge_amount   Sum the amount column for a student in the contract receivables.
f_sum_charge_balance   Sum the balance column for a student in the contract receivables.
f_sum_payment_amount   Sum of amount column for a student in the contract payment detail.
f_sum_payment_balance   Sum of balance column for a student in the contract payment detail.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
contract_auth_rec   Business Entity record type
contract_auth_ref   Entity cursor variable type
contract_auth_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name
M_BASE_TABLE_NAME   Base table name


M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(13) := 'CONTRACT_AUTH';

Business Entity Name


M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'TBBCSTU';

Base table name


contract_auth_rec

TYPE contract_auth_rec IS RECORD (
  r_stu_pidm                tbbcstu.tbbcstu_stu_pidm%TYPE,
  r_contract_priority       tbbcstu.tbbcstu_contract_priority%TYPE,
  r_contract_pidm           tbbcstu.tbbcstu_contract_pidm%TYPE,
  r_contract_number         tbbcstu.tbbcstu_contract_number%TYPE,
  r_term_code               tbbcstu.tbbcstu_term_code%TYPE,
  r_del_ind                 tbbcstu.tbbcstu_del_ind%TYPE,
  r_auth_number             tbbcstu.tbbcstu_auth_number%TYPE,
  r_auth_ind                tbbcstu.tbbcstu_auth_ind%TYPE,
  r_student_cont_roll_ind   tbbcstu.tbbcstu_student_cont_roll_ind%TYPE,
  r_term_code_expiration    tbbcstu.tbbcstu_term_code_expiration%TYPE,
  r_sponsor_ref_number      tbbcstu.tbbcstu_sponsor_ref_number%TYPE,
  r_user_id                 tbbcstu.tbbcstu_user_id%TYPE,
  r_max_student_amount      tbbcstu.tbbcstu_max_student_amount%TYPE,
  r_data_origin             tbbcstu.tbbcstu_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


contract_auth_ref

TYPE contract_auth_ref IS REF CURSOR RETURN contract_auth_rec;

Entity cursor variable type


contract_auth_tab

TYPE contract_auth_tab IS TABLE OF contract_auth_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_contract_defined

Function f_contract_defined(p_contract_pidm   tbbcont.tbbcont_pidm%TYPE,
                            p_term_code       tbbcont.tbbcont_term_code%TYPE DEFAULT NULL,
                            p_contract_number tbbcont.tbbcont_contract_number%TYPE DEFAULT NULL)
  RETURN VARCHAR2

Checks if a contract has been defined.
If contract number is null, checks for any contract for the sponsor and term.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8)
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)

Returns
Y if fully defined, R if rule not defined, N if base not defined.


f_contract_processed

Function f_contract_processed(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                              p_term_code       tbbcstu.tbbcstu_term_code%TYPE,
                              p_contract_number tbbcstu.tbbcstu_contract_number%TYPE,
                              p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN VARCHAR2

Determines if credits have been processed for a student assigned to the contract.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Y if student credit has been posted, otherwise N.


f_contract_memo_exists

Function f_contract_memo_exists(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                                p_term_code       tbbcstu.tbbcstu_term_code%TYPE,
                                p_contract_number tbbcstu.tbbcstu_contract_number%TYPE,
                                p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN VARCHAR2

Determines if memos have been created for student assigned to the contract.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Y if student credit has been posted, otherwise N.


f_student_text_exists

Function f_student_text_exists(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                               p_term_code       tbbcstu.tbbcstu_term_code%TYPE,
                               p_contract_number tbbcstu.tbbcstu_contract_number%TYPE,
                               p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN VARCHAR2

Determines if a student has text associated with the contract.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Y if student credit has been posted, otherwise N.


f_exists

Function f_exists(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                  p_term_code       tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                  p_contract_number tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                  p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE DEFAULT NULL,
                  p_rowid           gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8)
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 contract_auth_rec, rec_two contract_auth_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 contract_auth_rec Required
rec_two   The second record to compare. Type contract_auth_rec Required

Returns
Y if all values in records are equal, otherwise N. Nulls match Nulls.


f_max_priority

Function f_max_priority(p_stu_pidm  tbbcstu.tbbcstu_stu_pidm%TYPE,
                        p_term_code tbbcstu.tbbcstu_term_code%TYPE)
  RETURN tbbcstu.tbbcstu_contract_priority%TYPE

Returns the maximum priority for the student and term.

Parameters
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through a third party contract. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required Key

Returns
Maximum priority that exists for the student and term.


f_query_all_by_cont

Function f_query_all_by_cont(p_contract_pidm         tbbcstu.tbbcstu_contract_pidm%TYPE,
                             p_term_code             tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                             p_contract_number       tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                             p_stu_pidm              tbbcstu.tbbcstu_stu_pidm%TYPE DEFAULT NULL,
                             p_student_cont_roll_ind tbbcstu.tbbcstu_student_cont_roll_ind%TYPE DEFAULT NULL,
                             p_term_code_expiration  tbbcstu.tbbcstu_term_code_expiration%TYPE DEFAULT NULL)
  RETURN contract_auth_ref

Selects authorization records for a given contract.
 
Contract PIDM is required.  If other parameters are left NULL, all records are returned without regard to the value of data in those fields.
If Expiration Term parameter is populated, records which are not expired are returned (NULL expiration term or expiration term that is greater than or equal to the parameter).

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8)
p_student_cont_roll_ind   Contract roll indicator. VARCHAR2(1)
Y   Roll the student to new contract when performing contract roll.
N   Do not roll the student to new contract.

p_term_code_expiration   Expiration term, representing the last term that a student should be copied forward by a contract roll process. VARCHAR2(6)

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


f_query_all_by_stu

Function f_query_all_by_stu(p_contract_pidm         tbbcstu.tbbcstu_contract_pidm%TYPE DEFAULT NULL,
                            p_term_code             tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                            p_contract_number       tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                            p_stu_pidm              tbbcstu.tbbcstu_stu_pidm%TYPE,
                            p_student_cont_roll_ind tbbcstu.tbbcstu_student_cont_roll_ind%TYPE DEFAULT NULL,
                            p_term_code_expiration  tbbcstu.tbbcstu_term_code_expiration%TYPE DEFAULT NULL)
  RETURN contract_auth_ref

Selects authorization records for a given student.
 
Student PIDM is required.  If other parameters are left NULL, all records are returned without regard to the value of data in those fields.
If Expiration Term parameter is populated, records which are not expired are returned (NULL expiration term or expiration term that is greater than or equal to the parameter).

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8)
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required Key
p_student_cont_roll_ind   Contract roll indicator. VARCHAR2(1)
Y   Roll the student to new contract when performing contract roll.
N   Do not roll the student to new contract.

p_term_code_expiration   Expiration term, representing the last term that a student should be copied forward by a contract roll process. VARCHAR2(6)

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


f_query_one

Function f_query_one(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                     p_term_code       tbbcstu.tbbcstu_term_code%TYPE,
                     p_contract_number tbbcstu.tbbcstu_contract_number%TYPE,
                     p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN contract_auth_ref

Selects one record using the key.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required Key
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required Key
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) 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 contract_auth_ref

Selects one record using the 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_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                          p_term_code       tbbcstu.tbbcstu_term_code%TYPE,
                          p_contract_number tbbcstu.tbbcstu_contract_number%TYPE,
                          p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE,
                          p_rowid           gb_common.internal_record_id_type DEFAULT NULL)
  RETURN contract_auth_ref

Selects one record and locks it.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required Key
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required Key
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.


f_student_assigned

Function f_student_assigned(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                            p_term_code       tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                            p_contract_number tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                            p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN VARCHAR2

Determines if a student is assigned to the contract.
 
If contract number is left null, then the query will be for any assignement for the student to this sponsor for this term.
If term is left null, then query is for any assignement for the student to this sponsor.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Y if student is assigned, otherwise N.


f_sum_charge_amount

Function f_sum_charge_amount(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                             p_term_code       tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                             p_contract_number tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                             p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN NUMBER

Sum the amount column for a student in the contract receivables.
 
Calculates the total of the amount on the contract account (TBRACCD) for student charges and payment reversals, based on the cross reference PIDM.
If term code or contract number is left NULL, then the query is made without regard to the value of data in those fields.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Sum of the Amount column, or null if no records match parameters.


f_sum_charge_balance

Function f_sum_charge_balance(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                              p_term_code       tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                              p_contract_number tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                              p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN NUMBER

Sum the balance column for a student in the contract receivables.
 
Calculates the total of the balance on the contract account (TBRACCD) for student charges and payment reversals, based on the cross reference PIDM.
If term code or contract number is left NULL, then the query is made without regard to the value of data in those fields.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Sum of the Balance column, or null if no records match parameters.


f_sum_payment_amount

Function f_sum_payment_amount(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                              p_term_code       tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                              p_contract_number tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                              p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN NUMBER

Sum of amount column for a student in the contract payment detail.
 
Calculates the total of the amount column in contract payment detail (TBRCPDT) for payments received from the contract sponsor on behalf of the student.
If term code or contract number is left NULL, then the query is made without regard to the value of data in those fields.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Sum of the Amount column, or null if no records match parameters.


f_sum_payment_balance

Function f_sum_payment_balance(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                               p_term_code       tbbcstu.tbbcstu_term_code%TYPE DEFAULT NULL,
                               p_contract_number tbbcstu.tbbcstu_contract_number%TYPE DEFAULT NULL,
                               p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE)
  RETURN NUMBER

Sum of balance column for a student in the contract payment detail.
 
Calculates the total of the amount column in contract payment detail (TBRCPDT) for payments received from the contract sponsor on behalf of the student.
If term code or contract number is left NULL, then the query is made without regard to the value of data in those fields.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required
p_term_code   Term associated with the third party contract number. VARCHAR2(6)
p_contract_number   Contract number associated with the third party for the term. NUMBER(8)
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required

Returns
Sum of the Balance column, or null if no records match parameters.


p_create

Procedure p_create(p_stu_pidm              tbbcstu.tbbcstu_stu_pidm%TYPE,
                   p_contract_priority     tbbcstu.tbbcstu_contract_priority%TYPE,
                   p_contract_pidm         tbbcstu.tbbcstu_contract_pidm%TYPE,
                   p_contract_number       tbbcstu.tbbcstu_contract_number%TYPE,
                   p_term_code             tbbcstu.tbbcstu_term_code%TYPE,
                   p_del_ind               tbbcstu.tbbcstu_del_ind%TYPE DEFAULT NULL,
                   p_auth_number           tbbcstu.tbbcstu_auth_number%TYPE DEFAULT NULL,
                   p_auth_ind              tbbcstu.tbbcstu_auth_ind%TYPE DEFAULT NULL,
                   p_student_cont_roll_ind tbbcstu.tbbcstu_student_cont_roll_ind%TYPE,
                   p_term_code_expiration  tbbcstu.tbbcstu_term_code_expiration%TYPE DEFAULT NULL,
                   p_sponsor_ref_number    tbbcstu.tbbcstu_sponsor_ref_number%TYPE DEFAULT NULL,
                   p_user_id               tbbcstu.tbbcstu_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_max_student_amount    tbbcstu.tbbcstu_max_student_amount%TYPE DEFAULT NULL,
                   p_data_origin           tbbcstu.tbbcstu_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required Key
p_contract_priority   This indicates the priority of this contract for the student, if the student is authorized for more than one contract. NUMBER(2) Required
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required Key
p_del_ind   Delete indicator, to inactivate student from the contract after credits initially created. VARCHAR2(1)
D   Student is inactivated from the contract and any credit should be reversed.
NULL   Student is active in the contract.

p_auth_number   A number issued for a student by a third party when a student is authorized to use a contract. VARCHAR2(30)
p_auth_ind   Authorization for student in the contract. VARCHAR2(1)
Y   Student authorized to have charges paid under the contract (also used when authorization not required).
N   Student is not authorized to have charges paid under the contract.
NULL   Authorization pending.

p_student_cont_roll_ind   Contract roll indicator. VARCHAR2(1) Required
Y   Roll the student to new contract when performing contract roll.
N   Do not roll the student to new contract.

p_term_code_expiration   Expiration term, representing the last term that a student should be copied forward by a contract roll process. VARCHAR2(6)
p_sponsor_ref_number   Reference number supplied by the contract sponsor. VARCHAR2(30)
p_user_id   The unique identification of the user. VARCHAR2(30)
p_max_student_amount   Maximum amount a student can have for this contract. NUMBER(7,2)
p_data_origin   Source system that last created or updated the data. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required


p_delete

Procedure p_delete(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                   p_term_code       tbbcstu.tbbcstu_term_code%TYPE,
                   p_contract_number tbbcstu.tbbcstu_contract_number%TYPE,
                   p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required Key
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required Key
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

Procedure p_lock(p_contract_pidm   tbbcstu.tbbcstu_contract_pidm%TYPE,
                 p_term_code       tbbcstu.tbbcstu_term_code%TYPE,
                 p_contract_number tbbcstu.tbbcstu_contract_number%TYPE,
                 p_stu_pidm        tbbcstu.tbbcstu_stu_pidm%TYPE,
                 p_rowid_inout     IN OUT NOCOPY gb_common.internal_record_id_type)

Locks a record.
If the 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_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required Key
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required Key
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

Procedure p_update(p_stu_pidm              tbbcstu.tbbcstu_stu_pidm%TYPE,
                   p_contract_priority     tbbcstu.tbbcstu_contract_priority%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_contract_pidm         tbbcstu.tbbcstu_contract_pidm%TYPE,
                   p_contract_number       tbbcstu.tbbcstu_contract_number%TYPE,
                   p_term_code             tbbcstu.tbbcstu_term_code%TYPE,
                   p_del_ind               tbbcstu.tbbcstu_del_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_auth_number           tbbcstu.tbbcstu_auth_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_auth_ind              tbbcstu.tbbcstu_auth_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_student_cont_roll_ind tbbcstu.tbbcstu_student_cont_roll_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code_expiration  tbbcstu.tbbcstu_term_code_expiration%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sponsor_ref_number    tbbcstu.tbbcstu_sponsor_ref_number%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id               tbbcstu.tbbcstu_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_max_student_amount    tbbcstu.tbbcstu_max_student_amount%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_data_origin           tbbcstu.tbbcstu_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                 gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_stu_pidm   Internal Identification Number of the student authorized for charges to be paid through the third party contract. NUMBER(8) Required Key
p_contract_priority   This indicates the priority of this contract for the student, if the student is authorized for more than one contract. NUMBER(2) Required
p_contract_pidm   Internal Identification Number of the non-person account that is sponsor of a third party contract. NUMBER(8) Required Key
p_contract_number   Contract number associated with the third party for the term. NUMBER(8) Required Key
p_term_code   Term associated with the third party contract number. VARCHAR2(6) Required Key
p_del_ind   Delete indicator, to inactivate student from the contract after credits initially created. VARCHAR2(1)
D   Student is inactivated from the contract and any credit should be reversed.
NULL   Student is active in the contract.

p_auth_number   A number issued for a student by a third party when a student is authorized to use a contract. VARCHAR2(30)
p_auth_ind   Authorization for student in the contract. VARCHAR2(1)
Y   Student authorized to have charges paid under the contract (also used when authorization not required).
N   Student is not authorized to have charges paid under the contract.
NULL   Authorization pending.

p_student_cont_roll_ind   Contract roll indicator. VARCHAR2(1) Required
Y   Roll the student to new contract when performing contract roll.
N   Do not roll the student to new contract.

p_term_code_expiration   Expiration term, representing the last term that a student should be copied forward by a contract roll process. VARCHAR2(6)
p_sponsor_ref_number   Reference number supplied by the contract sponsor. VARCHAR2(30)
p_user_id   The unique identification of the user. VARCHAR2(30)
p_max_student_amount   Maximum amount a student can have for this contract. NUMBER(7,2)
p_data_origin   Source system that last created or updated the data. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)