com.openkm.rest.endpoint

Class SearchService

java.lang.Object

com.openkm.rest.endpoint.SearchService

@Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
 @Path(value="/search")
public class SearchService
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchService()

Method Summary

Modifier and Type	Method and Description
void	deleteSearch(int qpId)
QueryResultList	find(String content, String name, int domain, List<String> keywords, List<String> categories, List<String> properties, String author, String mimeType, String lastModifiedFrom, String lastModifiedTo, String mailSubject, String mailFrom, String mailTo, String path)
QueryResultList	findByContent(String content)
QueryResultList	findByKeywords(List<String> keywords)
QueryResultList	findByName(String name)
ResultSet	findMoreLikeThis(String uuid, int max)
ResultSet	findPaginated(int offset, int limit, String content, String name, int domain, List<String> keywords, List<String> categories, List<String> properties, String author, String mimeType, String lastModifiedFrom, String lastModifiedTo, String mailSubject, String mailFrom, String mailTo, String path)
ResultSet	findSimpleQueryPaginated(int offset, int limit, String statement)
QueryParamsList	getAllSearchs()
DocumentList	getCategorizedDocuments(String categoryId)
KeywordMapList	getKeywordMap(String[] filter)
QueryParams	getSearch(int qpId)
Long	saveSearch(QueryParams params)
void	updateSearch(QueryParams params)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchService

public SearchService()

Method Detail

findByContent

@GET
 @Path(value="/findByContent")
public QueryResultList findByContent(@QueryParam(value="content")
                                                                         String content)
                                                                  throws GenericException

Throws:

GenericException

findByName

@GET
 @Path(value="/findByName")
public QueryResultList findByName(@QueryParam(value="name")
                                                                   String name)
                                                            throws GenericException

Throws:

GenericException

findByKeywords

@GET
 @Path(value="/findByKeywords")
public QueryResultList findByKeywords(@QueryParam(value="keyword")
                                                                           List<String> keywords)
                                                                    throws GenericException

Throws:

GenericException

find

@GET
 @Path(value="/find")
public QueryResultList find(@QueryParam(value="content")
                                                       String content,
                                                       @QueryParam(value="name")
                                                       String name,
                                                       @DefaultValue(value="1") @QueryParam(value="domain")
                                                       int domain,
                                                       @QueryParam(value="keyword")
                                                       List<String> keywords,
                                                       @QueryParam(value="category")
                                                       List<String> categories,
                                                       @QueryParam(value="property")
                                                       List<String> properties,
                                                       @QueryParam(value="author")
                                                       String author,
                                                       @QueryParam(value="mimeType")
                                                       String mimeType,
                                                       @QueryParam(value="lastModifiedFrom")
                                                       String lastModifiedFrom,
                                                       @QueryParam(value="lastModifiedTo")
                                                       String lastModifiedTo,
                                                       @QueryParam(value="mailSubject")
                                                       String mailSubject,
                                                       @QueryParam(value="mailFrom")
                                                       String mailFrom,
                                                       @QueryParam(value="mailTo")
                                                       String mailTo,
                                                       @QueryParam(value="path")
                                                       String path)
                                                throws GenericException

Throws:

GenericException

findPaginated

@GET
 @Path(value="/findPaginated")
public ResultSet findPaginated(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                   int offset,
                                                                   @DefaultValue(value="10") @QueryParam(value="limit")
                                                                   int limit,
                                                                   @QueryParam(value="content")
                                                                   String content,
                                                                   @QueryParam(value="name")
                                                                   String name,
                                                                   @DefaultValue(value="1") @QueryParam(value="domain")
                                                                   int domain,
                                                                   @QueryParam(value="keyword")
                                                                   List<String> keywords,
                                                                   @QueryParam(value="category")
                                                                   List<String> categories,
                                                                   @QueryParam(value="property")
                                                                   List<String> properties,
                                                                   @QueryParam(value="author")
                                                                   String author,
                                                                   @QueryParam(value="mimeType")
                                                                   String mimeType,
                                                                   @QueryParam(value="lastModifiedFrom")
                                                                   String lastModifiedFrom,
                                                                   @QueryParam(value="lastModifiedTo")
                                                                   String lastModifiedTo,
                                                                   @QueryParam(value="mailSubject")
                                                                   String mailSubject,
                                                                   @QueryParam(value="mailFrom")
                                                                   String mailFrom,
                                                                   @QueryParam(value="mailTo")
                                                                   String mailTo,
                                                                   @QueryParam(value="path")
                                                                   String path)
                                                            throws GenericException

Throws:

GenericException

findSimpleQueryPaginated

@GET
 @Path(value="/findSimpleQueryPaginated")
public ResultSet findSimpleQueryPaginated(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                                         int offset,
                                                                                         @DefaultValue(value="10") @QueryParam(value="limit")
                                                                                         int limit,
                                                                                         @QueryParam(value="statement")
                                                                                         String statement)
                                                                                  throws GenericException

Throws:

GenericException

findMoreLikeThis

@GET
 @Path(value="/findSimpleQueryPaginated/{uuid}/{max}")
public ResultSet findMoreLikeThis(@PathParam(value="uuid")
                                                                                              String uuid,
                                                                                              @PathParam(value="max")
                                                                                              int max)
                                                                                       throws GenericException

Throws:

GenericException

getKeywordMap

@GET
 @Path(value="/getKeywordMap")
public KeywordMapList getKeywordMap(@QueryParam(value="filter")
                                                                        String[] filter)
                                                                 throws GenericException

Throws:

GenericException

getCategorizedDocuments

@GET
 @Path(value="/getCategorizedDocuments/{categoryId}")
public DocumentList getCategorizedDocuments(@PathParam(value="categoryId")
                                                                                                       String categoryId)
                                                                                                throws GenericException

Throws:

GenericException

saveSearch

@POST
 @Path(value="/saveSearch")
 @Produces(value="text/plain")
public Long saveSearch(QueryParams params)
                                                                                 throws GenericException

Throws:

GenericException

updateSearch

@PUT
 @Path(value="/updateSearch")
public void updateSearch(QueryParams params)
                                                     throws GenericException

Throws:

GenericException

getSearch

@GET
 @Path(value="/getSearch/{qpId}")
public QueryParams getSearch(@PathParam(value="qpId")
                                                                    int qpId)
                                                             throws GenericException

Throws:

GenericException

getAllSearchs

@GET
 @Path(value="/getAllSearchs")
public QueryParamsList getAllSearchs()
                                                                  throws GenericException

Throws:

GenericException

deleteSearch

@DELETE
 @Path(value="/deleteSearch/{qpId}")
public void deleteSearch(@PathParam(value="qpId")
                                                                      int qpId)
                                                               throws GenericException

Throws:

GenericException