Package sb_mass_entry

Package sb_mass_entry_form

This package provides the common business interface for the Mass Entry Form API (sb_mass_entry_form). This has the header information for each mass entry session. The keys to the mass entry are the form name, user ID and date with timestamp initiated.

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 the key.
f_query_by_rowid	Selects one record using the 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

mass_entry_form_rec	Business Entity record type
mass_entry_form_ref	Entity cursor variable type
mass_entry_form_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(15) := 'MASS_ENTRY_FORM';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

mass_entry_form_rec

TYPE mass_entry_form_rec IS RECORD (
  r_add_user_id             sobmaud.sobmaud_add_user_id%TYPE,
  r_add_date                sobmaud.sobmaud_add_date%TYPE,
  r_form_name               sobmaud.sobmaud_form_name%TYPE,
  r_data_origin             sobmaud.sobmaud_data_origin%TYPE,
  r_user_id                 sobmaud.sobmaud_user_id%TYPE,
  r_job_name                sobmaud.sobmaud_job_name%TYPE,
  r_completion_date         sobmaud.sobmaud_completion_date%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

mass_entry_form_ref

TYPE mass_entry_form_ref IS REF CURSOR RETURN mass_entry_form_rec;

Entity cursor variable type

mass_entry_form_tab

TYPE mass_entry_form_tab IS TABLE OF mass_entry_form_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_form_name   sobmaud.sobmaud_form_name%TYPE,
                  p_add_user_id sobmaud.sobmaud_add_user_id%TYPE,
                  p_add_date    sobmaud.sobmaud_add_date%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE 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 mass_entry_form_rec,
                   rec_two mass_entry_form_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 mass_entry_form_rec Required
	rec_two	The second record to compare. Type mass_entry_form_rec Required

Returns

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

f_query_all

Function f_query_all(p_form_name   sobmaud.sobmaud_form_name%TYPE,
                     p_add_user_id sobmaud.sobmaud_add_user_id%TYPE,
                     p_add_date    sobmaud.sobmaud_add_date%TYPE)
  RETURN mass_entry_form_ref

Selects all records for the entity.

Parameters

	p_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_form_name   sobmaud.sobmaud_form_name%TYPE,
                     p_add_user_id sobmaud.sobmaud_add_user_id%TYPE,
                     p_add_date    sobmaud.sobmaud_add_date%TYPE)
  RETURN mass_entry_form_ref

Selects one record using the key.

Parameters

	p_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE 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 mass_entry_form_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_form_name   sobmaud.sobmaud_form_name%TYPE,
                          p_add_user_id sobmaud.sobmaud_add_user_id%TYPE,
                          p_add_date    sobmaud.sobmaud_add_date%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN mass_entry_form_ref

Selects one record and locks it.

Parameters

	p_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE 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_add_user_id     sobmaud.sobmaud_add_user_id%TYPE,
                   p_add_date        sobmaud.sobmaud_add_date%TYPE,
                   p_form_name       sobmaud.sobmaud_form_name%TYPE,
                   p_data_origin     sobmaud.sobmaud_data_origin%TYPE,
                   p_user_id         sobmaud.sobmaud_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_job_name        sobmaud.sobmaud_job_name%TYPE DEFAULT NULL,
                   p_completion_date sobmaud.sobmaud_completion_date%TYPE DEFAULT NULL,
                   p_rowid_out       OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE Required Key
	p_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_data_origin	Data origin of the insert or update to the record. VARCHAR2(30) Required
	p_user_id	Most recent user to create or update the record. VARCHAR2(30) Required
	p_job_name	Job submission ID the mass entry process is submitted under. VARCHAR2(30)
	p_completion_date	Date and timestamp the mass entry completed. DATE
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_form_name   sobmaud.sobmaud_form_name%TYPE,
                   p_add_user_id sobmaud.sobmaud_add_user_id%TYPE,
                   p_add_date    sobmaud.sobmaud_add_date%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_form_name   sobmaud.sobmaud_form_name%TYPE,
                 p_add_user_id sobmaud.sobmaud_add_user_id%TYPE,
                 p_add_date    sobmaud.sobmaud_add_date%TYPE,
                 p_rowid_inout IN OUT 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_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

Procedure p_update(p_add_user_id     sobmaud.sobmaud_add_user_id%TYPE,
                   p_add_date        sobmaud.sobmaud_add_date%TYPE,
                   p_form_name       sobmaud.sobmaud_form_name%TYPE,
                   p_data_origin     sobmaud.sobmaud_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         sobmaud.sobmaud_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_job_name        sobmaud.sobmaud_job_name%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_completion_date sobmaud.sobmaud_completion_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_add_user_id	ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
	p_add_date	Date and timestamp the mass entry was initiated. DATE Required Key
	p_form_name	Mass entry form name. VARCHAR2(30) Required Key
	p_data_origin	Data origin of the insert or update to the record. VARCHAR2(30) Required
	p_user_id	Most recent user to create or update the record. VARCHAR2(30) Required
	p_job_name	Job submission ID the mass entry process is submitted under. VARCHAR2(30)
	p_completion_date	Date and timestamp the mass entry completed. DATE
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)