IIndexConstraint (Metaschema Core API 1.0.0-M1 API)

All Superinterfaces:

IConstraint, IKeyConstraint

All Known Implementing Classes:

DefaultIndexConstraint
```
public interface IIndexConstraint
extends IKeyConstraint
```
Represents a rule that generates a key-based index containing references to data items found in a Metaschema data instance.
The generated index can be used to check cross-references between Metaschema data objects using the IIndexHasKeyConstraint.

Nested Class Summary
- Nested classes/interfaces inherited from interface gov.nist.secauto.metaschema.core.model.constraint.IConstraint
  IConstraint.ExternalModelSource, IConstraint.ExternalSource, IConstraint.InternalModelSource, IConstraint.ISource, IConstraint.Level

Field Summary
- Fields inherited from interface gov.nist.secauto.metaschema.core.model.constraint.IConstraint
  DEFAULT_LEVEL, DEFAULT_TARGET, DEFAULT_TARGET_METAPATH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getName()`	Get the name of the index, which is used to refer to the index by an `IIndexHasKeyConstraint`.

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.IConstraint
accept, getDescription, getFormalName, getId, getLevel, getProperties, getRemarks, getSource, getTarget, matchTargets, matchTargets

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.IKeyConstraint
getKeyFields

- Method Detail
  - getName
```
@NonNull
String getName()
```
    Get the name of the index, which is used to refer to the index by an IIndexHasKeyConstraint.
    
    Returns:
    
    the name of the index