javax.wsdl.Operation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.cxf Show documentation

Apache CXF is an open-source services framework that aids in the development of services using front-end programming APIs, like JAX-WS and JAX-RS.

There is a newer version: 62

Show newest version

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

package javax.wsdl;

import java.util.*;

/**
 * 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
   */
  public void setName(String name);

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

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

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

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

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

  /**
   * Add a fault message that must be associated with this
   * operation.
   *
   * @param fault the new fault message
   */
  public 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
   */
  public 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
   */
  public Fault removeFault(String name);
  
  /**
   * Get all the fault messages associated with this operation.
   *
   * @return names of fault messages
   */
  public Map getFaults();

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

  /**
   * Get the operation type.
   *
   * @return the operation type
   */
  public 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
   */
  public void setParameterOrdering(List parameterOrder);

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

  public void setUndefined(boolean isUndefined);

  public boolean isUndefined();
}