index

Package sb_registration_msg

This package provides the Common Business interface for the Registration Error Messages API (sb_registration_msg).

Program units
f_api_version  
f_exists  
f_isequal  
f_query_all  
f_query_one  
f_query_by_rowid  
f_query_one_lock  
f_get_message  
p_create  
p_delete  
p_lock  
p_update  

Types
registration_msg_rec  
registration_msg_ref  
registration_msg_tab  

Constants
M_ENTITY_NAME  
M_BASE_TABLE_NAME  

M_ENTITY_NAME 

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

Business Entity Name

M_BASE_TABLE_NAME 

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

Base table name

registration_msg_rec 

TYPE registration_msg_rec IS RECORD (
  r_cde                     sfrrmsg.sfrrmsg_cde%TYPE,
  r_seqno                   sfrrmsg.sfrrmsg_seqno%TYPE,
  r_sys_req_ind             sfrrmsg.sfrrmsg_sys_req_ind%TYPE,
  r_data_origin             sfrrmsg.sfrrmsg_data_origin%TYPE,
  r_user_id                 sfrrmsg.sfrrmsg_user_id%TYPE,
  r_message                 sfrrmsg.sfrrmsg_message%TYPE,
  r_local_message           sfrrmsg.sfrrmsg_local_message%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

registration_msg_ref 

TYPE registration_msg_ref IS REF CURSOR RETURN registration_msg_rec;

Entity cursor variable type

registration_msg_tab 

TYPE registration_msg_tab IS TABLE OF registration_msg_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_cde   sfrrmsg.sfrrmsg_cde%TYPE,
                  p_seqno sfrrmsg.sfrrmsg_seqno%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) 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 registration_msg_rec,
                   rec_two registration_msg_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 registration_msg_rec Required
rec_two   The second record to compare. Type registration_msg_rec Required

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

f_query_all 

Function f_query_all(p_cde   sfrrmsg.sfrrmsg_cde%TYPE,
                     p_seqno sfrrmsg.sfrrmsg_seqno%TYPE)
  RETURN registration_msg_ref

Selects all records for the entity.

Parameters
p_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) Required Key

Returns
A cursor variable that will fetch a set of records.

f_query_one 

Function f_query_one(p_cde   sfrrmsg.sfrrmsg_cde%TYPE,
                     p_seqno sfrrmsg.sfrrmsg_seqno%TYPE)
  RETURN registration_msg_ref

Selects one record using the key.

Parameters
p_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) 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 registration_msg_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_cde   sfrrmsg.sfrrmsg_cde%TYPE,
                          p_seqno sfrrmsg.sfrrmsg_seqno%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN registration_msg_ref

Selects one record and locks it.

Parameters
p_cde   Specifies the type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.

f_get_message 

Function f_get_message(p_cde           sfrrmsg.sfrrmsg_cde%TYPE,
                       p_seqno         sfrrmsg.sfrrmsg_seqno%TYPE,
                       p_placeholder_1 VARCHAR2 DEFAULT NULL,
                       p_placeholder_2 VARCHAR2 DEFAULT NULL,
                       p_placeholder_3 VARCHAR2 DEFAULT NULL)
  RETURN VARCHAR2

Returns a message for a given code and sequence number, interpreting any given placeholders.

Parameters
p_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) Required Key
p_placeholder_1   First placeholder value. VARCHAR2
p_placeholder_2   Second placeholder value. VARCHAR2
p_placeholder_3   Third placeholder value. VARCHAR2

Returns
the message.

p_create 

Procedure p_create(p_cde           sfrrmsg.sfrrmsg_cde%TYPE,
                   p_seqno         sfrrmsg.sfrrmsg_seqno%TYPE,
                   p_sys_req_ind   sfrrmsg.sfrrmsg_sys_req_ind%TYPE,
                   p_data_origin   sfrrmsg.sfrrmsg_data_origin%TYPE,
                   p_user_id       sfrrmsg.sfrrmsg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_message       sfrrmsg.sfrrmsg_message%TYPE DEFAULT NULL,
                   p_local_message sfrrmsg.sfrrmsg_local_message%TYPE DEFAULT NULL,
                   p_rowid_out     OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) Required Key
p_sys_req_ind   Indicates that the row is not to be removed. VARCHAR2(1) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30) Required
p_user_id   User ID of the user who created or last updated the record. VARCHAR2(30) Required
p_message   Message text as delivered. VARCHAR2(200)
p_local_message   Client-defined message text, which overrides the delivered text. VARCHAR2(200)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_cde   sfrrmsg.sfrrmsg_cde%TYPE,
                   p_seqno sfrrmsg.sfrrmsg_seqno%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_cde         sfrrmsg.sfrrmsg_cde%TYPE,
                 p_seqno       sfrrmsg.sfrrmsg_seqno%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_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_cde           sfrrmsg.sfrrmsg_cde%TYPE,
                   p_seqno         sfrrmsg.sfrrmsg_seqno%TYPE,
                   p_sys_req_ind   sfrrmsg.sfrrmsg_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin   sfrrmsg.sfrrmsg_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id       sfrrmsg.sfrrmsg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_message       sfrrmsg.sfrrmsg_message%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_local_message sfrrmsg.sfrrmsg_local_message%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid         gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_cde   Type of error message. VARCHAR2(4) Required Key
p_seqno   Sequence number of the error message. NUMBER(4) Required Key
p_sys_req_ind   Indicates that the row is not to be removed. VARCHAR2(1) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30) Required
p_user_id   User ID of the user who created or last updated the record. VARCHAR2(30) Required
p_message   Message text as delivered. VARCHAR2(200)
p_local_message   Client-defined message text, which overrides the delivered text. VARCHAR2(200)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)