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.decima.core.assessment.result;
28
29 import gov.nist.secauto.decima.core.requirement.BaseRequirement;
30 import gov.nist.secauto.decima.core.requirement.DerivedRequirement;
31
32 import java.util.List;
33
34 /**
35 * Represents the compiled results of evaluating all derived requirements associated with a given
36 * {@link BaseRequirement}.
37 * <p>
38 * If the associated base requirement is not within the assessment scope, then the
39 * {@link #getStatus()} method is expected to return {@link ResultStatus#NOT_IN_SCOPE}. If the base
40 * requirement does not specify a set of {@link DerivedRequirement} objects, then the
41 * {@link #getStatus()} method is expected to return {@link ResultStatus#NOT_TESTED}, indicating
42 * that the test is not implemented.
43 */
44 public interface BaseRequirementResult extends RequirementResult {
45 /**
46 * The base requirement this result relates to.
47 *
48 * @return the derived requirement
49 */
50 BaseRequirement getBaseRequirement();
51
52 /**
53 * The individual derived requirement results that relate to this base requirement.
54 *
55 * @return a list of zero or more assertion results
56 */
57 List<DerivedRequirementResult> getDerivedRequirementResults();
58 }