summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/1.2.1/modules/interface/src/main/java/org/apache/tuscany/sca/interfacedef/Operation.java
blob: d9ff31ba923cf2d86a12d415b9b1161be915fa2b (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.tuscany.sca.interfacedef;

import java.util.List;

import org.apache.tuscany.sca.interfacedef.util.WrapperInfo;

/**
 * Represents an operation on a service interface.
 */
public interface Operation extends Cloneable {
    /**
     * Returns the name of the operation.
     * 
     * @return the name of the operation
     */
    String getName();

    /**
     * Sets the name of the operation.
     * 
     * @param name the name of the operation
     */
    void setName(String name);

    /**
     * Returns true if the model element is unresolved.
     * 
     * @return true if the model element is unresolved.
     */
    boolean isUnresolved();

    /**
     * Sets whether the model element is unresolved.
     * 
     * @param unresolved whether the model element is unresolved
     */
    void setUnresolved(boolean unresolved);

    /**
     * Get the data type that represents the input of this operation. The logic
     * type is a list of data types and each element represents a parameter
     * 
     * @return the inputType
     */
    DataType<List<DataType>> getInputType();
    
    /**
     * @param inputType
     */
    void setInputType(DataType<List<DataType>> inputType);

    /**
     * Get the data type for the output
     * 
     * @return the outputType
     */
    DataType getOutputType();
    
    /**
     * @param outputType
     */
    void setOutputType(DataType outputType);

    /**
     * Get a list of data types to represent the faults/exceptions
     * 
     * @return the faultTypes
     */
    List<DataType> getFaultTypes();
    
    /**
     * @param faultTypes
     */
    void setFaultTypes(List<DataType> faultTypes);
    
    /**
     * Get the owning interface
     * @return
     */
    Interface getInterface();
    
    /**
     * Set the owning interface
     * @param interfaze
     */
    void setInterface(Interface interfaze);
    
    /**
     * Get the sequence of the conversation
     * @return
     */
    ConversationSequence getConversationSequence();
    
    /**
     * Set the sequence of conversation for the operation
     * @param sequence
     */
    void setConversationSequence(ConversationSequence sequence);
    
    /**
     * Indicate if the operation is non-blocking
     * @return
     */
    boolean isNonBlocking();
    
    /**
     * Set the operation to be non-blocking
     */
    void setNonBlocking(boolean nonBlocking);
    
    /**
     * @return the wrapperInfo
     */
    WrapperInfo getWrapper();

    /**
     * @param wrapperInfo the wrapperInfo to set
     */
    void setWrapper(WrapperInfo wrapperInfo);

    /**
     * @return the wrapperStyle
     */
    boolean isWrapperStyle();

    /**
     * @param wrapperStyle the wrapperStyle to set
     */
    void setWrapperStyle(boolean wrapperStyle);
    
    /**
     * Get the databinding for the operation
     * @return
     */
    String getDataBinding();
    
    /**
     * Set the databinding for the operation
     * @param dataBinding
     */
    void setDataBinding(String dataBinding);
    
    /**
     * Returns true if the operation is dynamic.
     * 
     * @return true if the operation is dynamic otherwise false
     */
    boolean isDynamic();

    /**
     * Set if the operation is dynamic
     * @param b
     */
    void setDynamic(boolean b);

    /**
     * Implementations must support cloning.
     */
    Object clone() throws CloneNotSupportedException;
    
}