Package tb_customer

Package tb_customer_profile

The Common Business interface for the Customer Profile API (CUSTOMER_PROFILE).

Program units

f_api_version	Returns the API version number.
f_default_addr_exists	Checks to see if a record exists and returns the default address type and sequence number as out parameters.
f_exists	Checks to see if a record exists.
f_get_credit_limit	Returns the credit limit.
f_isequal	Compare 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

customer_profile_rec	Entity record type
customer_profile_ref	Entity cursor variable type
customer_profile_tab	Entity table type

Constants

M_ENTITY_NAME

Business Entity name

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(16) := 'CUSTOMER_PROFILE';

Business Entity name

customer_profile_rec

TYPE customer_profile_rec IS RECORD (
   r_pidm                    tbbcprf.tbbcprf_pidm%TYPE,
   r_credit_limit            tbbcprf.tbbcprf_credit_limit%TYPE,
   r_ecat_code               tbbcprf.tbbcprf_ecat_code%TYPE,
   r_atyp_code_default       tbbcprf.tbbcprf_atyp_code_default%TYPE,
   r_atyp_seqno_default      tbbcprf.tbbcprf_atyp_seqno_default%TYPE,
   r_user_id                 tbbcprf.tbbcprf_user_id%TYPE,
   r_data_origin             tbbcprf.tbbcprf_data_origin%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

customer_profile_ref

TYPE customer_profile_ref IS REF CURSOR RETURN customer_profile_rec;

Entity cursor variable type

customer_profile_tab

TYPE customer_profile_tab IS TABLE OF customer_profile_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_default_addr_exists

Function f_default_addr_exists(p_pidm                   tbbcprf.tbbcprf_pidm%TYPE,
                               p_atyp_code_default_out  OUT tbbcprf.tbbcprf_atyp_code_default%TYPE,
                               p_atyp_seqno_default_out OUT tbbcprf.tbbcprf_atyp_seqno_default%TYPE)
  RETURN VARCHAR2

Checks to see if a record exists and returns the default address type and sequence number as out parameters.

Parameters

	p_pidm	This column contains the internal reference number for the account.
	p_atyp_code_default	Returns address type default.
	p_atyp_seqno_default	Returns address sequence number default.

Returns

Y if found, otherwise N.

f_exists

Function f_exists(p_pidm  tbbcprf.tbbcprf_pidm%TYPE,
                  p_rowid VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters

	p_pidm	Internal identification number for the entity. NUMBER(8) Required Key
	p_rowid	Database rowid of record to select. VARCHAR2(18)

Returns

Y if found, otherwise N.

f_get_credit_limit

Function f_get_credit_limit(p_pidm tbbcprf.tbbcprf_pidm%TYPE)
  RETURN tbbcprf.tbbcprf_credit_limit%TYPE

Returns the credit limit.

Parameters

p_pidm

This column contains the internal reference number for the account.

Returns

Credit limit amount if row found and amount exists, otherwise null.

f_isequal

Function f_isequal(rec_one customer_profile_rec,
                   rec_two customer_profile_rec) RETURN VARCHAR2

Compare 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 deposit_rec Required
	rec_two	The second record to compare. Type deposit_rec Required

Returns

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

f_query_all

Function f_query_all(p_pidm tbbcprf.tbbcprf_pidm%TYPE)
  RETURN customer_profile_ref

Selects all records for the entity.

Parameters

p_pidm

Internal identification number for the entity. NUMBER(8) Required Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

Function f_query_one(p_pidm tbbcprf.tbbcprf_pidm%TYPE)
  RETURN customer_profile_ref

Selects one record using key.

Parameters

p_pidm

Internal identification number for the entity. 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 VARCHAR2) RETURN customer_profile_ref

Selects one record using rowid.

Parameters

p_rowid

Database rowid of record to select. VARCHAR2(18) Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

Function f_query_one_lock(p_pidm  tbbcprf.tbbcprf_pidm%TYPE,
                          p_rowid VARCHAR2 DEFAULT NULL)
  RETURN customer_profile_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number for the entity. NUMBER(8) Required Key
	p_rowid	Database rowid of record to select. VARCHAR2(18)

Returns

A cursor variable for one record, locking the record.

p_create

Procedure p_create(p_pidm               tbbcprf.tbbcprf_pidm%TYPE,
                   p_credit_limit       tbbcprf.tbbcprf_credit_limit%TYPE DEFAULT NULL,
                   p_ecat_code          tbbcprf.tbbcprf_ecat_code%TYPE DEFAULT NULL,
                   p_atyp_code_default  tbbcprf.tbbcprf_atyp_code_default%TYPE DEFAULT NULL,
                   p_atyp_seqno_default tbbcprf.tbbcprf_atyp_seqno_default%TYPE DEFAULT NULL,
                   p_user_id            tbbcprf.tbbcprf_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin        tbbcprf.tbbcprf_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out          OUT VARCHAR2)

Creates a record.

Address Code and Sequence Number must both be populated or both be null. If provided, the combination must exist as a valid, active address in the Address Table (SPRADDR).

A warning may be issued when the account balance exceeds the Credit Limit, but transaction processing is not prevented on over-limit accounts.

Parameters

	p_pidm	Internal identification number for the entity. NUMBER(8) Required Key
	p_credit_limit	Maximum balance which may be incurred on the account. NUMBER(12,2)
	p_ecat_code	Category of the entity, valid in TTVECAT. VARCHAR2(2)
	p_atyp_code_default	In combination with ATYP_SEQNO_DEFAULT, the default address (in Accounts Receivable) to which a bill will be sent for non-student transactions. Valid in STVATYP. VARCHAR2(2)
	p_atyp_seqno_default	In combination with ATYP_CODE_DEFAULT, the default address (in Accounts Receivable) to which a bill will be sent for non-student transactions. Combination valid and active in SPRADDR. NUMBER(2)
	p_user_id	ID of the user who last created or updated the record. VARCHAR2(30)
	p_data_origin	Source system that last created or updated the data. VARCHAR2(30)
	p_rowid_out	Database rowid of record created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm  tbbcprf.tbbcprf_pidm%TYPE,
                   p_rowid VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	Internal identification number for the entity. NUMBER(8) Required Key
	p_rowid	Database rowid of record to delete. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        tbbcprf.tbbcprf_pidm%TYPE,
                 p_rowid_inout IN OUT VARCHAR2)

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_pidm	Internal identification number for the entity. NUMBER(8) Required Key
	p_rowid_inout	Database rowid of record to lock. VARCHAR2(18) Required

