aboutsummaryrefslogtreecommitdiffstats
path: root/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxConceptGetter.java
blob: 0735f87c34641b171521cc655eac8397e46f9df1 (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
/*
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-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.apex.model.basicmodel.concepts;

import java.util.Set;

/**
 * This interface is used to allow get methods to be placed on concepts that have embedded maps.
 * <p>
 * It forces those concepts with maps to implement the get methods specified on this interface as convenience methods to avoid concept users having to use a
 * second level of referencing to access concepts in the the maps.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 * @param <C> the type of concept on which the interface is applied.
 */
public interface AxConceptGetter<C> {

    /**
     * Get the latest version for a concept with the given key.
     *
     * @param conceptKey The key of the concept
     * @return The concept
     */
    C get(AxArtifactKey conceptKey);

    /**
     * Get the latest version for a concept with the given key name.
     *
     * @param conceptKeyName The name of the concept
     * @return The concept
     */
    C get(String conceptKeyName);

    /**
     * Get the latest version for a concept with the given key name and version.
     *
     * @param conceptKeyName The name of the concept
     * @param conceptKeyVersion The version of the concept
     * @return The concept
     */
    C get(String conceptKeyName, String conceptKeyVersion);

    /**
     * Get the all versions for a concept with the given key name.
     *
     * @param conceptKeyName The name of the concept
     * @return The concepts
     */
    Set<C> getAll(String conceptKeyName);

    /**
     * Get the all versions for a concept with the given key name and starting version.
     *
     * @param conceptKeyName The name of the concept
     * @param conceptKeyVersion The first version version of the concept to get
     * @return The concepts
     */
    Set<C> getAll(String conceptKeyName, String conceptKeyVersion);
}