org.apache.woden.wsdl20.xml.InterfaceMessageReferenceElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.sharepoint.soap.repository
Liferay Sharepoint SOAP Repository
There is a newer version: 5.0.22
/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.woden.wsdl20.xml;


import org.apache.woden.types.NCName;
import org.apache.woden.types.QNameTokenUnion;
import org.apache.woden.wsdl20.enumeration.Direction;
import org.apache.ws.commons.schema.XmlSchemaElement;

/**
 * Represents the WSDL 2.0 <input> and <output> elements, 
 * declared as child elements of interface <operation> element. 
 * 
 * @author John Kaputin ([email protected])
 */
public interface InterfaceMessageReferenceElement extends DocumentableElement,
                                                          NestedElement
{
    /**
     * Set the message label to the specified NCName. 
     * This corresponds to the messageLabel attribute of the interface operation 
     * <input> and <output> elements. 
     * It represents a placeholder message in the message exchange pattern specified by the 
     * parent interface <operation> element.
     * 
     * @param msgLabel the NCName representing the message label
     */
    public void setMessageLabel(NCName msgLabel);
    
    /**
     * Return the NCName representing the message label. 
     * This corresponds to the messageLabel attribute of the interface operation 
     * <input> and <output> elements. 
     * It represents a placeholder message in the message exchange pattern specified by the 
     * parent interface <operation> element.
     * 
     * @return NCName the message label
     */
    public NCName getMessageLabel();
    
    /**
     * Specify the union of the xs:token and xs:QName of the global schema element declaration referred to by this 
     * InterfaceMessageReferenceElement.
     * The specified QNameTokenEnum corresponds to the element attribute of the interface 
     * operation <input> or <output> element.
     *
     * @param element the QNameTokenEnum of the element declaration.
     */
    public void setElement(QNameTokenUnion element);
    
    /**
     * Return the union of the xs:token and xs:QName of the global schema element declaration referred to by this 
     * InterfaceMessageReferenceElement.
     * This corresponds to the element attribute of the interface 
     * operation <input> or <output> element.
     * 
     * @return the QNameTokenEnum of the element declaration
     */
    public QNameTokenUnion getElement();
    
    /**
     * Return the XmlSchemaElement representing the global schema element declaration
     * referred to by this InterfaceMessageReferenceElement.
     * This equates to the <xs:element> element referred to by the element 
     * attribute of the interface operation <input> or <output> element.
     * If this reference cannot be resolved to an element declaration in a schema that 
     * is visible to the enclosing <description>, this method will return null. 
     * To be visible, the schema must have been correctly imported or inlined within 
     * the <types> element.
     * 
     * @return the XmlSchemaElement
     */
    public XmlSchemaElement getXmlSchemaElement();
    
    /**
     * Set the message direction using the specified enumerated type, Direction,
     * which indicates the direction of the message.
     * Direction.IN corresponds to the interface operation <input> element.
     * Direction.OUT corresponds to the interface operation <output> element.
     * 
     * @param dir the Direction of the message
     */
    public void setDirection(Direction dir);
    
    /**
     * Returns an enumerated type, Direction, that indicates the direction of this message.
     * Direction.IN corresponds to the interface operation <input> element.
     * Direction.OUT corresponds to the interface operation <output> element.
     * 
     * @return the Direction of the message
     */
    public Direction getDirection();

}