org.cytoscape.io.webservice.events

Class SearchFinishedEvent<T>

java.lang.Object

org.cytoscape.event.AbstractCyEvent<WebServiceClient>

org.cytoscape.io.webservice.events.SearchFinishedEvent<T>

Type Parameters:

T - The type of the search result.

All Implemented Interfaces:

CyEvent<WebServiceClient>

public final class SearchFinishedEvent<T>
extends AbstractCyEvent<WebServiceClient>

An event that indicates a search has completed.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed 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>

Constructor Summary

Constructors

Constructor and Description
SearchFinishedEvent(WebServiceClient source, T result) Constructs the event.

Method Summary

Methods

Modifier and Type	Method and Description
T	getSearchResult() Returns The search result.

Methods inherited from class org.cytoscape.event.AbstractCyEvent

getListenerClass, getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFinishedEvent

public SearchFinishedEvent(WebServiceClient source,
                   T result)

Constructs the event.

Parameters:

source - the source object firing the event.

result - the search result object.

Method Detail

getSearchResult

public T getSearchResult()

Returns The search result.

Returns:

The search result.