summaryrefslogtreecommitdiffstats
path: root/javatoscachecker/checker/src/main/java/org/onap/tosca/checker/model/Capability.java
blob: eaf72c9457db42d0ec68cb6904cfe4ba45a635e3 (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
/*
 * Copyright (c) 2017 <AT&T>.  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.
 */
package org.onap.tosca.checker.model;

import java.util.List;

/*
 * Type specific capability definition, spec section 3.6.2
 */
public interface Capability extends TOSCAObject<Capability> {

	/**
	 */
	public String name();

	/**
	 * The required name of the Capability Type the capability definition is based upon.
   */
	public String type();

	/**
	 * The optional description of the Capability definition.
	 */	
	public String description();

	/**
	 * An optional list of one or more valid names of Node Types that are supported as valid sources of any 
	 * relationship established to the declared Capability Type.
	 */
	public List<String> valid_source_types();

	/**
	 * The optional minimum and maximum occurrences for the capability.
	 * By default, an exported Capability should allow at least one relationship to be formed with it with a
	 * maximum of UNBOUNDED relationships.
	 */
	public default Range occurences() {
		return (Range)proxyList("occurences", Range.class);
	}

	/**
	 * An optional list of property definitions for the Capability definition.
	 */
	public default Properties properties() {
		return (Properties)proxy("properties", Properties.class);
	}

	/**
	 * An optional list of attribute definitions for the Capability definition.
	 */
	public default Attributes attributes() {
		return (Attributes)proxy("attributes", Attributes.class);
	}

}