javax.xml.ws.addressing
Interface Relationship

All Superinterfaces:
AttributeExtensible

public interface Relationship
extends AttributeExtensible

This class is an abstraction of the RelatesToType defined by WS-Addressing schema. Includes an ID property that references the MessageID of the related message and a Type property corresponding to the RelationshipType attribute of the RelatesToType. Implementing classes must supply a single argument constructor with parameter type java.net.URI, which is used to initialize the ID property.

A new instance of Relationship is created as:

 AddressingBuilder.newInstance().newRelationship("http://example.com");
or

 try {
   AddressingBuilder.newInstance().newRelationship(new URI("http://example.com"));
 } catch (URISyntaxException e) { }

Since:
JAX-WSA 1.0
Author:
JAX-WSA Development Team

Method Summary
 java.net.URI getID()
          The accessor for the ID property.
 java.lang.String getType()
          The accessor for the Type property.
 void setType(java.lang.String type)
          The mutator for the Type property.
 
Methods inherited from interface javax.xml.ws.addressing.AttributeExtensible
addAttribute, getAttributes
 

Method Detail

getID

java.net.URI getID()
The accessor for the ID property.

Returns:
The value of the property.

getType

java.lang.String getType()
The accessor for the Type property.

The return value must be the same as the value of the attribute in the Map returned by getAttributes with name wsa:RelationshipType. For WS-Addressing versions where the data type of this attribute is xsd:anyURI, the toString value of the URI is returnd.

Returns:
the value of the property.

setType

void setType(java.lang.String type)
The mutator for the Type property. The default value is javax.ws.addressing.Constants.WSA_REPLY_TYPE.

Parameters:
type - the value to set.


Copyright © 2005 Sun Microsystems, Inc. All Rights Reserved.