01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19:
20: package org.apache.axis2.jaxws.description;
21:
22: import javax.jws.WebParam;
23:
24: /**
25: * A ParameterDescripton corresponds to parameter to a method on an SEI. That SEI could be explicit
26: * (i.e. WebService.endpointInterface=sei.class) or implicit (i.e. public methods on the service
27: * implementation are the contract and thus the implicit SEI).
28: * <p/>
29: * ParameterDescriptons contain information that is only relevent for and SEI-based service, i.e.
30: * one that is invoked via specific methods. This class does not exist for Provider-based services
31: * (i.e. those that specify WebServiceProvider)
32: * <p/>
33: * <pre>
34: * <b>ParameternDescription details</b>
35: * <p/>
36: * CORRESPONDS TO: A parameter to a method on an SEI (on both Client and Server)
37: * <p/>
38: * AXIS2 DELEGATE: None
39: * <p/>
40: * CHILDREN: None
41: * <p/>
42: * ANNOTATIONS:
43: * WebParam [181]
44: * <p/>
45: * WSDL ELEMENTS:
46: * message parts
47: * <p/>
48: * </pre>
49: */
50: public interface ParameterDescription {
51: // TODO: Fix this to not be the WebParam mode
52: // public enum Mode{IN, OUT, INOUT};
53:
54: public OperationDescription getOperationDescription();
55:
56: public String getParameterName();
57:
58: public String getTargetNamespace();
59:
60: public String getPartName();
61:
62: public boolean isHolderType();
63:
64: // Indicates whether or not an @XMLList annotation was found on a parameter
65: public boolean isListType();
66:
67: public Class getParameterType();
68:
69: public Class getParameterActualType();
70:
71: public boolean isHeader();
72:
73: // TODO: Fix this to not be the WebParam mode
74:
75: public WebParam.Mode getMode();
76:
77: /**
78: * @return AttachmentDescription for this parameter or null
79: */
80: public AttachmentDescription getAttachmentDescription();
81:
82: }
|