View Javadoc

1   /*
2    * Copyright 2008 Members of the EGEE Collaboration.
3    * Copyright 2008 University Corporation for Advanced Internet Development, Inc.
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.opensaml.ws.wsaddressing;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.AttributeExtensibleXMLObject;
23  import org.opensaml.xml.schema.XSURI;
24  
25  /**
26   * Interface for element <wsa:RelatesTo>.
27   * 
28   * @see "WS-Addressing 1.0 - Core"
29   * 
30   */
31  public interface RelatesTo extends XSURI, AttributeExtensibleXMLObject, WSAddressingObject {
32      
33      /** Element local name. */
34      public static final String ELEMENT_LOCAL_NAME = "RelatesTo";
35  
36      /** Default element name. */
37      public static final QName ELEMENT_NAME =
38          new QName(WSAddressingConstants.WSA_NS, ELEMENT_LOCAL_NAME, WSAddressingConstants.WSA_PREFIX);
39      
40      /** Local name of the XSI type. */
41      public static final String TYPE_LOCAL_NAME = "RelatesToType"; 
42          
43      /** QName of the XSI type. */
44      public static final QName TYPE_NAME = 
45          new QName(WSAddressingConstants.WSA_NS, TYPE_LOCAL_NAME, WSAddressingConstants.WSA_PREFIX);
46      
47      /** The RelationshipType attribute name. */
48      public static final String RELATIONSHIP_TYPE_ATTRIB_NAME = "RelationshipType";
49      
50      /** RelationshipType attribute - Reply URI. */
51      public static final String RELATIONSHIP_TYPE_REPLY = WSAddressingConstants.WSA_NS + "/reply";
52      
53      /**
54       * Returns the RelationshipType attribute URI value.
55       * 
56       * @return the RelationshipType attribute value or <code>null</code>.
57       */
58      public String getRelationshipType();
59  
60      /**
61       * Sets the RelationshipType attribute URI value.
62       * 
63       * @param newRelationshipType the RelationshipType attribute value.
64       */
65      public void setRelationshipType(String newRelationshipType);
66  
67  }