org.cytoscape.io.webservice

Interface WebServiceClient

All Known Implementing Classes:

AbstractWebServiceClient, AbstractWebServiceGUIClient

public interface WebServiceClient

Thin wrapper for SOAP/REST web service clients. All web service clients must implement this interface.

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Module: webservice-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>webservice-api</artifactId>
</dependency>

Method Summary

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(Object query) Set query for the tasks to be executed.
String	getDescription() Get human-readable description of this client.
String	getDisplayName() Returns display name of this client.
URI	getServiceLocation() Returns resource location of this service, i.e., service URL.

Method Detail

getServiceLocation

URI getServiceLocation()

Returns resource location of this service, i.e., service URL. This is guaranteed to be globally unique and can be used as identifier.

Returns:

URI of the service.

getDisplayName

String getDisplayName()

Returns display name of this client. This is more human readable name for this client. This may not be unique.

Returns:

display name for this client.

getDescription

String getDescription()

Get human-readable description of this client.

Returns:

Description as a string. Users should write parser for this return value.

createTaskIterator

TaskIterator createTaskIterator(Object query)

Set query for the tasks to be executed.

Parameters:

query - query object. This is client-dependent.