ITKService (ITK API and Reference Implementation mini-site 0.1-SNAPSHOT API)

All Known Implementing Classes:

ITKServiceImpl
```
public interface ITKService
```
Definition of a fully resolved ITKService including the supported pattern, mime type and whether or not the payload should be base64 encoded.

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

See Also:
DirectoryOfServices.getService(String)

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getMimeType()` Specifies the appropriate mime type for this service
`String`	`getServiceId()` Obtains the service identifier associated with this ITKService object
`boolean`	`isBase64()` Determines whether this service expects the business payload data to be base64 encoded. Note: In ITK all ADT v2 pipe and hat messages are required to base64 encoded during transmission
`boolean`	`supportsAsync()` Determines whether or not this service supports an asynchronous invocation.
`boolean`	`supportsSync()` Determines whether or not this service supports synchronous invocation.

- Method Detail
  - getServiceId
```
String getServiceId()
```
    Obtains the service identifier associated with this ITKService object
    
    Returns:
    the ITK service identifier - e.g. urn:nhs-itk:services:201005:transferPatient-v1-0
  - supportsSync
```
boolean supportsSync()
```
    Determines whether or not this service supports synchronous invocation.
    
    Returns:
    true if the service supports synchronous invocation
  - supportsAsync
```
boolean supportsAsync()
```
    Determines whether or not this service supports an asynchronous invocation.
    
    Returns:
    true if the service supports asynchronous invocation
  - isBase64
```
boolean isBase64()
```
    Determines whether this service expects the business payload data to be base64 encoded.
    
    Note: In ITK all ADT v2 pipe and hat messages are required to base64 encoded during transmission
    
    Returns:
    true if the service defines that the payload data should be base64 encoding during transmission; false otherwise
  - getMimeType
```
String getMimeType()
```
    Specifies the appropriate mime type for this service
    
    Returns:
    The String representing the Mime type that should be set when transmitting ITKMessages on this service - e.g. text/xml

All content is available under the Open Government Licence, except where otherwise stated
All example source code is available under Apache 2.0, except where otherwise stated

Interface ITKService

Method Summary

Method Detail

getServiceId

supportsSync

supportsAsync

isBase64

getMimeType