01: /*
02: * BEGIN_HEADER - DO NOT EDIT
03: *
04: * The contents of this file are subject to the terms
05: * of the Common Development and Distribution License
06: * (the "License"). You may not use this file except
07: * in compliance with the License.
08: *
09: * You can obtain a copy of the license at
10: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
11: * See the License for the specific language governing
12: * permissions and limitations under the License.
13: *
14: * When distributing Covered Code, include this CDDL
15: * HEADER in each file and include the License file at
16: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
17: * If applicable add the following below this CDDL HEADER,
18: * with the fields enclosed by brackets "[]" replaced with
19: * your own identifying information: Portions Copyright
20: * [year] [name of copyright owner]
21: */
22:
23: /*
24: * @(#)ExtensibleDocumentedComponent.java
25: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
26: *
27: * END_HEADER - DO NOT EDIT
28: */
29: package com.sun.jbi.wsdl2;
30:
31: /**
32: * Base API for all extensible, documented components.
33: *
34: * @author ApiGen AX.00
35: */
36: public interface ExtensibleDocumentedComponent {
37: /**
38: * Get map of WSDL-defined attribute QNames for this component, indexed
39: * by QName.toString().
40: *
41: * @return Map of WSDL-defined attribute QNames for this component,
42: * indexed by QName.toString()
43: */
44: java.util.Map getWsdlAttributeNameMap();
45:
46: /**
47: * Get documentation for component, if any.
48: * @param i the index by which the document is going to obtained
49: *
50: * @return documentation for component, if any
51: */
52: Document getDocument(int i);
53:
54: /**
55: * Get documentation for component, if any.
56: * This method is for backward compatibility, it always returns
57: * the first document (i.e., index = 0)
58: *
59: * @deprecated - replaced by getDocument(int i)
60: * @return documentation for component, if any
61: */
62: Document getDocument();
63:
64: /**
65: * Set documentation for component, if any.
66: * @param i the index by which the document is going to be set
67: *
68: * @param theDocument documentation for component, if any
69: */
70: void setDocument(int i, Document theDocument);
71:
72: /**
73: * Set documentation for component, if any.
74: * This method is for backward compatibility, it always set the
75: * the document which has the index = 0
76: *
77: * @deprecated - replaced by setDocument(int i, Document theDocument);
78: * @param theDocument documentation for component, if any
79: */
80: void setDocument(Document theDocument);
81:
82: /**
83: * Get extensions for component, if any.
84: *
85: * @return extensions for component, if any
86: */
87: Extensions getExtensions();
88:
89: /**
90: * Set extensions for component, if any.
91: *
92: * @param theExtensions extensions for component, if any
93: */
94: void setExtensions(Extensions theExtensions);
95:
96: }
97:
98: // End-of-file: ExtensibleDocumentedComponent.java
|