Interface IFieldInstance
-
- All Superinterfaces:
IField
,IInstance
,IModelElement
,IModelInstance
,INamedInstance
,INamedModelElement
,INamedModelInstance
- All Known Implementing Classes:
AbstractFieldInstance
public interface IFieldInstance extends INamedModelInstance, IField
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description IFieldDefinition
getDefinition()
Retrieve the definition of this instance.default String
getGroupAsXmlNamespace()
Retrieve the XML namespace for this group.default String
getXmlNamespace()
Retrieve the XML namespace for this instance.default QName
getXmlQName()
Get the XML qualified name to use in XML.boolean
isInXmlWrapped()
Determines if the field is configured to have a wrapper in XML.-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.IField
getModelType
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.IInstance
getContainingModule
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelElement
getRemarks
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelInstance
getContainingDefinition, getGroupAsName, getJsonGroupAsBehavior, getMaxOccurs, getMinOccurs, getParentContainer, getXmlGroupAsBehavior, getXmlGroupAsQName
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedInstance
getEffectiveDescription, getEffectiveFormalName, getEffectiveName, getValue, toCoordinates
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelElement
getDescription, getFormalName, getName, getProperties, getPropertyValues, getUseName, hasProperty, hasPropertyValue
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelInstance
getItemValues, getJsonName
-
-
-
-
Method Detail
-
getXmlNamespace
default String getXmlNamespace()
Description copied from interface:INamedInstance
Retrieve the XML namespace for this instance.- Specified by:
getXmlNamespace
in interfaceINamedInstance
- Returns:
- the XML namespace or
null
if no namespace is defined
-
getXmlQName
default QName getXmlQName()
Description copied from interface:INamedInstance
Get the XML qualified name to use in XML.- Specified by:
getXmlQName
in interfaceINamedInstance
- Returns:
- the XML qualified name, or
null
if there isn't one
-
getGroupAsXmlNamespace
default String getGroupAsXmlNamespace()
Description copied from interface:IModelInstance
Retrieve the XML namespace for this group.- Specified by:
getGroupAsXmlNamespace
in interfaceIModelInstance
- Returns:
- the XML namespace or
null
if no namespace is used
-
getDefinition
IFieldDefinition getDefinition()
Description copied from interface:INamedInstance
Retrieve the definition of this instance.- Specified by:
getDefinition
in interfaceINamedInstance
- Specified by:
getDefinition
in interfaceINamedModelInstance
- Returns:
- the corresponding definition
-
isInXmlWrapped
boolean isInXmlWrapped()
Determines if the field is configured to have a wrapper in XML.- Returns:
true
if an XML wrapper is required, orfalse
otherwise
-
-