Package gb_sde

Package gb_sde_metadata

Common Business interface for the SDE_METADATA API (gb_sde_metadata).

Program units

f_api_version	Returns the API version number.
f_exists	80-3
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.
p_validate_sddc_change

Types

sde_metadata_rec	Business Entity record type
sde_metadata_ref	Entity cursor variable type
sde_metadata_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(12) := 'SDE_METADATA';

Business Entity Name

M_BASE_TABLE_NAME

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

Base table name

sde_metadata_rec

TYPE sde_metadata_rec IS RECORD (
  r_table_name              gorsdam.gorsdam_table_name%TYPE,
  r_attr_name               gorsdam.gorsdam_attr_name%TYPE,
  r_attr_type               gorsdam.gorsdam_attr_type%TYPE,
  r_attr_order              gorsdam.gorsdam_attr_order%TYPE,
  r_attr_reqd_ind           gorsdam.gorsdam_attr_reqd_ind%TYPE,
  r_attr_data_type          gorsdam.gorsdam_attr_data_type%TYPE,
  r_attr_prompt             gorsdam.gorsdam_attr_prompt%TYPE,
  r_user_id                 gorsdam.gorsdam_user_id%TYPE,
  r_attr_data_len           gorsdam.gorsdam_attr_data_len%TYPE,
  r_attr_data_scale         gorsdam.gorsdam_attr_data_scale%TYPE,
  r_attr_info               gorsdam.gorsdam_attr_info%TYPE,
  r_attr_base_col           gorsdam.gorsdam_attr_base_col%TYPE,
  r_sddc_code               gorsdam.gorsdam_sddc_code%TYPE,
  r_data_origin             gorsdam.gorsdam_data_origin%TYPE,
                                                                          
  r_lov_form                gorsdam.gorsdam_lov_form%TYPE,
  r_lov_table_ovrd          gorsdam.gorsdam_lov_table_ovrd%TYPE,
  r_lov_attr_ovrd           gorsdam.gorsdam_lov_attr_ovrd%TYPE,
  r_lov_code_title          gorsdam.gorsdam_lov_code_title%TYPE,
  r_lov_desc_title          gorsdam.gorsdam_lov_desc_title%TYPE,
  r_lov_low_range           gorsdam.gorsdam_lov_low_range%TYPE,
  r_lov_high_range          gorsdam.gorsdam_lov_high_range%TYPE,
  r_lov_low_sysdate_ind     gorsdam.gorsdam_lov_low_sysdate_ind%TYPE,
  r_lov_high_sysdate_ind    gorsdam.gorsdam_lov_high_sysdate_ind%TYPE,
  r_gjapdef_validation      gorsdam.gorsdam_gjapdef_validation%TYPE,
  r_sql_sqpr_code           gorsdam.gorsdam_sql_sqpr_code%TYPE,
  r_sql_sqru_code           gorsdam.gorsdam_sql_sqru_code%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

sde_metadata_ref

TYPE sde_metadata_ref IS REF CURSOR RETURN sde_metadata_rec;

Entity cursor variable type

sde_metadata_tab

TYPE sde_metadata_tab IS TABLE OF sde_metadata_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_table_name gorsdam.gorsdam_table_name%TYPE,
                  p_attr_name  gorsdam.gorsdam_attr_name%TYPE DEFAULT NULL,
                  p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

80-3

f_isequal

FUNCTION f_isequal(rec_one sde_metadata_rec,
                   rec_two sde_metadata_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_metadata_rec Required
	rec_two	The second record to compare. Type sde_metadata_rec Required

Returns

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

f_query_all

FUNCTION f_query_all(p_table_name gorsdam.gorsdam_table_name%TYPE,
                     p_attr_name  gorsdam.gorsdam_attr_name%TYPE)
  RETURN sde_metadata_ref

Selects all records for the entity.

Parameters

	p_table_name	Name of the table supplemented by the attribute. VARCHAR2(90) Required Key
	p_attr_name	Name of the attribute. VARCHAR2(90) Required Key

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_table_name gorsdam.gorsdam_table_name%TYPE,
                     p_attr_name  gorsdam.gorsdam_attr_name%TYPE)
  RETURN sde_metadata_ref

Selects one record using key.

Parameters

	p_table_name	Name of the table supplemented by the attribute. VARCHAR2(90) Required Key
	p_attr_name	Name of the attribute. VARCHAR2(90) 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_metadata_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_table_name gorsdam.gorsdam_table_name%TYPE,
                          p_attr_name  gorsdam.gorsdam_attr_name%TYPE,
                          p_rowid      gb_common.internal_record_id_type DEFAULT NULL)
  RETURN sde_metadata_ref

