M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(5) := 'EMAIL';

Business Entity Name

email_rec

TYPE email_rec IS RECORD (
  r_pidm                    goremal.goremal_pidm%TYPE,
  r_emal_code               goremal.goremal_emal_code%TYPE,
  r_email_address           goremal.goremal_email_address%TYPE,
  r_status_ind              goremal.goremal_status_ind%TYPE,
  r_preferred_ind           goremal.goremal_preferred_ind%TYPE,
  r_user_id                 goremal.goremal_user_id%TYPE,
  r_comment                 goremal.goremal_comment%TYPE,
  r_disp_web_ind            goremal.goremal_disp_web_ind%TYPE,
  r_data_origin             goremal.goremal_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

email_ref

TYPE email_ref IS REF CURSOR RETURN email_rec;

Entity cursor variable type

email_tab

TYPE email_tab IS TABLE OF email_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version

FUNCTION f_api_version RETURN PLS_INTEGER

Returns the API version number.

f_exists

FUNCTION f_exists(p_pidm          goremal.goremal_pidm%TYPE,
                  p_emal_code     goremal.goremal_emal_code%TYPE,
                  p_email_address goremal.goremal_email_address%TYPE,
                  p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

f_isequal

FUNCTION f_isequal(rec_one email_rec,
                   rec_two email_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.

f_query_all

FUNCTION f_query_all(p_pidm          goremal.goremal_pidm%TYPE,
                     p_emal_code     goremal.goremal_emal_code%TYPE,
                     p_email_address goremal.goremal_email_address%TYPE)
  RETURN email_ref

Selects all records for the entity.
The LIKE operator is used to match p_emal_code and p_email_address.
Passing PIDM and '%' for p_emal_code and p_email_address returns all e-mail addresses for a PIDM.

f_query_one

FUNCTION f_query_one(p_pidm          goremal.goremal_pidm%TYPE,
                     p_emal_code     goremal.goremal_emal_code%TYPE,
                     p_email_address goremal.goremal_email_address%TYPE)
  RETURN email_ref

Selects one record using key.

f_query_by_rowid

FUNCTION f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN email_ref

Selects one record using the ROWID.

f_query_one_lock

FUNCTION f_query_one_lock(p_pidm          goremal.goremal_pidm%TYPE,
                          p_emal_code     goremal.goremal_emal_code%TYPE,
                          p_email_address goremal.goremal_email_address%TYPE,
                          p_rowid         gb_common.internal_record_id_type DEFAULT NULL)
  RETURN email_ref

Selects one record and locks it.

p_create

PROCEDURE p_create(p_pidm          goremal.goremal_pidm%TYPE,
                   p_emal_code     goremal.goremal_emal_code%TYPE,
                   p_email_address goremal.goremal_email_address%TYPE,
                   p_status_ind    goremal.goremal_status_ind%TYPE DEFAULT 'A',
                   p_preferred_ind goremal.goremal_preferred_ind%TYPE DEFAULT 'N',
                   p_user_id       goremal.goremal_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_comment       goremal.goremal_comment%TYPE DEFAULT NULL,
                   p_disp_web_ind  goremal.goremal_disp_web_ind%TYPE DEFAULT 'Y',
                   p_data_origin   goremal.goremal_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out     OUT gb_common.internal_record_id_type)

Creates an e-mail record.

p_delete

PROCEDURE p_delete(p_pidm          goremal.goremal_pidm%TYPE,
                   p_emal_code     goremal.goremal_emal_code%TYPE,
                   p_email_address goremal.goremal_email_address%TYPE,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Deletes an e-mail record.

p_lock

PROCEDURE p_lock(p_pidm          goremal.goremal_pidm%TYPE,
                 p_emal_code     goremal.goremal_emal_code%TYPE,
                 p_email_address goremal.goremal_email_address%TYPE,
                 p_rowid_inout   IN OUT 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

p_update

PROCEDURE p_update(p_pidm          goremal.goremal_pidm%TYPE,
                   p_emal_code     goremal.goremal_emal_code%TYPE,
                   p_email_address goremal.goremal_email_address%TYPE,
                   p_status_ind    goremal.goremal_status_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_preferred_ind goremal.goremal_preferred_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id       goremal.goremal_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_comment       goremal.goremal_comment%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_disp_web_ind  goremal.goremal_disp_web_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin   goremal.goremal_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Updates an e-mail record.
In order to support "update" of e-mail Code and e-mail address, this API does the following: If ROWID is passed, the e-mail address and code passed in are compared to the record identified by the ROWID. If either one is different, then the record retrieved by the ROWID is deleted and a new record is created with the new e-mail and code along with any other data from the original record that is not being updated as well.

 If ROWID is not passed, the e-mail address and type cannot be updated
and are simply used as the key to locate the record to be updated.