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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2022 Nordix Foundation.
* ================================================================================
* 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.apex.model.eventmodel.concepts;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
/**
* This class specializes the {@link AxField} class for use as input fields on events.
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "apexInputField", namespace = "http://www.onap.org/policy/apex-pdp")
@XmlType(name = "AxInputField", namespace = "http://www.onap.org/policy/apex-pdp")
public class AxInputField extends AxField {
private static final long serialVersionUID = 2090324845463750391L;
/**
* The default constructor creates a field with a null artifact and schema key.
*/
public AxInputField() {
super();
}
/**
* The default constructor creates a field with the given artifact key and a null schema key.
*
* @param key the field key
*/
public AxInputField(final AxReferenceKey key) {
super(key);
}
/**
* Constructor to create the field with both its keys defined.
*
* @param key the field key
* @param fieldSchemaKey the key of the field schema to use for this field
*/
public AxInputField(final AxReferenceKey key, final AxArtifactKey fieldSchemaKey) {
super(key, fieldSchemaKey);
}
/**
* Constructor to create the field with both its keys defined and optional flag specified.
*
* @param key the field key
* @param fieldSchemaKey the key of the field schema to use for this field
* @param optional true if the task field is optional, false otherwise
*/
public AxInputField(final AxReferenceKey key, final AxArtifactKey fieldSchemaKey, final boolean optional) {
super(key, fieldSchemaKey, optional);
}
/**
* Constructor to create the field with the local name of its reference key defined and its schema key defined.
*
* @param localName the local name of the field reference key
* @param fieldSchemaKey the key of the field schema to use for this field
*/
public AxInputField(final String localName, final AxArtifactKey fieldSchemaKey) {
super(localName, fieldSchemaKey);
}
/**
* Copy constructor, create an input field as a copy of another input field.
*
* @param field the input field to copy from
*/
public AxInputField(final AxInputField field) {
super(new AxReferenceKey(field.getKey()), new AxArtifactKey(field.getSchema()), field.getOptional());
}
}
|
