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.oscal.lib.model.control.catalog; 028 029import gov.nist.secauto.oscal.lib.model.Control; 030import gov.nist.secauto.oscal.lib.model.Parameter; 031 032import java.util.List; 033import java.util.stream.Stream; 034 035import edu.umd.cs.findbugs.annotations.NonNull; 036 037public interface IControlContainer { 038 039 List<Control> getControls(); 040 041 /** 042 * Add a new {@link Control} item to the end of the underlying collection. 043 * 044 * @param item 045 * the item to add 046 * @return {@code true} 047 */ 048 boolean addControl(@NonNull Control item); 049 050 /** 051 * Remove the first matching {@link Control} item from the underlying 052 * collection. 053 * 054 * @param item 055 * the item to remove 056 * @return {@code true} if the item was removed or {@code false} otherwise 057 */ 058 boolean removeControl(@NonNull Control item); 059 060 List<Parameter> getParams(); 061 062 /** 063 * Add a new {@link Parameter} item to the underlying collection. 064 * 065 * @param item 066 * the item to add 067 * @return {@code true} 068 */ 069 boolean addParam(@NonNull Parameter item); 070 071 /** 072 * Remove the first matching {@link Parameter} item from the underlying 073 * collection. 074 * 075 * @param item 076 * the item to remove 077 * @return {@code true} if the item was removed or {@code false} otherwise 078 */ 079 boolean removeParam(@NonNull Parameter item); 080 081 /** 082 * Get the parameter identifiers referenced in the object's context, but not by 083 * their child objects. 084 * 085 * @return a stream of identifiers 086 */ 087 Stream<String> getReferencedParameterIds(); 088}