Selects one record and locks it.

Parameters

	p_table_name	Name of the table supplemented by the attribute. VARCHAR2(90) Required Key
	p_attr_name	Name of the attribute. VARCHAR2(90) 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_table_name      gorsdam.gorsdam_table_name%TYPE,
                   p_attr_name       gorsdam.gorsdam_attr_name%TYPE,
                   p_attr_type       gorsdam.gorsdam_attr_type%TYPE,
                   p_attr_order      gorsdam.gorsdam_attr_order%TYPE,
                   p_attr_reqd_ind   gorsdam.gorsdam_attr_reqd_ind%TYPE,
                   p_attr_data_type  gorsdam.gorsdam_attr_data_type%TYPE,
                   p_attr_prompt     gorsdam.gorsdam_attr_prompt%TYPE,
                   p_user_id         gorsdam.gorsdam_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_attr_data_len   gorsdam.gorsdam_attr_data_len%TYPE DEFAULT NULL,
                   p_attr_data_scale gorsdam.gorsdam_attr_data_scale%TYPE DEFAULT NULL,
                   p_attr_info       gorsdam.gorsdam_attr_info%TYPE DEFAULT NULL,
                   p_attr_base_col   gorsdam.gorsdam_attr_base_col%TYPE DEFAULT NULL,
                   p_sddc_code       gorsdam.gorsdam_sddc_code%TYPE DEFAULT NULL,
                   p_data_origin     gorsdam.gorsdam_data_origin%TYPE DEFAULT NULL,
                   /* 80-2 p_create_source             gorsdam.gorsdam_create_source%TYPE DEFAULT NULL, */
                   p_lov_form               gorsdam.gorsdam_lov_form%TYPE DEFAULT NULL,
                   p_lov_table_ovrd         gorsdam.gorsdam_lov_table_ovrd%TYPE DEFAULT NULL,
                   p_lov_attr_ovrd          gorsdam.gorsdam_lov_attr_ovrd%TYPE DEFAULT NULL,
                   p_lov_code_title         gorsdam.gorsdam_lov_code_title%TYPE DEFAULT NULL,
                   p_lov_desc_title         gorsdam.gorsdam_lov_desc_title%TYPE DEFAULT NULL,
                   p_lov_low_range_as_char  VARCHAR2 DEFAULT NULL,
                   p_lov_high_range_as_char VARCHAR2 DEFAULT NULL,
                   p_lov_low_sysdate_ind    gorsdam.gorsdam_lov_low_sysdate_ind%TYPE DEFAULT NULL,
                   p_lov_high_sysdate_ind   gorsdam.gorsdam_lov_high_sysdate_ind%TYPE DEFAULT NULL,
                   p_gjapdef_validation     gorsdam.gorsdam_gjapdef_validation%TYPE DEFAULT NULL,
                   p_sql_sqpr_code          gorsdam.gorsdam_sql_sqpr_code%TYPE DEFAULT NULL,
                   p_sql_sqru_code          gorsdam.gorsdam_sql_sqru_code%TYPE DEFAULT NULL,
                   p_rowid_out              OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_table_name	Name of the table supplemented by the attribute. VARCHAR2(90) Required Key
	p_attr_name	Name of the attribute. VARCHAR2(90) Required Key
	p_attr_type	Type of the attribute; A(dd) to table, S(ubstitutes) field. VARCHAR2(3) Required
	p_attr_order	Default display order of the attribute. NUMBER(3) Required
	p_attr_reqd_ind	This field indicates if the Attribute is required (Y/N). VARCHAR2(3) Required
	p_attr_data_type	Data type of the field. VARCHAR2(90) Required
	p_attr_prompt	Default prompt or label for the user interface. VARCHAR2(150) Required
	p_user_id	The unique identification of the user. VARCHAR2(90) Required
	p_attr_data_len	Maximum length of the attribute data. NUMBER(8)
	p_attr_data_scale	Scale for number type attributes. NUMBER(2)
	p_attr_info	Default hint or information text for the user interface. VARCHAR2(3072)
	p_attr_base_col	Base table field substituted by this attribute. VARCHAR2(90)
	p_sddc_code	Discriminator associated with this Attribute. VARCHAR2(30)
	p_data_origin	Source system that created or updated the row. VARCHAR2(90)
	p_lov_form	Indicates an existing LOV form (similar to List on GJAPDEF) which would pass back a specific value just as it does on GJAPCTL. If it is equal to GTQSDLV then the SDE LOV table will be used. VARCHAR2(30)
	p_lov_table_ovrd	Used to override the table name if using the GTQSDLV in the LOV form. The value of DEFAULT can be used to define "generic" validations. VARCHAR2(30)
	p_lov_attr_ovrd	Used to override the attribute name if using the GTQSDLV in the LOV form. VARCHAR2(30)
	p_lov_code_title	Used as an override for "Code" for the title of the Value field on GTQSDLV. VARCHAR2(255)
	p_lov_desc_title	Used as an override for "Description" for the description of the Value field on GTQSDLV. VARCHAR2(255)
	p_lov_low_range_as_char	The low value (as a character string) of a range of values used for validation. VARCHAR2(30)
	p_lov_high_range_as_char	The high value (as a character string) of a range of values used for validation. VARCHAR2(30)
	p_lov_low_sysdate_ind	An indicator used to specify that the low range for a DATE is SYSDATE. VARCHAR2(01)
	p_lov_high_sysdate_ind	An indicator used to specify that the high range for a DATE is SYSDATE. VARCHAR2(01)
	p_gjapdef_validation	The validation routine (similar to GJAPDEF Validation) used in the same way that GJAPCTL validates values. These routines are all 'hard coded' and will work the exact way that they work on GJAPCTL. VARCHAR2(30)
	p_sql_sqpr_code	Process code from GORRSQL used to define the SQL validation routine. VARCHAR2(30)
	p_sql_sqru_code	Rule code from GORRSQL used to define the SQL validation routine. VARCHAR2(30)
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete

