SchemaFacet (TIBCO EBX® Version 5.9.27 Java API)

All Known Subinterfaces:

SchemaFacetBoundary, SchemaFacetBoundaryMaxExclusive, SchemaFacetBoundaryMaxInclusive, SchemaFacetBoundaryMinExclusive, SchemaFacetBoundaryMinInclusive, SchemaFacetEnumeration, SchemaFacetExcludeSegment, SchemaFacetExcludeValue, SchemaFacetFractionDigits, SchemaFacetLength, SchemaFacetMaxLength, SchemaFacetMinLength, SchemaFacetOnLength, SchemaFacetPattern, SchemaFacetTableRef, SchemaFacetTotalDigits
```
public interface SchemaFacet
```
Common interface for facets.

See Also:

XML Schema, W3C Recommendation, dynamic constraints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getDocumentation(Locale aLocale, ValueContext aContext)` Returns the end-user documentation for this facet.
`SchemaFacetValidationPolicy`	`getValidationPolicy()` Returns the validation policy of this facet.
`boolean`	`isEnumerationList()` Returns `true` if this facet defines an enumeration of possible values.
`boolean`	`isEnumerationNomenclature()` Returns `true` if this facet defines a nomenclature.
`boolean`	`isEnumerationTableRef()` Returns `true` if this facet is a foreign key constraint (`osd:tableRef`).
`boolean`	`isFacetBoundaryMaxExclusive()` Returns `true` if this facet is a `maxExclusive` facet.
`boolean`	`isFacetBoundaryMaxInclusive()` Returns `true` if this facet is a `maxInclusive` facet.
`boolean`	`isFacetBoundaryMinExclusive()` Returns `true` if this facet is a `minExclusive` facet.
`boolean`	`isFacetBoundaryMinInclusive()` Returns `true` if this facet is a `minInclusive` facet.
`boolean`	`isFacetEnumeration()` Returns `true` if this facet defines either an `enumeration` or a `nomenclature`.
`boolean`	`isFacetExcludeSegment()` Returns `true` if this facet is an `excludeSegment` facet.
`boolean`	`isFacetExcludeValue()` Returns `true` if this facet is an `excludeValue` facet.
`boolean`	`isFacetFractionDigits()` Returns `true` if this facet is a `fractionDigits` facet.
`boolean`	`isFacetLength()` Returns `true` if this facet is a `length` facet.
`boolean`	`isFacetMaxLength()` Returns `true` if this facet is a `maxLength` facet.
`boolean`	`isFacetMinLength()` Returns `true` if this facet is a `minLength` facet.
`boolean`	`isFacetOResource()` Returns `true` if this facet is a `resource` constraint.
`boolean`	`isFacetPattern()` Returns `true` if this facet is a `pattern` facet.
`boolean`	`isFacetTotalDigits()` Returns `true` if this facet is a `totalDigits` facet.

- Method Detail
  - getDocumentation
```
String getDocumentation(Locale aLocale,
                        ValueContext aContext)
