index

Package gb_email_rules

Support subprograms for the EMAIL API (gb_email).

Program units
f_preferred_ind_rule   Returns the value to set the preferred indicator to when status is inactive.
p_register_entity   Register the attribute/value pairs to the message cache.
p_register_entity   Register the attribute/value pairs to the message cache.
p_validate   Validates all the data in the record.

f_preferred_ind_rule 

FUNCTION f_preferred_ind_rule(p_preferred_ind goremal.goremal_preferred_ind%TYPE,
                              p_status_ind    goremal.goremal_status_ind%TYPE)
  RETURN goremal.goremal_preferred_ind%TYPE

Returns the value to set the preferred indicator to when status is inactive.

Parameters
p_preferred_ind   Indicates if the E-mail Address is the preferred contact address. VARCHAR2(1) Required
Y   Preferred
N   Not Preferred

p_status_ind   The status of the E-mail Address.
A   Active
I   Inactive


Returns
N if status is inactive, otherwise NULL.

p_register_entity 

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            p_internal_record_id gb_common.internal_record_id_type)

Register the attribute/value pairs to the message cache.
This signature uses the ROWID only for the delete operations.

Parameters
p_internal_record_id   Database ROWID

p_register_entity 

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            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,
                            p_preferred_ind      goremal.goremal_preferred_ind%TYPE,
                            p_user_id            goremal.goremal_user_id%TYPE DEFAULT gb_common.f_sct_user,
                            p_comment            goremal.goremal_comment%TYPE,
                            p_disp_web_ind       goremal.goremal_disp_web_ind%TYPE,
                            p_data_origin        goremal.goremal_data_origin%TYPE,
                            p_internal_record_id gb_common.internal_record_id_type)

Register the attribute/value pairs to the message cache.
This signature registers the all parameters

Parameters
p_pidm   The PIDM of the entity who owns this e-mail information. NUMBER(8) Required Key
p_emal_code   The type of E-mail Address. VARCHAR2(4) Required Key
p_email_address   The E-mail Address. VARCHAR2(90) Required Key
p_status_ind   The status of the E-mail Address.
A   Active
I   Inactive

p_preferred_ind   Indicates if the E-mail Address is the preferred contact address. VARCHAR2(1) Required
Y   Preferred
N   Not Preferred

p_user_id   The Oracle user ID when the row was added or modified. VARCHAR2(30) Required
p_comment   This is a free format comment regarding the e-mail information. VARCHAR2(60)
p_disp_web_ind   Indicates whether an E-mail Address should appear on the Web. VARCHAR2(1) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_internal_record_id   Database ROWID

p_validate 

PROCEDURE p_validate(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,
                     p_preferred_ind goremal.goremal_preferred_ind%TYPE,
                     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,
                     p_data_origin   goremal.goremal_data_origin%TYPE DEFAULT NULL,
                     p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Validates all the data in the record.

Parameters
p_pidm   The PIDM of the entity who owns this e-mail information. NUMBER(8) Required Key
p_emal_code   The type of E-mail Address. VARCHAR2(4) Required Key
p_email_address   The E-mail Address. VARCHAR2(90) Required Key
p_status_ind   The status of the E-mail Address.
A   Active
I   Inactive

p_preferred_ind   Indicates if the E-mail Address is the preferred contact address. VARCHAR2(1) Required
Y   Preferred
N   Not Preferred

p_user_id   The Oracle user ID when the row was added or modified. VARCHAR2(30) Required
p_comment   This is a free format comment regarding the e-mail information. VARCHAR2(60)
p_disp_web_ind   Indicates whether an E-mail Address should appear on the Web. VARCHAR2(1) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Optional rowid to help determine whether there is another row (other than the current one) that has the preferred indicator set. ROWID