Package sb_compliance

Package sb_compliance_xml

This package provides the Common Business interface for the Compliance XML API (sb_compliance_xml).

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.

Types

compliance_xml_rec	Business Entity record type
compliance_xml_ref	Entity cursor variable type
compliance_xml_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(14) := 'COMPLIANCE_XML';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

compliance_xml_rec

TYPE compliance_xml_rec IS RECORD (
  r_pidm                    smrcxml.smrcxml_pidm%TYPE,
  r_request_no              smrcxml.smrcxml_request_no%TYPE,
  r_sessionid               smrcxml.smrcxml_sessionid%TYPE,
  r_user_id                 smrcxml.smrcxml_user_id%TYPE,
  r_data_origin             smrcxml.smrcxml_data_origin%TYPE,
  r_proc_sessionid          smrcxml.smrcxml_proc_sessionid%TYPE,
  r_xml                     smrcxml.smrcxml_xml%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

compliance_xml_ref

TYPE compliance_xml_ref IS REF CURSOR RETURN compliance_xml_rec;

Entity cursor variable type

compliance_xml_tab

TYPE compliance_xml_tab IS TABLE OF compliance_xml_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_pidm       smrcxml.smrcxml_pidm%TYPE,
                  p_request_no smrcxml.smrcxml_request_no%TYPE,
                  p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	Internal identification number of the person for whom compliance was run. NUMBER(8) Required Key
	p_request_no	Unique number of the compliance request. 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 compliance_xml_rec, rec_two compliance_xml_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 compliance_xml_rec Required
	rec_two	The second record to compare. Type compliance_xml_rec Required

Returns

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

f_query_all

Function f_query_all(p_pidm       smrcxml.smrcxml_pidm%TYPE,
                     p_request_no smrcxml.smrcxml_request_no%TYPE)
  RETURN compliance_xml_ref

Selects all records for the entity.

Parameters

	p_pidm	Internal identification number of the person for whom compliance was run. NUMBER(8) Required Key
	p_request_no	Unique number of the compliance request. NUMBER(4) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

Function f_query_one(p_pidm       smrcxml.smrcxml_pidm%TYPE,
                     p_request_no smrcxml.smrcxml_request_no%TYPE)
  RETURN compliance_xml_ref

Selects one record using the key.

Parameters

	p_pidm	Internal identification number of the person for whom compliance was run. NUMBER(8) Required Key
	p_request_no	Unique number of the compliance request. 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 compliance_xml_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_pidm       smrcxml.smrcxml_pidm%TYPE,
                          p_request_no smrcxml.smrcxml_request_no%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN compliance_xml_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal identification number of the person for whom compliance was run. NUMBER(8) Required Key
	p_request_no	Unique number of the compliance request. 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.

p_create

Procedure p_create(p_pidm           smrcxml.smrcxml_pidm%TYPE,
                   p_request_no     smrcxml.smrcxml_request_no%TYPE,
                   p_sessionid      smrcxml.smrcxml_sessionid%TYPE,
                   p_user_id        smrcxml.smrcxml_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    smrcxml.smrcxml_data_origin%TYPE DEFAULT NULL,
                   p_proc_sessionid smrcxml.smrcxml_proc_sessionid%TYPE DEFAULT NULL,
                   p_xml            smrcxml.smrcxml_xml%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_pidm	Internal identification number of the person for whom compliance was run. NUMBER(8) Required Key
	p_request_no	Unique number of the compliance request. NUMBER(4) Required Key
	p_sessionid	Oracle session ID of the compliance request. VARCHAR2(120) Required
	p_user_id	ID of the user who created the record. VARCHAR2(120) Required
	p_data_origin	Source system that generated the data. VARCHAR2(120)
	p_proc_sessionid	Oracle session ID of the compliance process. VARCHAR2(120)
	p_xml	Output of the compliance in XML format. XMLTYPE
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

Procedure p_delete(p_pidm       smrcxml.smrcxml_pidm%TYPE,
                   p_request_no smrcxml.smrcxml_request_no%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_pidm	Internal identification number of the person for whom compliance was run. NUMBER(8) Required Key
	p_request_no	Unique number of the compliance request. NUMBER(4) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

Procedure p_lock(p_pidm        smrcxml.smrcxml_pidm%TYPE,
                 p_request_no  smrcxml.smrcxml_request_no%TYPE,
                 p_rowid_inout IN OUT NOCOPY 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_pidm	Internal identification number of the person for whom compliance was run. NUMBER(8) Required Key
	p_request_no	Unique number of the compliance request. NUMBER(4) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required