com.openkm.sdk4j.definition

Interface BaseSearch

All Known Implementing Classes:

OKMWebservices, SearchImpl

public interface BaseSearch

The interface Base search.

Method Summary

Modifier and Type	Method and Description
InputStream	csvExport(String lang, QueryParams queryParams, boolean compact) Csv export input stream.
void	deleteSearch(int qpId) Delete search.
List<QueryResult>	find(QueryParams queryParams, String propertiesPlugin) Find list.
List<QueryResult>	find(QueryParams queryParams, String sortField, boolean sortReverse, String propertiesPlugin) Find list.
List<QueryParams>	findAllDefaultByNodeClass(long ncId) Find all default by node class list.
List<QueryResult>	findByQuery(String query, String propertiesPlugin) Find by query list.
List<QueryResult>	findByQuery(String query, String sortField, boolean sortReverse, String propertiesPlugin) Find by query list.
ResultSet	findByQueryPaginated(String query, int offset, int limit, String propertiesPlugin) Find by query paginated result set.
ResultSet	findByQueryPaginated(String query, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin) Find by query paginated result set.
ResultSet	findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin) Find paginated result set.
ResultSet	findPaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin) Find paginated result set.
SimpleNodeBaseResultSet	findSimpleNodeBaseByQueryPaginated(String query, int offset, int limit) Find simple node base by query paginated simple node base result set.
SimpleNodeBaseResultSet	findSimpleNodeBaseByQueryPaginated(String query, String sortField, boolean sortReverse, int offset, int limit) Find simple node base by query paginated simple node base result set.
SimpleNodeBaseResultSet	findSimpleNodeBasePaginated(QueryParams queryParams, int offset, int limit) Find simple node base paginated simple node base result set.
SimpleNodeBaseResultSet	findSimpleNodeBasePaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit) Find simple node base paginated simple node base result set.
SimpleNodeBaseResultSet	findSimpleNodeBasePaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit, String pluginName) Find simple node base paginated simple node base result set.
List<QueryResult>	findWithMetadata(QueryParams params, String sortField, boolean sortReverse, String propertiesPlugin, List<String> groups) Find with metadata list.
List<QueryResult>	findWithMetadata(QueryParams params, String propertiesPlugin, List<String> groups) Find with metadata list.
ResultSet	findWithMetadataPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin, List<String> groups) Find with metadata paginated result set.
ResultSet	findWithMetadataPaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin, List<String> groups) Find with metadata paginated result set.
List<QueryParams>	getAllSearchs() Gets all searchs.
List<Document>	getCategorizedDocuments(String categoryId) Gets categorized documents.
Map<String,Integer>	getKeywordMap(List<String> filter) Gets keyword map.
List<MimeType>	getMimeTypes() Gets mime types.
QueryParams	getSearch(int qpId) Gets search.
NodeSearchConfig	getSearchConfig(String pluginName) Gets search config.
SearchPluginList	getSearchPlugins() Gets search plugins.
long	saveSearch(QueryParams params) Save search long.
void	updateSearch(QueryParams params) Update search.

Method Detail

find

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

Find list.

Parameters:

queryParams - the query params

propertiesPlugin - the properties plugin

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

find

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

Find list.

Parameters:

queryParams - the query params

sortField - the sort field

sortReverse - the sort reverse

propertiesPlugin - the properties plugin

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findPaginated

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

Find paginated result set.

Parameters:

queryParams - the query params

offset - the offset

limit - the limit

propertiesPlugin - the properties plugin

Returns:

the result set

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findPaginated

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

Find paginated result set.

Parameters:

queryParams - the query params

sortField - the sort field

sortReverse - the sort reverse

offset - the offset

limit - the limit

propertiesPlugin - the properties plugin

Returns:

the result set

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findSimpleNodeBasePaginated

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

Find simple node base paginated simple node base result set.

Parameters:

queryParams - the query params

offset - the offset

limit - the limit

Returns:

the simple node base result set

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findSimpleNodeBasePaginated

SimpleNodeBaseResultSet findSimpleNodeBasePaginated(QueryParams queryParams,
                                                    String sortField,
                                                    boolean sortReverse,
                                                    int offset,
                                                    int limit)
                                             throws AccessDeniedException,
                                                    ParseException,
                                                    RepositoryException,
                                                    DatabaseException,
                                                    UnknownException,
                                                    WebserviceException

Find simple node base paginated simple node base result set.

Parameters:

queryParams - the query params

sortField - the sort field

sortReverse - the sort reverse

offset - the offset

limit - the limit

Returns:

