javax.wsdl.Operation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of libre-wsdl4j Show documentation

Open and Free WSDL library: Web Services Description Language. Libre-wsdl4j is a fork of WSDL4J 1.6.3. WSL4j is a Java stub generator for WSDL. Many software projects still depends on WSL4j, so the idea is that libre-wsdl4j should be an actively maintained version of this software on GitHub. "WSDL, that's an anchronym i haven't heard in almost ten years." Still big in the enterprise world" - comments on the Internet.

The newest version!

/*
 * (c) Copyright IBM Corp 2001, 2006 
 */

package javax.wsdl;

import java.util.*;

import javax.xml.namespace.QName;

/**
 * This interface represents a WSDL operation.
 * It includes information on input, output and fault
 * messages associated with usage of the operation.
 *
 * @author Paul Fremantle ([email protected])
 * @author Nirmal Mukhi ([email protected])
 * @author Matthew J. Duftler ([email protected])
 */
public interface Operation extends WSDLElement
{
  /**
   * Set the name of this operation.
   *
   * @param name the desired name
   */
  void setName(String name);

  /**
   * Get the name of this operation.
   *
   * @return the operation name
   */
  String getName();

  /**
   * Set the input message specification for this operation.
   *
   * @param input the new input message
   */
  void setInput(Input input);

  /**
   * Get the input message specification for this operation.
   *
   * @return the input message
   */
  Input getInput();

  /**
   * Set the output message specification for this operation.
   *
   * @param output the new output message
   */
  void setOutput(Output output);

  /**
   * Get the output message specification for this operation.
   *
   * @return the output message specification for the operation
   */
  Output getOutput();

  /**
   * Add a fault message that must be associated with this
   * operation.
   *
   * @param fault the new fault message
   */
  void addFault(Fault fault);

  /**
   * Get the specified fault message.
   *
   * @param name the name of the desired fault message.
   * @return the corresponding fault message, or null if there wasn't
   * any matching message
   */
  Fault getFault(String name);

  /**
   * Remove the specified fault message.
   *
   * @param name the name of the fault message to be removed.
   * @return the fault message which was removed
   */
  Fault removeFault(String name);
  
  /**
   * Get all the fault messages associated with this operation.
   *
   * @return names of fault messages
   */
  Map getFaults();

  /**
   * Set the style for this operation (request-response,
   * one way, solicit-response or notification).
   *
   * @param style the new operation style
   */
  void setStyle(OperationType style);

  /**
   * Get the operation type.
   *
   * @return the operation type
   */
  OperationType getStyle();

  /**
   * Set the parameter ordering for a request-response,
   * or solicit-response operation.
   *
   * @param parameterOrder a list of named parameters
   * containing the part names to reflect the desired
   * order of parameters for RPC-style operations
   */
  void setParameterOrdering(List parameterOrder);

  /**
   * Get the parameter ordering for this operation.
   *
   * @return the parameter ordering, a list consisting
   * of message part names
   */
  List getParameterOrdering();

  void setUndefined(boolean isUndefined);

  boolean isUndefined();
}