Interface IDefinition
-
- All Superinterfaces:
IConstrained
,gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained
,IModelElement
,INamedModelElement
,IValueConstrained
- All Known Subinterfaces:
IAssemblyDefinition
,IFeatureFlagContainer<F>
,IFeatureInlinedDefinition<INSTANCE>
,IFieldDefinition
,IFlagContainer
,IFlagDefinition
,IValuedDefinition
public interface IDefinition extends INamedModelElement, gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained
-
-
Field Summary
Fields Modifier and Type Field Description static ModuleScopeEnum
DEFAULT_DEFINITION_MODEL_SCOPE
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description INamedInstance
getInlineInstance()
IfisInline()
istrue
, return the instance the definition is inlined for.ModuleScopeEnum
getModuleScope()
Retrieve the definition's scope within the context of its defining module.boolean
isInline()
Determine if the definition is defined inline, meaning the definition is declared where it is used.default String
toCoordinates()
Generates a coordinate string for the provided information element definition.-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained
addConstraint, addConstraint, addConstraint, addConstraint, getAllowedValuesConstraints, getConstraints, getConstraintSupport, getExpectConstraints, getIndexHasKeyConstraints, getMatchesConstraints
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelElement
getContainingModule, getModelType, getRemarks
-
Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelElement
getDescription, getEffectiveDescription, getEffectiveFormalName, getEffectiveName, getFormalName, getJsonName, getName, getProperties, getPropertyValues, getUseName, hasProperty, hasPropertyValue
-
-
-
-
Field Detail
-
DEFAULT_DEFINITION_MODEL_SCOPE
@NonNull static final ModuleScopeEnum DEFAULT_DEFINITION_MODEL_SCOPE
-
-
Method Detail
-
getModuleScope
@NonNull ModuleScopeEnum getModuleScope()
Retrieve the definition's scope within the context of its defining module.- Returns:
- the module scope
-
toCoordinates
default String toCoordinates()
Generates a coordinate string for the provided information element definition. A coordinate consists of the element's:- containing Metaschema's short name
- model type
- name
- hash code
- Specified by:
toCoordinates
in interfaceIModelElement
- Returns:
- the coordinate
-
isInline
boolean isInline()
Determine if the definition is defined inline, meaning the definition is declared where it is used.- Returns:
true
if the definition is declared inline orfalse
if the definition is able to be globally referenced
-
getInlineInstance
INamedInstance getInlineInstance()
IfisInline()
istrue
, return the instance the definition is inlined for.- Returns:
- the instance or
null
otherwise
-
-