Source Code Cross Referenced for ServiceRef.java in  » IDE-Netbeans » bpel » org » netbeans » modules » bpel » model » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*
02:         * The contents of this file are subject to the terms of the Common Development
03:         * and Distribution License (the License). You may not use this file except in
04:         * compliance with the License.
05:         * 
06:         * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
07:         * or http://www.netbeans.org/cddl.txt.
08:         * 
09:         * When distributing Covered Code, include this CDDL Header Notice in each file
10:         * and include the License file at http://www.netbeans.org/cddl.txt.
11:         * If applicable, add the following below the CDDL Header, with the fields
12:         * enclosed by brackets [] replaced by your own identifying information:
13:         * "Portions Copyrighted [year] [name of copyright owner]"
14:         * 
15:         * The Original Software is NetBeans. The Initial Developer of the Original
16:         * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17:         * Microsystems, Inc. All Rights Reserved.
18:         */
19:
20:        /**
21:         *
22:         */package org.netbeans.modules.bpel.model.api;
23:
24:        import org.netbeans.modules.bpel.model.api.events.VetoException;
25:
26:        /**
27:         * <p>
28:         * Java class for ServiceRefType complex type.
29:         * <p>
30:         * The following schema fragment specifies the expected content contained within
31:         * this class.
32:         *
33:         * <pre>
34:         *      &lt;xsd:element name="service-ref" type="sref:ServiceRefType">
35:         *              &lt;xsd:annotation>
36:         *                      &lt;xsd:documentation>
37:         *                              This element can be used within a from-spec.
38:         *                      &lt;/xsd:documentation>
39:         *              &lt;/xsd:annotation>
40:         *      &lt;/xsd:element>
41:         *      &lt;xsd:complexType name="ServiceRefType">
42:         *              &lt;xsd:annotation>
43:         *                      &lt;xsd:documentation>
44:         *                              This type definition is for service reference container.
45:         *                              This container is used as envelope to wrap around the actual endpoint reference value,
46:         *                              when a BPEL process interacts the endpoint reference of a partnerLink.
47:         *                              It provides pluggability of different versions of service referencing schemes
48:         *                              being used within a BPEL program. The design pattern here is similar to those of
49:         *                              expression language.
50:         *                      &lt;/xsd:documentation>
51:         *              &lt;/xsd:annotation>
52:         *              &lt;xsd:sequence>
53:         *                      &lt;xsd:any namespace="##other" processContents="lax"/>
54:         *              &lt;/xsd:sequence>
55:         *              &lt;xsd:attribute name="reference-scheme" type="xsd:anyURI"/>
56:         *      &lt;/xsd:complexType>
57:         * </pre>
58:         * 
59:         * @author ads
60:         */
61:        public interface ServiceRef extends BpelContainer {
62:
63:            String SERVICE_REF_NS = "http://docs.oasis-open.org/wsbpel/2.0/serviceref"; // NOI18N
64:
65:            String REFERENCE_SCHEME = "reference-scheme"; // NOI18N
66:
67:            /**
68:             * @return "reference-scheme" attribute value.
69:             */
70:            String getReferenceScheme();
71:
72:            /**
73:             * Setter for "reference-scheme" attribute.
74:             * @param value New "reference-scheme" attribute value.
75:             * @throws VetoException {@link VetoException} will be thrown if <code>value</code>
76:             * is not acceptable here.
77:             */
78:            void setReferenceScheme(String value) throws VetoException;
79:
80:            /**
81:             * Removes "reference-scheme" attribute.
82:             */
83:            void removeReferenceScheme();
84:        }