index

Package gb_partner_rule

Common Business interface for the PARTNER_RULE API (gb_partner_rule).


Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if a record exists.
f_exists_by_partner   Checks to see if a GORINTG record exists that uses a specified GTVINTP code.
f_isequal   Compares two records for equality.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using key.
f_query_by_rowid   Selects one record using 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
partner_rule_rec   Business Entity record type
partner_rule_ref   Entity cursor variable type
partner_rule_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name


M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(12) := 'PARTNER_RULE';

Business Entity Name


partner_rule_rec

TYPE partner_rule_rec IS RECORD (
  r_integration_cde         gorintg.gorintg_integration_cde%TYPE,
  r_desc                    gorintg.gorintg_desc%TYPE,
  r_intp_code               gorintg.gorintg_intp_code%TYPE,
  r_user_id                 gorintg.gorintg_user_id%TYPE,
  r_data_origin             gorintg.gorintg_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


partner_rule_ref

TYPE partner_rule_ref IS REF CURSOR RETURN partner_rule_rec;

Entity cursor variable type


partner_rule_tab

TYPE partner_rule_tab IS TABLE OF partner_rule_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_integration_cde gorintg.gorintg_integration_cde%TYPE,
                  p_rowid           gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.


f_exists_by_partner

FUNCTION f_exists_by_partner(p_intp_code gorintg.gorintg_intp_code%TYPE,
                             p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a GORINTG record exists that uses a specified GTVINTP code.

Parameters
p_intp_cde   User Defined Integration Partner Code that is used with external partner. VARCHAR2(5) 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 partner_rule_rec,
                   rec_two partner_rule_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 partner_rule_rec Required
rec_two   The second record to compare. Type partner_rule_rec Required

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


f_query_all

FUNCTION f_query_all(p_integration_cde gorintg.gorintg_integration_cde%TYPE)
  RETURN partner_rule_ref

Selects all records for the entity.

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) Required Key

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


f_query_one

FUNCTION f_query_one(p_integration_cde gorintg.gorintg_integration_cde%TYPE)
  RETURN partner_rule_ref

Selects one record using key.

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) 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 partner_rule_ref

Selects one record using 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_integration_cde gorintg.gorintg_integration_cde%TYPE,
                          p_rowid           gb_common.internal_record_id_type DEFAULT NULL)
  RETURN partner_rule_ref

Selects one record and locks it.

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) 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_integration_cde gorintg.gorintg_integration_cde%TYPE,
                   p_desc            gorintg.gorintg_desc%TYPE,
                   p_intp_code       gorintg.gorintg_intp_code%TYPE,
                   p_user_id         gorintg.gorintg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     gorintg.gorintg_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out       OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) Required Key
p_desc   User Description of the Integration Code. VARCHAR2(30) Required
p_intp_code   Code defined on GTVINTG that associates with the User Integration Code. VARCHAR2(5) Required
p_user_id   Oracle User ID of the person who inserted or last updated the data VARCHAR2(30) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required


p_delete

PROCEDURE p_delete(p_integration_cde gorintg.gorintg_integration_cde%TYPE,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

PROCEDURE p_lock(p_integration_cde gorintg.gorintg_integration_cde%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

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

PROCEDURE p_update(p_integration_cde gorintg.gorintg_integration_cde%TYPE,
                   p_desc            gorintg.gorintg_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_intp_code       gorintg.gorintg_intp_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         gorintg.gorintg_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin     gorintg.gorintg_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_integration_cde   User Defined Integration Code that is used with external partner. VARCHAR2(5) Required Key
p_desc   User Description of the Integration Code. VARCHAR2(30) Required
p_intp_code   Code defined on GTVINTG that associates with the User Integration Code. VARCHAR2(5) Required
p_user_id   The unique identification of the user. VARCHAR2(30) Required
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)