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.constraint;
28
29 import java.util.List;
30
31 import edu.umd.cs.findbugs.annotations.NonNull;
32
33 /**
34 * Represents a container of rules constraining the effective model of a
35 * Metaschema assembly data instance.
36 */
37 public interface IModelConstrained extends IValueConstrained {
38 /**
39 * Get the collection of index constraints, if any.
40 *
41 * @return the constraints or an empty list
42 */
43 @NonNull
44 List<? extends IIndexConstraint> getIndexConstraints();
45
46 /**
47 * Get the collection of unique constraints, if any.
48 *
49 * @return the constraints or an empty list
50 */
51 @NonNull
52 List<? extends IUniqueConstraint> getUniqueConstraints();
53
54 /**
55 * Get the collection of cardinality constraints, if any.
56 *
57 * @return the constraints or an empty list
58 */
59 @NonNull
60 List<? extends ICardinalityConstraint> getHasCardinalityConstraints();
61
62 void addConstraint(@NonNull IIndexConstraint constraint);
63
64 void addConstraint(@NonNull IUniqueConstraint constraint);
65
66 void addConstraint(@NonNull ICardinalityConstraint constraint);
67 }