the simple node base result set

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findSimpleNodeBasePaginated

SimpleNodeBaseResultSet findSimpleNodeBasePaginated(QueryParams queryParams,
                                                    String sortField,
                                                    boolean sortReverse,
                                                    int offset,
                                                    int limit,
                                                    String pluginName)
                                             throws AccessDeniedException,
                                                    ParseException,
                                                    RepositoryException,
                                                    DatabaseException,
                                                    UnknownException,
                                                    WebserviceException

Find simple node base paginated simple node base result set.

Parameters:

queryParams - the query params

sortField - the sort field

sortReverse - the sort reverse

offset - the offset

limit - the limit

pluginName - the plugin name

Returns:

the simple node base result set

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getKeywordMap

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

Gets keyword map.

Parameters:

filter - the filter

Returns:

the keyword map

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getCategorizedDocuments

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

Gets categorized documents.

Parameters:

categoryId - the category id

Returns:

the categorized documents

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

saveSearch

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

Save search long.

Parameters:

params - the params

Returns:

the long

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

updateSearch

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

Update search.

Parameters:

params - the params

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSearch

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

Gets search.

Parameters:

qpId - the qp id

Returns:

the search

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getAllSearchs

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

Gets all searchs.

Returns:

the all searchs

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteSearch

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

Delete search.

Parameters:

qpId - the qp id

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSearchPlugins

SearchPluginList getSearchPlugins()
                           throws UnknownException,
                                  WebserviceException

Gets search plugins.

Returns:

search plugins

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSearchConfig

NodeSearchConfig getSearchConfig(String pluginName)
                          throws UnknownException,
                                 WebserviceException

Gets search config.

Parameters:

pluginName - the plugin name

Returns:

search config

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

findAllDefaultByNodeClass

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

Find all default by node class list.

Parameters:

ncId - the nc id

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findByQuery

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

Find by query list.

Parameters:

query - the query

propertiesPlugin - the properties plugin

Returns:

the list

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findByQuery

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

Find by query list.

Parameters:

query - the query

sortField - the sort field

sortReverse - the sort reverse

propertiesPlugin - the properties plugin

Returns:

the list

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findByQueryPaginated

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

Find by query paginated result set.

Parameters:

query - the query

offset - the offset

limit - the limit

propertiesPlugin - the properties plugin

Returns:

the result set

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findByQueryPaginated

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

Find by query paginated result set.

Parameters:

query - the query

sortField - the sort field

sortReverse - the sort reverse

offset - the offset

limit - the limit

propertiesPlugin - the properties plugin

Returns:

the result set

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findSimpleNodeBaseByQueryPaginated

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

Find simple node base by query paginated simple node base result set.

Parameters:

query - the query

offset - the offset

limit - the limit

Returns:

the simple node base result set

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findSimpleNodeBaseByQueryPaginated

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

Find simple node base by query paginated simple node base result set.

Parameters:

query - the query

sortField - the sort field

sortReverse - the sort reverse

offset - the offset

limit - the limit

Returns:

the simple node base result set

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findWithMetadata

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

Find with metadata list.

Parameters:

params - the params

propertiesPlugin - the properties plugin

groups - the groups

Returns:

the list

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findWithMetadata

List<QueryResult> findWithMetadata(QueryParams params,
                                   String sortField,
                                   boolean sortReverse,
                                   String propertiesPlugin,
                                   List<String> groups)
                            throws ParseException,
                                   AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   UnknownException,
                                   WebserviceException

Find with metadata list.

Parameters:

params - the params

sortField - the sort field

sortReverse - the sort reverse

propertiesPlugin - the properties plugin

groups - the groups

Returns:

the list

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findWithMetadataPaginated

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

Find with metadata paginated result set.

Parameters:

queryParams - the query params

offset - the offset

limit - the limit

propertiesPlugin - the properties plugin

groups - the groups

Returns:

the result set

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findWithMetadataPaginated

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

Find with metadata paginated result set.

Parameters:

queryParams - the query params

sortField - the sort field

sortReverse - the sort reverse

offset - the offset

limit - the limit

propertiesPlugin - the properties plugin

groups - the groups

Returns:

the result set

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getMimeTypes

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

Gets mime types.

Returns:

the mime types

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

csvExport

InputStream csvExport(String lang,
                      QueryParams queryParams,
                      boolean compact)
               throws AccessDeniedException,
                      ParseException,
                      RepositoryException,
                      DatabaseException,
                      UnknownException,
                      WebserviceException

Csv export input stream.

Parameters:

lang - the lang

queryParams - the query params

compact - the compact

Returns:

the input stream

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception