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.constraint; 028 029import java.util.List; 030 031import edu.umd.cs.findbugs.annotations.NonNull; 032 033/** 034 * Represents a container of rules constraining the effective model of a 035 * Metaschema field or flag data instance. 036 */ 037public interface IValueConstrained extends IConstrained { 038 /** 039 * Get the collection of allowed value constraints, if any. 040 * 041 * @return the constraints or an empty list 042 */ 043 @NonNull 044 List<? extends IAllowedValuesConstraint> getAllowedValuesConstraints(); 045 046 /** 047 * Get the collection of matches constraints, if any. 048 * 049 * @return the constraints or an empty list 050 */ 051 @NonNull 052 List<? extends IMatchesConstraint> getMatchesConstraints(); 053 054 /** 055 * Get the collection of index key reference constraints, if any. 056 * 057 * @return the constraints or an empty list 058 */ 059 @NonNull 060 List<? extends IIndexHasKeyConstraint> getIndexHasKeyConstraints(); 061 062 /** 063 * Get the collection of expect constraints, if any. 064 * 065 * @return the constraints or an empty list 066 */ 067 @NonNull 068 List<? extends IExpectConstraint> getExpectConstraints(); 069 070 void addConstraint(@NonNull IAllowedValuesConstraint constraint); 071 072 void addConstraint(@NonNull IMatchesConstraint constraint); 073 074 void addConstraint(@NonNull IIndexHasKeyConstraint constraint); 075 076 void addConstraint(@NonNull IExpectConstraint constraint); 077}