Package com.aquima.interactions.communication.impl

Class RestOperationDefinition

java.lang.Object

com.aquima.interactions.communication.impl.RestOperationDefinition

All Implemented Interfaces:

IRestOperationDefinition

public final class RestOperationDefinition
extends Object
implements IRestOperationDefinition

This class holds the static definition of a rest operation.

Since:

9.0

Author:

Arjan Pragt, Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestOperationDefinition(RestServiceDefinition restService, IRestOperationDS datasource, ICommunicationEngine communicationEngine, IMetaModel metaModel, IRuleEngine ruleEngine)

Method Summary

Modifier and Type	Method	Description
String	getDocumentation()	Returns the documentation of the operation.
String	getName()	This method returns the name of the operation.
IRestRequestMessageDefinition	getRequestMessage()	This method returns the request definition of the operation.
IRestMessageDefinition	getResponseMessage()	This method returns the response definition of the operation
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RestOperationDefinition

protected RestOperationDefinition(RestServiceDefinition restService,
 IRestOperationDS datasource,
 ICommunicationEngine communicationEngine,
 IMetaModel metaModel,
 IRuleEngine ruleEngine)
                           throws InitializationException

Throws:

InitializationException

Method Details

getName

public String getName()

Description copied from interface: IRestOperationDefinition

This method returns the name of the operation.

Specified by:

getName in interface IRestOperationDefinition

Returns:

The name of the operation, may not be null.

getDocumentation

public String getDocumentation()

Description copied from interface: IRestOperationDefinition

Returns the documentation of the operation.

Specified by:

getDocumentation in interface IRestOperationDefinition

Returns:

The documentation, may be null

getRequestMessage

public IRestRequestMessageDefinition getRequestMessage()

Description copied from interface: IRestOperationDefinition

This method returns the request definition of the operation.

Specified by:

getRequestMessage in interface IRestOperationDefinition

Returns:

The definition of the request message, may not be null.

getResponseMessage

public IRestMessageDefinition getResponseMessage()

Description copied from interface: IRestOperationDefinition

This method returns the response definition of the operation

Specified by:

getResponseMessage in interface IRestOperationDefinition

Returns:

The definition of the response message, may be null.

toString

public String toString()

Overrides:

toString in class Object