PROCEDURE p_delete(p_table_name gorsdam.gorsdam_table_name%TYPE,
                   p_attr_name  gorsdam.gorsdam_attr_name%TYPE,
                   p_rowid      gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters

	p_table_name	Name of the table supplemented by the attribute. VARCHAR2(90) Required Key
	p_attr_name	Name of the attribute. VARCHAR2(90) Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock

PROCEDURE p_lock(p_table_name  gorsdam.gorsdam_table_name%TYPE,
                 p_attr_name   gorsdam.gorsdam_attr_name%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_table_name	Name of the table supplemented by the attribute. VARCHAR2(90) Required Key
	p_attr_name	Name of the attribute. VARCHAR2(90) Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update

PROCEDURE p_update(p_table_name      gorsdam.gorsdam_table_name%TYPE,
                   p_attr_name       gorsdam.gorsdam_attr_name%TYPE,
                   p_attr_type       gorsdam.gorsdam_attr_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_order      gorsdam.gorsdam_attr_order%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_attr_reqd_ind   gorsdam.gorsdam_attr_reqd_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_data_type  gorsdam.gorsdam_attr_data_type%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_prompt     gorsdam.gorsdam_attr_prompt%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         gorsdam.gorsdam_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_attr_data_len   gorsdam.gorsdam_attr_data_len%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_attr_data_scale gorsdam.gorsdam_attr_data_scale%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_attr_info       gorsdam.gorsdam_attr_info%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_attr_base_col   gorsdam.gorsdam_attr_base_col%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sddc_code       gorsdam.gorsdam_sddc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin     gorsdam.gorsdam_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   /* 80-2 p_create_source             gorsdam.gorsdam_create_source%TYPE DEFAULT dml_common.f_unspecified_string, */
                   p_lov_form               gorsdam.gorsdam_lov_form%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lov_table_ovrd         gorsdam.gorsdam_lov_table_ovrd%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lov_attr_ovrd          gorsdam.gorsdam_lov_attr_ovrd%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lov_code_title         gorsdam.gorsdam_lov_code_title%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lov_desc_title         gorsdam.gorsdam_lov_desc_title%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lov_low_range_as_char  VARCHAR2 DEFAULT dml_common.f_unspecified_string,
                   p_lov_high_range_as_char VARCHAR2 DEFAULT dml_common.f_unspecified_string,
                   p_lov_low_sysdate_ind    gorsdam.gorsdam_lov_low_sysdate_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_lov_high_sysdate_ind   gorsdam.gorsdam_lov_high_sysdate_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_gjapdef_validation     gorsdam.gorsdam_gjapdef_validation%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sql_sqpr_code          gorsdam.gorsdam_sql_sqpr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_sql_sqru_code          gorsdam.gorsdam_sql_sqru_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid                  gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters

	p_table_name	Name of the table supplemented by the attribute. VARCHAR2(90) Required Key
	p_attr_name	Name of the attribute. VARCHAR2(90) Required Key
	p_attr_type	Type of the attribute; A(dd) to table, S(ubstitutes) field. VARCHAR2(3) Required
	p_attr_order	Default display order of the attribute. NUMBER(3) Required
	p_attr_reqd_ind	This field indicates if the Attribute is required (Y/N). VARCHAR2(3) Required
	p_attr_data_type	Data type of the field. VARCHAR2(90) Required
	p_attr_prompt	Default prompt or label for the user interface. VARCHAR2(150) Required
	p_user_id	The unique identification of the user. VARCHAR2(90) Required
	p_attr_data_len	Maximum length of the attribute data. NUMBER(8)
	p_attr_data_scale	Scale for number type attributes. NUMBER(2)
	p_attr_info	Default hint or information text for the user interface. VARCHAR2(3072)
	p_attr_base_col	Base table field substituted by this attribute. VARCHAR2(90)
	p_sddc_code	Discriminator associated with this Attribute. VARCHAR2(30)
	p_data_origin	Source system that created or updated the row. VARCHAR2(90)
	p_lov_form	Indicates an existing LOV form (similar to List on GJAPDEF) which would pass back a specific value just as it does on GJAPCTL. If it is equal to GTQSDLV then the SDE LOV table will be used. VARCHAR2(30)
	p_lov_table_ovrd	Used to override the table name if using the GTQSDLV in the LOV form. The value of DEFAULT can be used to define "generic" validations. VARCHAR2(30)
	p_lov_attr_ovrd	Used to override the attribute name if using the GTQSDLV in the LOV form. VARCHAR2(30)
	p_lov_code_title	Used as an override for "Code" for the title of the Value field on GTQSDLV. VARCHAR2(255)
	p_lov_desc_title	Used as an override for "Description" for the description of the Value field on GTQSDLV. VARCHAR2(255)
	p_lov_low_range_as_char	The low value (as a character string) of a range of values used for validation. VARCHAR2(30)
	p_lov_high_range_as_char	The high value (as a character string) of a range of values used for validation. VARCHAR2(30)
	p_lov_low_sysdate_ind	An indicator used to specify that the low range for a DATE is SYSDATE. VARCHAR2(01)
	p_lov_high_sysdate_ind	An indicator used to specify that the high range for a DATE is SYSDATE. VARCHAR2(01)
	p_gjapdef_validation	The validation routine (similar to GJAPDEF Validation) used in the same way that GJAPCTL validates values. These routines are all 'hard coded' and will work the exact way that they work on GJAPCTL. VARCHAR2(30)
	p_sql_sqpr_code	Process code from GORRSQL used to define the SQL validation routine. VARCHAR2(30)
	p_sql_sqru_code	Rule code from GORRSQL used to define the SQL validation routine. VARCHAR2(30)
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18)

p_validate_sddc_change

PROCEDURE p_validate_sddc_change(p_table_name    gorsdam.gorsdam_table_name%TYPE,
                                 p_attr_name     gorsdam.gorsdam_attr_name%TYPE,
                                 p_old_sddc_code gorsdam.gorsdam_sddc_code%TYPE,
                                 p_new_sddc_code gorsdam.gorsdam_sddc_code%TYPE)