Package pb_payment

Package pb_payment_type

This package provides the common business interface for the Canadian Record of Employment Pay Type Rules API (PB_PAYMENT_TYPE).

Program units

f_api_version	Returns the API version number.
f_exists	Checks 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

payment_type_rec	Business Entity record type
payment_type_ref	Entity cursor variable type
payment_type_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(12) := 'PAYMENT_TYPE';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

payment_type_rec

TYPE payment_type_rec IS RECORD (
  r_type                    ptrroep.ptrroep_type%TYPE,
  r_code                    ptrroep.ptrroep_code%TYPE,
  r_amount_method           ptrroep.ptrroep_amount_method%TYPE,
  r_start_date_method       ptrroep.ptrroep_start_date_method%TYPE,
  r_end_date_method         ptrroep.ptrroep_end_date_method%TYPE,
  r_period_method           ptrroep.ptrroep_period_method%TYPE,
  r_user_id                 ptrroep.ptrroep_user_id%TYPE,
  r_data_origin             ptrroep.ptrroep_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

payment_type_ref

TYPE payment_type_ref IS REF CURSOR RETURN payment_type_rec;

Entity cursor variable type

payment_type_tab

TYPE payment_type_tab IS TABLE OF payment_type_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_type  ptrroep.ptrroep_type%TYPE,
                  p_code  ptrroep.ptrroep_code%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) 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 payment_type_rec, rec_two payment_type_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 payment_type_rec Required
	rec_two	The second record to compare. Type payment_type_rec Required

Returns

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

f_query_all

Function f_query_all(p_type ptrroep.ptrroep_type%TYPE,
                     p_code ptrroep.ptrroep_code%TYPE)
  RETURN payment_type_ref

Selects all records for the entity.

Parameters

	p_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_type ptrroep.ptrroep_type%TYPE,
                     p_code ptrroep.ptrroep_code%TYPE)
  RETURN payment_type_ref

Selects one record using key.

Parameters

	p_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) 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 payment_type_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_type  ptrroep.ptrroep_type%TYPE,
                          p_code  ptrroep.ptrroep_code%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN payment_type_ref

Selects one record and locks it.

Parameters

	p_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) 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_type              ptrroep.ptrroep_type%TYPE,
                   p_code              ptrroep.ptrroep_code%TYPE,
                   p_amount_method     ptrroep.ptrroep_amount_method%TYPE,
                   p_start_date_method ptrroep.ptrroep_start_date_method%TYPE,
                   p_end_date_method   ptrroep.ptrroep_end_date_method%TYPE,
                   p_period_method     ptrroep.ptrroep_period_method%TYPE,
                   p_user_id           ptrroep.ptrroep_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin       ptrroep.ptrroep_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out         OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) Required Key
	p_amount_method	Designates if an amount is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_start_date_method	Designates if a start date is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_end_date_method	Designates if an end date is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_period_method	Designates if a period is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_user_id	The user ID of the person who inserted or last updated this record. VARCHAR2(30) 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_delete

Procedure p_delete(p_type  ptrroep.ptrroep_type%TYPE,
                   p_code  ptrroep.ptrroep_code%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_type        ptrroep.ptrroep_type%TYPE,
                 p_code        ptrroep.ptrroep_code%TYPE,
                 p_rowid_inout IN OUT NOCOPY 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_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_type              ptrroep.ptrroep_type%TYPE,
                   p_code              ptrroep.ptrroep_code%TYPE,
                   p_amount_method     ptrroep.ptrroep_amount_method%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_start_date_method ptrroep.ptrroep_start_date_method%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_end_date_method   ptrroep.ptrroep_end_date_method%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_period_method     ptrroep.ptrroep_period_method%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id           ptrroep.ptrroep_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin       ptrroep.ptrroep_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid             gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_type	(V)acation, (M)Other monies or (S)pecial payment. VARCHAR2(1) Required Key
	p_code	Valid vacation, other monies or special payment code. VARCHAR2(5) Required Key
	p_amount_method	Designates if an amount is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_start_date_method	Designates if a start date is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_end_date_method	Designates if an end date is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_period_method	Designates if a period is (M)andatory, (O)ptional, or (N)o entry allowed. VARCHAR2(1) Required
	p_user_id	The user ID of the person who inserted or last updated this record. VARCHAR2(30) 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)