public interface SchemaFacet
Modifier and Type | Method and Description |
---|---|
String |
getDocumentation(Locale aLocale,
ValueContext aContext)
Returns the end-user documentation for this facet.
|
SchemaFacetValidationMessage |
getFacetValidationMessage()
Returns the validation message defined in the data model.
|
SchemaNode |
getSchemaNode()
Returns the node associated to 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 |
isFacetOnMandatoryField()
Returns
true if this facet is
related to a mandatory field (defines both minOccurs="1" |
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. |
SchemaNode getSchemaNode()
String getDocumentation(Locale aLocale, ValueContext aContext)
null
on programmatic extended facets
if it is called during the compilation of the associated data model.IllegalArgumentException
- if an argument is null
.Constraint.toUserDocumentation(Locale, ValueContext)
boolean isFacetOnMandatoryField()
true
if this facet is
related to a mandatory field (defines both minOccurs="1"
maxOccurs="1").
SchemaFacetOnMandatoryField
boolean isFacetLength()
true
if this facet is a length
facet.SchemaFacetLength
boolean isFacetMinLength()
true
if this facet is a minLength
facet.SchemaFacetMinLength
boolean isFacetMaxLength()
true
if this facet is a maxLength
facet.SchemaFacetMaxLength
boolean isFacetPattern()
true
if this facet is a pattern
facet.SchemaFacetPattern
boolean isFacetOResource()
true
if this facet is a resource
constraint.SchemaFacetOResource
boolean isEnumerationList()
true
if this facet defines an enumeration of
possible values.
This is the case for the following facets:
foreign key
constraint;xs:enumeration
;osd:enumeration
;enumeration constraint
.SchemaFacetEnumeration
boolean isEnumerationNomenclature()
true
if this facet defines a nomenclature.
This is the case for the following facets:
osd:nomenclature
(deprecated);osd:FacetOResource
;osd:nomenclature
(deprecated);nomenclature constraint
(deprecated).SchemaFacetEnumeration
boolean isFacetEnumeration()
true
if this facet defines either an
enumeration
or a nomenclature
.boolean isEnumerationTableRef()
true
if this facet is a
foreign key constraint (osd:tableRef
).SchemaFacetTableRef
boolean isFacetBoundaryMaxInclusive()
true
if this facet is a
maxInclusive
facet.SchemaFacetBoundaryMaxInclusive
boolean isFacetBoundaryMaxExclusive()
true
if this facet is a
maxExclusive
facet.SchemaFacetBoundaryMaxExclusive
boolean isFacetBoundaryMinExclusive()
true
if this facet is a
minExclusive
facet.SchemaFacetBoundaryMinExclusive
boolean isFacetBoundaryMinInclusive()
true
if this facet is a
minInclusive
facet.SchemaFacetBoundaryMinInclusive
boolean isFacetTotalDigits()
true
if this facet is a
totalDigits
facet.SchemaFacetTotalDigits
boolean isFacetFractionDigits()
true
if this facet is a
fractionDigits
facet.SchemaFacetFractionDigits
boolean isFacetExcludeValue()
true
if this facet is an
excludeValue
facet.SchemaFacetExcludeValue
boolean isFacetExcludeSegment()
true
if this facet is an
excludeSegment
facet.SchemaFacetExcludeSegment
SchemaFacetValidationPolicy getValidationPolicy()
osd:validation
.SchemaFacetValidationPolicy
SchemaFacetValidationMessage getFacetValidationMessage()
osd:validation
,
osd:enumerationValidation
or osd:mandatoryErrorMessage
.SchemaFacetValidationMessage