com.languagecomputer.api
Interface DocumentRetrievalWebService

All Superinterfaces:

BaseWebService

All Known Implementing Classes:

DocumentRetrievalWebServiceImpl

public interface DocumentRetrievalWebService
extends BaseWebService

Interface for document retrieval web service. Takes in a query and returns a list of query results.

Since:

1.0

Author:

Kirk Roberts

Method Summary

String	retrieve(String sessionID, String query, String format) Retrieves a list of results for the given query.
void	setPath(String sessionID, String path) Sets the location used to retrieve documents.

Methods inherited from interface com.languagecomputer.api.BaseWebService

registerSession, unregisterSession

Method Detail

setPath

void setPath(String sessionID,
             String path)
             throws Exception

Sets the location used to retrieve documents. This is an optional operation.

Parameters:

sessionID - The unique identifier String for the session for this operation.

path - The location to search for documents.

Throws:

IOException - If there is an issue accessing any I/O component required by the DocumentRetrievalService. Implementors may or may not validate the path and throw an exception if it is inaccessible.

Exception

retrieve

String retrieve(String sessionID,
                String query,
                String format)
                throws Exception

Retrieves a list of results for the given query.

Parameters:

sessionID - The unique identifier String for the session for this operation.

query - The query in the format described in the format parameter.

format - The format in which the query is in and in which the query results should be returned. Defaults to XML.

Returns:

The results of the query.

Throws:

Exception - If there was an error retrieving documents.