org.springframework.restdocs.operation

Interface Operation

All Known Implementing Classes:

StandardOperation

public interface Operation

Describes an operation performed on a RESTful service.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Returns a Map of attributes associated with the operation.
java.lang.String	getName() Returns the name of the operation.
OperationRequest	getRequest() Returns the request that was sent.
OperationResponse	getResponse() Returns the response that was received.

Method Detail

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Returns a Map of attributes associated with the operation.

Returns:

the attributes

getName

java.lang.String getName()

Returns the name of the operation.

Returns:

the name

getRequest

OperationRequest getRequest()

Returns the request that was sent.

Returns:

the request

getResponse

OperationResponse getResponse()

Returns the response that was received.

Returns:

the response