annotate WebServiceExtensionsV1.1/WebServiceToolWorkflow_REST_SOAP/lib/SAWADLParser/src/javax/wadls/extensions/AttributeExtensible.java @ 0:049760c677de default tip

Galaxy WSExtensions added successfully
author uga-galaxy-group
date Tue, 05 Jul 2011 19:34:18 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
1
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
2
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
3 package javax.wadls.extensions;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
4
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
5 import java.util.*;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
6 import javax.xml.namespace.*;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
7
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
8 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
9 * Classes that implement this interface can contain extensibility
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
10 * attributes.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
11 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
12 * @author Matthew J. Duftler
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
13 * @author Paul Fremantle
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
14 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
15 public interface AttributeExtensible
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
16 {
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
17 public static final int NO_DECLARED_TYPE = -1;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
18 public static final int STRING_TYPE = 0;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
19 public static final int QNAME_TYPE = 1;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
20 public static final int LIST_OF_STRINGS_TYPE = 2;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
21 public static final int LIST_OF_QNAMES_TYPE = 3;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
22
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
23 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
24 * Set an extension attribute on this element. Pass in a null value to remove
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
25 * an extension attribute.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
26 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
27 * @param name the extension attribute name
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
28 * @param value the extension attribute value. Can be a String, a QName, a
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
29 * List of Strings, or a List of QNames.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
30 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
31 * @see #getExtensionAttribute
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
32 * @see #getExtensionAttributes
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
33 * @see ExtensionRegistry#registerExtensionAttributeType
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
34 * @see ExtensionRegistry#queryExtensionAttributeType
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
35 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
36 public void setExtensionAttribute(QName name, Object value);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
37
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
38 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
39 * Retrieve an extension attribute from this element. If the extension
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
40 * attribute is not defined, null is returned.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
41 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
42 * @param name the extension attribute name
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
43 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
44 * @return the value of the extension attribute, or null if
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
45 * it is not defined. Can be a String, a QName, a List of Strings, or a List
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
46 * of QNames.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
47 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
48 * @see #setExtensionAttribute
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
49 * @see #getExtensionAttributes
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
50 * @see ExtensionRegistry#registerExtensionAttributeType
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
51 * @see ExtensionRegistry#queryExtensionAttributeType
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
52 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
53 public Object getExtensionAttribute(QName name);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
54
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
55 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
56 * Get the map containing all the extension attributes defined
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
57 * on this element. The keys are the qnames of the attributes.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
58 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
59 * @return a map containing all the extension attributes defined
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
60 * on this element
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
61 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
62 * @see #setExtensionAttribute
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
63 * @see #getExtensionAttribute
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
64 * @see ExtensionRegistry#registerExtensionAttributeType
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
65 * @see ExtensionRegistry#queryExtensionAttributeType
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
66 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
67 public Map getExtensionAttributes();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
68
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
69 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
70 * Get the list of local attribute names defined for this element in
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
71 * the WSDL specification.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
72 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
73 * @return a List of Strings, one for each local attribute name
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
74 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
75 public List getNativeAttributeNames();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
76 }