Package com.aquima.interactions.communication

Interface IRestServiceDefinition

All Known Implementing Classes:

RestServiceDefinition

public interface IRestServiceDefinition

This interface defines a rest service.

Since:

9.0

Author:

a.pragt

Method Summary

Modifier and Type	Method	Description
String	getApiDocumentation()	Returns the api documentation for the rest service.
RestServiceDirection	getDirection()	Returns the direction of the service.
String	getLocation()	Returns the location url of the service.
String	getName()	Returns the name of the service.
IRestOperationDefinition	getOperation(String operationName)	Returns an operation of the service.
String[]	getOperationNames()	Returns all available operation names in the service.
ISchemaSetDefinition	getSchemaSet()	Returns the corresponding schemaset of the service.
boolean	useDomainSchemas()	Returns a indicator whether to use domain schemas (otherwise schemasets are used).

Method Details

getName

String getName()

Returns the name of the service.

Returns:

The name of the service, may not be null.

getLocation

String getLocation()

Returns the location url of the service.

Returns:

The location url of the service, may be null.

useDomainSchemas

boolean useDomainSchemas()

Returns a indicator whether to use domain schemas (otherwise schemasets are used).

Returns:

Indicator for using domain schemas.

getSchemaSet

ISchemaSetDefinition getSchemaSet()

Returns the corresponding schemaset of the service.

Returns:

The schemaset definition of the service, may be null in case of a domain schema.

getOperationNames

String[] getOperationNames()

Returns all available operation names in the service.

Returns:

The operation names of the service, may not be null.

getOperation

IRestOperationDefinition getOperation(String operationName)

Returns an operation of the service.

Parameters:

operationName - The name of the operation, may not be null.

Returns:

The definition of the operation.

Throws:

UnknownOperationException - when the operation does not exist for the rest service.

getDirection

RestServiceDirection getDirection()

Returns the direction of the service.

Returns:

Whether the service is used for outgoing requests, incoming requests or both, may not be null.

getApiDocumentation

String getApiDocumentation()

Returns the api documentation for the rest service.

Returns:

The api documentation for the rest service.