com.languagecomputer.api
Interface DossierWebService

All Superinterfaces:

BaseWebService

All Known Implementing Classes:

DossierWebServiceImpl

public interface DossierWebService
extends BaseWebService

Interface for dossier web service. The service takes a document and identifies the dossier attributes in the document text.

Since:

1.0

Author:

Toby Jungen

Method Summary

String	obtain(String sessionID, String name) Annotates the provided document with coreference information.
void	process(String sessionID, String document, String format) Identifies any dossier attributes in the provided document.

Methods inherited from interface com.languagecomputer.api.BaseWebService

registerSession, unregisterSession

Method Detail

process

void process(String sessionID,
             String document,
             String format)
             throws Exception

Identifies any dossier attributes in the provided document.

Parameters:

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

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

format - The format of the document. Defaults to XML.

Throws:

Exception - If there was an error processing the document.

obtain

String obtain(String sessionID,
              String name)
              throws Exception

Annotates the provided document with coreference information.

Parameters:

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

name - The name of the dossier to retrieve.

Returns:

The list of dossiers that match the specified name. May be empty.

Throws:

Exception - If there was an error obtaining the dossier.