blob: b97ccda063b0a8d1266753558f3fc560ed426cab (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2018 Ericsson. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.common.parameters;
/**
* This interface defines the result of a parameter validation.
*/
public interface ValidationResult {
/**
* Gets the name of the entity being validated.
*
* @return the name
*/
public String getName();
/**
* Gets the status of validation.
*
* @return the status
*/
public ValidationStatus getStatus();
/**
* Checks if the result is valid.
*
* @return true, if is valid
*/
default boolean isValid() {
return getStatus().isValid();
}
/**
* Gets the validation result.
*
* @return the full validation result
*/
default String getResult() {
return getResult(
ParameterConstants.DEFAULT_INITIAL_RESULT_INDENTATION,
ParameterConstants.DEFAULT_RESULT_INDENTATION,
ParameterConstants.DO_NOT_SHOW_CLEAN_RESULTS);
}
/**
* Gets the validation result.
*
* @param initialIndentation the indentation to use on the main result output
* @param subIndentation the indentation to use on sub parts of the result output
* @param showClean output information on clean fields
* @return the result
*/
public String getResult(final String initialIndentation, final String subIndentation, final boolean showClean);
/**
* Set a validation result.
* @param status The validation status the field is receiving
* @param message The validation message explaining the validation status
*/
public void setResult(final ValidationStatus status, final String message);
}
|
