SearchImpl (OpenKM SDK for Java 3.12 API)

java.lang.Object
- com.openkm.sdk4j.impl.ClientImpl
- - com.openkm.sdk4j.impl.SearchImpl

All Implemented Interfaces:

BaseSearch, Serializable
```
public class SearchImpl
extends ClientImpl
implements BaseSearch, Serializable
```
SearchImpl

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchImpl(String host)
SearchImpl

Constructors
Constructor and Description
`SearchImpl(String host)` SearchImpl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteSearch(int qpId)`
`List<QueryResult>`	`find(QueryParams queryParams, String propertiesPlugin)`
`List<QueryParams>`	`findAllDefaultByNodeClass(long ncId)`
`List<QueryResult>`	`findByQuery(String query, String propertiesPlugin)`
`ResultSet`	`findByQueryPaginated(String query, int offset, int limit, String propertiesPlugin)`
`ResultSet`	`findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin)`
`SimpleNodeBaseResultSet`	`findSimpleNodeBaseByQueryPaginated(String query, int offset, int limit)`
`SimpleNodeBaseResultSet`	`findSimpleNodeBasePaginated(QueryParams queryParams, int offset, int limit)`
`List<QueryResult>`	`findWithMetadata(QueryParams queryParams, String propertiesPlugin, List<String> groups)`
`ResultSet`	`findWithMetadataPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin, List<String> groups)`
`List<QueryParams>`	`getAllSearchs()`
`List<Document>`	`getCategorizedDocuments(String categoryId)`
`Map<String,Integer>`	`getKeywordMap(List<String> filter)`
`List<MimeType>`	`getMimeTypes()`
`QueryParams`	`getSearch(int qpId)`
`long`	`saveSearch(QueryParams params)`
`void`	`setAuthorizationToken(String authorizationToken)` setAuthenticationToken
`void`	`updateSearch(QueryParams params)`

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, resource, resource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SearchImpl
```
public SearchImpl(String host)
```
  SearchImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

find

public List<QueryResult> find(QueryParams queryParams,
                              String propertiesPlugin)
                       throws AccessDeniedException,
                              ParseException,
                              RepositoryException,
                              DatabaseException,
                              UnknownException,
                              WebserviceException

Specified by:: find in interface BaseSearch
Throws:: AccessDeniedException; ParseException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findPaginated

public ResultSet findPaginated(QueryParams queryParams,
                               int offset,
                               int limit,
                               String propertiesPlugin)
                        throws AccessDeniedException,
                               ParseException,
                               RepositoryException,
                               DatabaseException,
                               UnknownException,
                               WebserviceException

Specified by:: findPaginated in interface BaseSearch
Throws:: AccessDeniedException; ParseException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findSimpleNodeBasePaginated

public SimpleNodeBaseResultSet findSimpleNodeBasePaginated(QueryParams queryParams,
                                                           int offset,
                                                           int limit)
                                                    throws AccessDeniedException,
                                                           ParseException,
                                                           RepositoryException,
                                                           DatabaseException,
                                                           UnknownException,
                                                           WebserviceException

Specified by:: findSimpleNodeBasePaginated in interface BaseSearch
Throws:: AccessDeniedException; ParseException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getKeywordMap

public Map<String,Integer> getKeywordMap(List<String> filter)
                                  throws AccessDeniedException,
                                         RepositoryException,
                                         DatabaseException,
                                         UnknownException,
                                         WebserviceException

Specified by:: getKeywordMap in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getCategorizedDocuments

public List<Document> getCategorizedDocuments(String categoryId)
                                       throws AccessDeniedException,
                                              RepositoryException,
                                              DatabaseException,
                                              UnknownException,
                                              WebserviceException

Specified by:: getCategorizedDocuments in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

saveSearch

public long saveSearch(QueryParams params)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException

Specified by:: saveSearch in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

updateSearch

public void updateSearch(QueryParams params)
                  throws AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Specified by:: updateSearch in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getSearch

public QueryParams getSearch(int qpId)
                      throws AccessDeniedException,
                             PathNotFoundException,
                             RepositoryException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException

Specified by:: getSearch in interface BaseSearch
Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getAllSearchs

public List<QueryParams> getAllSearchs()
                                throws AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       UnknownException,
                                       WebserviceException

Specified by:: getAllSearchs in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

deleteSearch

public void deleteSearch(int qpId)
                  throws AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Specified by:: deleteSearch in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findAllDefaultByNodeClass

public List<QueryParams> findAllDefaultByNodeClass(long ncId)
                                            throws AccessDeniedException,
                                                   RepositoryException,
                                                   DatabaseException,
                                                   UnknownException,
                                                   WebserviceException

Specified by:: findAllDefaultByNodeClass in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findByQuery

public List<QueryResult> findByQuery(String query,
                                     String propertiesPlugin)
                              throws ParseException,
                                     AccessDeniedException,
                                     RepositoryException,
                                     DatabaseException,
                                     UnknownException,
                                     WebserviceException

Specified by:: findByQuery in interface BaseSearch
Throws:: ParseException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findByQueryPaginated

public ResultSet findByQueryPaginated(String query,
                                      int offset,
                                      int limit,
                                      String propertiesPlugin)
                               throws ParseException,
                                      AccessDeniedException,
                                      RepositoryException,
                                      DatabaseException,
                                      UnknownException,
                                      WebserviceException

Specified by:: findByQueryPaginated in interface BaseSearch
Throws:: ParseException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findSimpleNodeBaseByQueryPaginated

public SimpleNodeBaseResultSet findSimpleNodeBaseByQueryPaginated(String query,
                                                                  int offset,
                                                                  int limit)
                                                           throws ParseException,
                                                                  AccessDeniedException,
                                                                  RepositoryException,
                                                                  DatabaseException,
                                                                  UnknownException,
                                                                  WebserviceException

Specified by:: findSimpleNodeBaseByQueryPaginated in interface BaseSearch
Throws:: ParseException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findWithMetadata

public List<QueryResult> findWithMetadata(QueryParams queryParams,
                                          String propertiesPlugin,
                                          List<String> groups)
                                   throws ParseException,
                                          AccessDeniedException,
                                          RepositoryException,
                                          DatabaseException,
                                          UnknownException,
                                          WebserviceException

Specified by:: findWithMetadata in interface BaseSearch
Throws:: ParseException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

findWithMetadataPaginated

public ResultSet findWithMetadataPaginated(QueryParams queryParams,
                                           int offset,
                                           int limit,
                                           String propertiesPlugin,
                                           List<String> groups)
                                    throws AccessDeniedException,
                                           ParseException,
                                           RepositoryException,
                                           DatabaseException,
                                           UnknownException,
                                           WebserviceException

Specified by:: findWithMetadataPaginated in interface BaseSearch
Throws:: AccessDeniedException; ParseException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getMimeTypes

public List<MimeType> getMimeTypes()
                            throws AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   UnknownException,
                                   WebserviceException

Specified by:: getMimeTypes in interface BaseSearch
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

Class SearchImpl

Constructor Summary

Method Summary

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

Methods inherited from class java.lang.Object

Constructor Detail

SearchImpl

Method Detail

setAuthorizationToken

find

findPaginated

findSimpleNodeBasePaginated

getKeywordMap

getCategorizedDocuments

saveSearch

updateSearch

getSearch

getAllSearchs

deleteSearch

findAllDefaultByNodeClass

findByQuery

findByQueryPaginated

findSimpleNodeBaseByQueryPaginated

findWithMetadata

findWithMetadataPaginated

getMimeTypes