Interface IRestOperationDefinition
- All Known Implementing Classes:
RestOperationDefinition
public interface IRestOperationDefinition
This interface defines a rest operation.
- Since:
- 9.0
- Author:
- a.pragt
-
Method Summary
Modifier and TypeMethodDescriptionReturns the documentation of the operation.getName()
This method returns the name of the operation.This method returns the request definition of the operation.This method returns the response definition of the operation
-
Method Details
-
getName
String getName()This method returns the name of the operation.- Returns:
- The name of the operation, may not be null.
-
getDocumentation
String getDocumentation()Returns the documentation of the operation.- Returns:
- The documentation, may be null
-
getRequestMessage
IRestRequestMessageDefinition getRequestMessage()This method returns the request definition of the operation.- Returns:
- The definition of the request message, may not be null.
-
getResponseMessage
IRestMessageDefinition getResponseMessage()This method returns the response definition of the operation- Returns:
- The definition of the response message, may be null.
-