com.webcohesion.enunciate.api.services.Operation Maven / Gradle / Ivy

Go to download
/**
 * Copyright © 2006-2016 Web Cohesion ([email protected])
 *
 * Licensed 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 com.webcohesion.enunciate.api.services;

import com.webcohesion.enunciate.api.HasAnnotations;
import com.webcohesion.enunciate.api.HasStyles;
import com.webcohesion.enunciate.api.datatype.DataTypeReference;
import com.webcohesion.enunciate.facets.HasFacets;
import com.webcohesion.enunciate.javac.javadoc.JavaDoc;

import java.util.List;

/**
 * @author Ryan Heaton
 */
public interface Operation extends HasStyles, HasAnnotations, HasFacets {

  String getName();

  String getSlug();

  String getDescription();

  String getDeprecated();

  String getSince();

  List getSeeAlso();

  String getVersion();

  List getInputParameters();

  List getOutputParameters();

  List getHttpRequestHeaders();

  DataTypeReference getReturnType();

  String getReturnDescription();

  List getFaults();

  JavaDoc getJavaDoc();

  Service getService();
}