p_update

Procedure p_update(p_pidm               tbbcprf.tbbcprf_pidm%TYPE,
                   p_credit_limit       tbbcprf.tbbcprf_credit_limit%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_ecat_code          tbbcprf.tbbcprf_ecat_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_code_default  tbbcprf.tbbcprf_atyp_code_default%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_atyp_seqno_default tbbcprf.tbbcprf_atyp_seqno_default%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_user_id            tbbcprf.tbbcprf_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin        tbbcprf.tbbcprf_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid              VARCHAR2 DEFAULT NULL)

Updates a record.
PIDM or ROWID is required.

Address Code and Sequence Number must both be populated or both be null. If provided, the combination must exist as a valid, active address in the Address Table (SPRADDR).

A warning may be issued when the account balance exceeds the Credit Limit, but transaction processing is not prevented on over-limit accounts.

Parameters

	p_pidm	Internal identification number for the entity. NUMBER(8) Required Key
	p_credit_limit	Maximum balance which may be incurred on the account. NUMBER(12,2)
	p_ecat_code	Category of the entity, valid in TTVECAT. VARCHAR2(2)
	p_atyp_code_default	In combination with ATYP_SEQNO_DEFAULT, the default address (in Accounts Receivable) to which a bill will be sent for non-student transactions. Valid in STVATYP. VARCHAR2(2)
	p_atyp_seqno_default	In combination with ATYP_CODE_DEFAULT, the default address (in Accounts Receivable) to which a bill will be sent for non-student transactions. Combination valid and active in SPRADDR. NUMBER(2)
	p_user_id	ID of the user who last created or updated the record. VARCHAR2(30)
	p_data_origin	Source system that last created or updated the data. VARCHAR2(30)
	p_rowid	Database rowid of record to update. VARCHAR2(18)