index

Package gb_sde_discriminator

Common Business interface for the SDE_DISCRIMINATOR API (gb_sde_discriminator).


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 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
sde_discriminator_rec   Business Entity record type
sde_discriminator_ref   Entity cursor variable type
sde_discriminator_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(17) := 'SDE_DISCRIMINATOR';

Business Entity Name


M_BASE_TABLE_NAME

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

Base table name


sde_discriminator_rec

TYPE sde_discriminator_rec IS RECORD (
    r_code                    gobsddc.gobsddc_code%TYPE,
    r_desc                    gobsddc.gobsddc_desc%TYPE,
    r_method                  gobsddc.gobsddc_method%TYPE,
    r_user_id                 gobsddc.gobsddc_user_id%TYPE,
    r_validation              gobsddc.gobsddc_validation%TYPE,
    r_data_origin             gobsddc.gobsddc_data_origin%TYPE,
                                                                         
    r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type


sde_discriminator_ref

TYPE sde_discriminator_ref IS REF CURSOR RETURN sde_discriminator_rec;

Entity cursor variable type


sde_discriminator_tab

TYPE sde_discriminator_tab IS TABLE OF sde_discriminator_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_code  gobsddc.gobsddc_code%TYPE,
                  p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_code   Discriminator Code. VARCHAR2(30) 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 sde_discriminator_rec,
                   rec_two sde_discriminator_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 sde_discriminator_rec Required
rec_two   The second record to compare. Type sde_discriminator_rec Required

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


f_query_all

FUNCTION f_query_all(p_code gobsddc.gobsddc_code%TYPE)
  RETURN sde_discriminator_ref

Selects all records for the entity.

Parameters
p_code   Discriminator Code. VARCHAR2(30) Required Key

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


f_query_one

FUNCTION f_query_one(p_code gobsddc.gobsddc_code%TYPE)
  RETURN sde_discriminator_ref

Selects one record using key.

Parameters
p_code   Discriminator Code. VARCHAR2(30) 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 sde_discriminator_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_code  gobsddc.gobsddc_code%TYPE,
                          p_rowid gb_common.internal_record_id_type DEFAULT NULL)
  RETURN sde_discriminator_ref

Selects one record and locks it.

Parameters
p_code   Discriminator Code. VARCHAR2(30) 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_code        gobsddc.gobsddc_code%TYPE,
                   p_desc        gobsddc.gobsddc_desc%TYPE,
                   p_method      gobsddc.gobsddc_method%TYPE,
                   p_user_id     gobsddc.gobsddc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_validation  gobsddc.gobsddc_validation%TYPE DEFAULT NULL,
                   p_data_origin gobsddc.gobsddc_data_origin%TYPE DEFAULT NULL,
                   /* 80-2 p_create_source             gobsddc.gobsddc_create_source%TYPE DEFAULT NULL, */
                   p_rowid_out OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_code   Discriminator Code. VARCHAR2(30) Required Key
p_desc   Description for the discriminator. VARCHAR2(192) Required
p_method   This field indicates how to discriminate.I for Index, S for Select Statement, U for user defined in table GORSDDV. VARCHAR2(3) Required
p_user_id   The unique identification of the user. VARCHAR2(90) Required
p_validation   Select statement to build a list of values or the maximum Index. VARCHAR2(3072)
p_data_origin   Source system that created or updated the row. VARCHAR2(90)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required


p_delete

PROCEDURE p_delete(p_code  gobsddc.gobsddc_code%TYPE,
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_code   Discriminator Code. VARCHAR2(30) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)


p_lock

PROCEDURE p_lock(p_code        gobsddc.gobsddc_code%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_code   Discriminator Code. VARCHAR2(30) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required


p_update

PROCEDURE p_update(p_code        gobsddc.gobsddc_code%TYPE,
                   p_desc        gobsddc.gobsddc_desc%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_method      gobsddc.gobsddc_method%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id     gobsddc.gobsddc_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_validation  gobsddc.gobsddc_validation%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin gobsddc.gobsddc_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   /* 80-2 p_create_source             gobsddc.gobsddc_create_source%TYPE DEFAULT dml_common.f_unspecified_string, */
                   p_rowid gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_code   Discriminator Code. VARCHAR2(30) Required Key
p_desc   Description for the discriminator. VARCHAR2(192) Required
p_method   This field indicates how to discriminate.I for Index, S for Select Statement, U for user defined in table GORSDDV. VARCHAR2(3) Required
p_user_id   The unique identification of the user. VARCHAR2(90) Required
p_validation   Select statement to build a list of values or the maximum Index. VARCHAR2(3072)
p_data_origin   Source system that created or updated the row. VARCHAR2(90)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)