/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You under the Apache 
 * License, Version 2.0 (the "License"); you may not use this file except in 
 * compliance with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.opensaml.ws.wsaddressing;

import javax.xml.namespace.QName;

import org.opensaml.xml.AttributeExtensibleXMLObject;
import org.opensaml.xml.schema.XSURI;

/**
 * Interface for element <wsa:RelatesTo>.
 * 
 * @see "WS-Addressing 1.0 - Core"
 * 
 */
public interface RelatesTo extends XSURI, AttributeExtensibleXMLObject, WSAddressingObject {
    
    /** Element local name. */
    public static final String ELEMENT_LOCAL_NAME = "RelatesTo";

    /** Default element name. */
    public static final QName ELEMENT_NAME =
        new QName(WSAddressingConstants.WSA_NS, ELEMENT_LOCAL_NAME, WSAddressingConstants.WSA_PREFIX);
    
    /** Local name of the XSI type. */
    public static final String TYPE_LOCAL_NAME = "RelatesToType"; 
        
    /** QName of the XSI type. */
    public static final QName TYPE_NAME = 
        new QName(WSAddressingConstants.WSA_NS, TYPE_LOCAL_NAME, WSAddressingConstants.WSA_PREFIX);
    
    /** The RelationshipType attribute name. */
    public static final String RELATIONSHIP_TYPE_ATTRIB_NAME = "RelationshipType";
    
    /** RelationshipType attribute - Reply URI. */
    public static final String RELATIONSHIP_TYPE_REPLY = WSAddressingConstants.WSA_NS + "/reply";
    
    /**
     * Returns the RelationshipType attribute URI value.
     * 
     * @return the RelationshipType attribute value or <code>null</code>.
     */
    public String getRelationshipType();

    /**
     * Sets the RelationshipType attribute URI value.
     * 
     * @param newRelationshipType the RelationshipType attribute value.
     */
    public void setRelationshipType(String newRelationshipType);

}