1 /* 2 * Portions of this software was developed by employees of the National Institute 3 * of Standards and Technology (NIST), an agency of the Federal Government and is 4 * being made available as a public service. Pursuant to title 17 United States 5 * Code Section 105, works of NIST employees are not subject to copyright 6 * protection in the United States. This software may be subject to foreign 7 * copyright. Permission in the United States and in foreign countries, to the 8 * extent that NIST may hold copyright, to use, copy, modify, create derivative 9 * works, and distribute this software and its documentation without fee is hereby 10 * granted on a non-exclusive basis, provided that this notice and disclaimer 11 * of warranty appears in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 25 */ 26 27 package gov.nist.secauto.metaschema.core.model; 28 29 import gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained; 30 31 import edu.umd.cs.findbugs.annotations.NonNull; 32 33 public interface IDefinition extends INamedModelElement, IFeatureValueConstrained { 34 35 @NonNull 36 ModuleScopeEnum DEFAULT_DEFINITION_MODEL_SCOPE = ModuleScopeEnum.INHERITED; 37 38 /** 39 * Retrieve the definition's scope within the context of its defining module. 40 * 41 * @return the module scope 42 */ 43 @NonNull 44 ModuleScopeEnum getModuleScope(); 45 46 /** 47 * Generates a coordinate string for the provided information element 48 * definition. 49 * 50 * A coordinate consists of the element's: 51 * <ul> 52 * <li>containing Metaschema's short name</li> 53 * <li>model type</li> 54 * <li>name</li> 55 * <li>hash code</li> 56 * </ul> 57 * 58 * @return the coordinate 59 */ 60 @SuppressWarnings("null") 61 @Override 62 default String toCoordinates() { 63 return String.format("%s:%s:%s(%d)", 64 getContainingModule().getShortName(), 65 getModelType(), 66 getName(), hashCode()); 67 } 68 69 /** 70 * Determine if the definition is defined inline, meaning the definition is 71 * declared where it is used. 72 * 73 * @return {@code true} if the definition is declared inline or {@code false} if 74 * the definition is able to be globally referenced 75 */ 76 boolean isInline(); 77 78 /** 79 * If {@link #isInline()} is {@code true}, return the instance the definition is 80 * inlined for. 81 * 82 * @return the instance or {@code null} otherwise 83 */ 84 INamedInstance getInlineInstance(); 85 }