```
    Returns the end-user documentation for this facet. This method can return null on programmatic extended facets if it is called during the compilation of the associated data model.
    
    Throws:
    
    IllegalArgumentException - if an argument is null.
    
    See Also:
    
    Constraint.toUserDocumentation(Locale, ValueContext)
  - isFacetLength
```
boolean isFacetLength()
```
    Returns true if this facet is a length facet.
    
    See Also:
    
    SchemaFacetLength
  - isFacetMinLength
```
boolean isFacetMinLength()
```
    Returns true if this facet is a minLength facet.
    
    See Also:
    
    SchemaFacetMinLength
  - isFacetMaxLength
```
boolean isFacetMaxLength()
```
    Returns true if this facet is a maxLength facet.
    
    See Also:
    
    SchemaFacetMaxLength
  - isFacetPattern
```
boolean isFacetPattern()
```
    Returns true if this facet is a pattern facet.
    
    See Also:
    
    SchemaFacetPattern
  - isFacetOResource
```
boolean isFacetOResource()
```
    Returns true if this facet is a resource constraint.
    
    See Also:
    
    SchemaFacetOResource
  - isEnumerationList
```
boolean isEnumerationList()
```
    Returns true if this facet defines an enumeration of possible values. This is the case for the following facets:
    - a foreign key constraint;
    - a static enumeration defined with the standard XML Schema facet xs:enumeration;
    - a dynamic enumeration defined with the extended facet osd:enumeration;
    - a programmatic enumeration constraint.
    See Also:
    
    SchemaFacetEnumeration
  - isEnumerationNomenclature
```
boolean isEnumerationNomenclature()
```
    Returns true if this facet defines a nomenclature. This is the case for the following facets:
    - a static nomenclature defined with the extended facet osd:nomenclature (deprecated);
    - a resource facet, osd:FacetOResource;
    - a dynamic nomenclature defined with the extended facet osd:nomenclature (deprecated);
    - a programmatic nomenclature constraint (deprecated).
    See Also:
    
    SchemaFacetEnumeration
  - isFacetEnumeration
```
boolean isFacetEnumeration()
```
    Returns true if this facet defines either an enumeration or a nomenclature.
    
    See Also:
    
    isEnumerationList(), isEnumerationNomenclature(), SchemaFacetEnumeration
  - isEnumerationTableRef
```
boolean isEnumerationTableRef()
```
    Returns true if this facet is a foreign key constraint (osd:tableRef).
    
    See Also:
    
    SchemaFacetTableRef
  - isFacetBoundaryMaxInclusive
```
boolean isFacetBoundaryMaxInclusive()
```
    Returns true if this facet is a maxInclusive facet.
    
    See Also:
    
    SchemaFacetBoundaryMaxInclusive
  - isFacetBoundaryMaxExclusive
```
boolean isFacetBoundaryMaxExclusive()
```
    Returns true if this facet is a maxExclusive facet.
    
    See Also:
    
    SchemaFacetBoundaryMaxExclusive
  - isFacetBoundaryMinExclusive
```
boolean isFacetBoundaryMinExclusive()
```
    Returns true if this facet is a minExclusive facet.
    
    See Also:
    
    SchemaFacetBoundaryMinExclusive
  - isFacetBoundaryMinInclusive
```
boolean isFacetBoundaryMinInclusive()
```
    Returns true if this facet is a minInclusive facet.
    
    See Also:
    
    SchemaFacetBoundaryMinInclusive
  - isFacetTotalDigits
```
boolean isFacetTotalDigits()
```
    Returns true if this facet is a totalDigits facet.
    
    See Also:
    
    SchemaFacetTotalDigits
  - isFacetFractionDigits
```
boolean isFacetFractionDigits()
```
    Returns true if this facet is a fractionDigits facet.
    
    See Also:
    
    SchemaFacetFractionDigits
  - isFacetExcludeValue
```
boolean isFacetExcludeValue()
```
    Returns true if this facet is an excludeValue facet.
    
    See Also:
    
    SchemaFacetExcludeValue
  - isFacetExcludeSegment
```
boolean isFacetExcludeSegment()
```
    Returns true if this facet is an excludeSegment facet.
    
    See Also:
    
    SchemaFacetExcludeSegment
  - getValidationPolicy
```
SchemaFacetValidationPolicy getValidationPolicy()
```
    Returns the validation policy of this facet. Validation policy properties are defined under the element osd:validation.
    
    Since:
    
    5.8.1
    
    See Also:
    
    SchemaFacetValidationPolicy

TIBCO EBX® Version 5.9.27. Copyright 2001-2025. Cloud Software Group, Inc. All rights reserved.

All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Interface SchemaFacet

Method Summary

Method Detail

getDocumentation

isFacetLength

isFacetMinLength

isFacetMaxLength

isFacetPattern

isFacetOResource

isEnumerationList

isEnumerationNomenclature

isFacetEnumeration

isEnumerationTableRef

isFacetBoundaryMaxInclusive

isFacetBoundaryMaxExclusive

isFacetBoundaryMinExclusive

isFacetBoundaryMinInclusive

isFacetTotalDigits

isFacetFractionDigits

isFacetExcludeValue

isFacetExcludeSegment

getValidationPolicy