OMBRETRIEVE DATA_RULE

Purpose

Retrieve data rule details such as the data rule type.

Prerequisites

The current context of scripting must be a data rule module.

Syntax

retrieveDataRuleCommand =  OMBRETRIEVE DATA_RULE "QUOTED_STRING" 
          "retrieveDataRuleClause"
     retrieveDataRuleClause =  GET ( "getPropertiesClause" | 
          "getReferenceIconSetClause" | "getGroupsClause" | 
          "getDomainValuesClause" ) | GROUP "retrieveGroupClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getGroupsClause =  GROUPS
     getDomainValuesClause =  DOMAIN_VALUES
     retrieveGroupClause =  "QUOTED_STRING" ( GET ( "getGroupPropertiesClause" |
           "getAttributesClause" ) | "retrieveAttributeClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     getGroupPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getAttributesClause =  ATTRIBUTES
     retrieveAttributeClause =  ATTRIBUTE "QUOTED_STRING" 
          "getAttributePropertiesClause"
     getAttributePropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"

Parameters

retrieveDataRuleCommand

Retreive a data rule

QUOTED_STRING

Data rule name.

retrieveDataRuleClause

Gets the groups, domain values or properties of a data rule.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Properties of Data Rule are:

Basic properties for DATA_RULE:

Name: DATA_NAME

Type: STRING(200)

Valid Values: Any valid character string in supported character set.

Default: Empty string

Business name of the Data Rule

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: Any valid character string in supported character set.

Default: Empty string

Description of the Data Rule

Name: RULE_TYPE

Type: STRING

Valid Values: ATTR_VALUE_RULE

DOMAIN_NO_NULL_RULE

DOMAIN_LIST_RULE

DOMAIN_PATTERN_LIST_RULE

DOMAIN_RANGE_RULE

DOMAIN_FORMAT_TELEPHONE_RULE

DOMAIN_FORMAT_IP_RULE

DOMAIN_FORMAT_SSN_RULE

DOMAIN_FORMAT_DATE_RULE

DOMAIN_FORMAT_NUMBER_RULE

DOMAIN_FORMAT_URL_RULE

DOMAIN_FORMAT_EMAIL_RULE

FUNCTIONAL_DEP_RULE

SET_RULE

IDENTITY_RULE

REFERENCE_RULE

Default: ATTR_VALUE_RULE

Data Rule type

Name: ATTR_VALUE_CLAUSE

Type: STRING(4000)

Valid Values: Any valid character string in supported character set.

Default: Empty string

Expression used in the ATTR_VALUE_RULE

Name: LOCAL_MIN_COUNT

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 1

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: LOCAL_MAX_COUNT

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: n

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: REMOTE_MIN_COUNT

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 0

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: REMOTE_MAX_COUNT

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 'n'

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: MAX_VALUE

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: Empty string

Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not used. For instance, the rule: attr >= 10 would have a max value and no min_value.

Name: MIN_VALUE

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: Empty string

Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not used. For instance, the rule: attr >= 10 would have a max value and no min_value.

Name: IGNORE_NULLS

Type: BOOLEAN

Valid Values: Any valid character string in supported character set.

Default: false

Used in identity and reference rules. If set, then records containing null values will not evaluated.

Properties of Data Rule Attribute are:

Name: DATATYPE

Type: STRING

Valid Values: DATE, NUMBER, VARCHAR2

Default: NUMBER

Set the data type for Parameter. Should be set for attributes on ATTR_VALUE and DOMAIN_RANGE rules

getReferenceIconSetClause

Retrieve the icon set referenced by the data rule.

getGroupsClause

Retrieves all the groups of a data rule.

getDomainValuesClause

Retreives all the domain values.

retrieveGroupClause

Retrieve a data rule group.

QUOTED_STRING

Group name.

propertyNameList

Comma separated list of property names. Property names are unquoted.

getGroupPropertiesClause

This clause retrieves all the properties of the data rule group.

getAttributesClause

Retrieves all the attributes of a data rule group.

retrieveAttributeClause

Retrieve a data rule group attribute.

QUOTED_STRING

Attribute name.

getAttributePropertiesClause

This clause retrieves all the properties of the data rule group attribute.

DATA_RULE Object

Table 18-10 DATA_RULE Object

Property Type Choices Min Max Default Description

ATTR_VALUE_CLAUSE

STRING

none

none

none

empty string

Description not available.

DIAGRAM_LAYOUT

STRING

none

none

none

empty string

  

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

Description not available.

FUNCTIONAL_DEP_THRESHOLD

NUMBER

none

none

none

0

Description not available.

IGNORE_NULLS

BOOLEAN

true, false

none

none

false

Description not available.

LOCAL_MAX_COUNT

STRING

none

none

none

n

Description not available.

LOCAL_MIN_COUNT

STRING

none

none

none

1

Description not available.

MAX_VALUE

STRING

none

none

none

empty string

Description not available.

MIN_VALUE

STRING

none

none

none

empty string

Description not available.

NAMEADDR_PASS_CONDITION

STRING

PASS_PARSED, PASS_POSTALMATCHED_AVAIL

none

none

PASS_PARSED

Description not available.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Description not available.

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Description not available.

REMOTE_MAX_COUNT

STRING

none

none

none

n

Description not available.

REMOTE_MIN_COUNT

STRING

none

none

none

empty string

Description not available.

RULE_TYPE

STRING

, ATTR_VALUE_RULE, DOMAIN_FORMAT_DATE_RULE, DOMAIN_FORMAT_EMAIL_RULE, DOMAIN_FORMAT_IP_RULE, DOMAIN_FORMAT_NUMBER_RULE, DOMAIN_FORMAT_SSN_RULE, DOMAIN_FORMAT_TELEPHONE_RULE, DOMAIN_FORMAT_URL_RULE, DOMAIN_LIST_RULE, DOMAIN_NO_NULL_RULE, DOMAIN_PATTERN_LIST_RULE, DOMAIN_RANGE_RULE, FUNCTIONAL_DEP_RULE, IDENTITY_RULE, NAMEADDRESS_RULE, REFERENCE_RULE, SET_RULE

none

none

empty string

Description not available.

See Also

OMBRETRIEVE