001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.core.model; 028 029import gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained; 030 031import edu.umd.cs.findbugs.annotations.NonNull; 032 033public interface IDefinition extends INamedModelElement, IFeatureValueConstrained { 034 035 @NonNull 036 ModuleScopeEnum DEFAULT_DEFINITION_MODEL_SCOPE = ModuleScopeEnum.INHERITED; 037 038 /** 039 * Retrieve the definition's scope within the context of its defining module. 040 * 041 * @return the module scope 042 */ 043 @NonNull 044 ModuleScopeEnum getModuleScope(); 045 046 /** 047 * Generates a coordinate string for the provided information element 048 * definition. 049 * 050 * A coordinate consists of the element's: 051 * <ul> 052 * <li>containing Metaschema's short name</li> 053 * <li>model type</li> 054 * <li>name</li> 055 * <li>hash code</li> 056 * </ul> 057 * 058 * @return the coordinate 059 */ 060 @SuppressWarnings("null") 061 @Override 062 default String toCoordinates() { 063 return String.format("%s:%s:%s(%d)", 064 getContainingModule().getShortName(), 065 getModelType(), 066 getName(), hashCode()); 067 } 068 069 /** 070 * Determine if the definition is defined inline, meaning the definition is 071 * declared where it is used. 072 * 073 * @return {@code true} if the definition is declared inline or {@code false} if 074 * the definition is able to be globally referenced 075 */ 076 boolean isInline(); 077 078 /** 079 * If {@link #isInline()} is {@code true}, return the instance the definition is 080 * inlined for. 081 * 082 * @return the instance or {@code null} otherwise 083 */ 084 INamedInstance getInlineInstance(); 085}