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.oscal.lib.model.control.catalog; 28 29 import gov.nist.secauto.oscal.lib.model.Control; 30 import gov.nist.secauto.oscal.lib.model.Parameter; 31 32 import java.util.List; 33 import java.util.stream.Stream; 34 35 import edu.umd.cs.findbugs.annotations.NonNull; 36 37 public interface IControlContainer { 38 39 List<Control> getControls(); 40 41 /** 42 * Add a new {@link Control} item to the end of the underlying collection. 43 * 44 * @param item 45 * the item to add 46 * @return {@code true} 47 */ 48 boolean addControl(@NonNull Control item); 49 50 /** 51 * Remove the first matching {@link Control} item from the underlying 52 * collection. 53 * 54 * @param item 55 * the item to remove 56 * @return {@code true} if the item was removed or {@code false} otherwise 57 */ 58 boolean removeControl(@NonNull Control item); 59 60 List<Parameter> getParams(); 61 62 /** 63 * Add a new {@link Parameter} item to the underlying collection. 64 * 65 * @param item 66 * the item to add 67 * @return {@code true} 68 */ 69 boolean addParam(@NonNull Parameter item); 70 71 /** 72 * Remove the first matching {@link Parameter} item from the underlying 73 * collection. 74 * 75 * @param item 76 * the item to remove 77 * @return {@code true} if the item was removed or {@code false} otherwise 78 */ 79 boolean removeParam(@NonNull Parameter item); 80 81 /** 82 * Get the parameter identifiers referenced in the object's context, but not by 83 * their child objects. 84 * 85 * @return a stream of identifiers 86 */ 87 Stream<String> getReferencedParameterIds(); 88 }