Package com.openkm.sdk4j.impl

Class SearchImpl

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:

sochoa

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SearchImpl(String host)	SearchImpl

Method Summary

Modifier and Type	Method	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.
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 queryParams, String sortField, boolean sortReverse, String propertiesPlugin, List<String> groups)	Find with metadata list.
List<QueryResult>	findWithMetadata(QueryParams queryParams, 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>	getAllSearches()	Gets all searches.
List<Document>	getCategorizedDocuments(String categoryId)	Gets categorized documents.
QueryParams	getSearch(int qpId)	Gets search.
NodeSearchConfig	getSearchConfig(String pluginName)	Gets search config.
long	saveSearch(QueryParams params)	Save search long.
void	setAuthorizationToken(String authorizationToken)	setAuthenticationToken
void	updateSearch(QueryParams params)	Update search.

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

getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object

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

Constructor Details

SearchImpl

public SearchImpl(String host)

SearchImpl

Method Details

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

find

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

Description copied from interface: BaseSearch

Find list.

Specified by:

find in interface BaseSearch

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

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

Description copied from interface: BaseSearch

Find list.

Specified by:

find in interface BaseSearch

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

findSimpleNodeBasePaginated

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

Description copied from interface: BaseSearch

Find simple node base paginated simple node base result set.

Specified by:

findSimpleNodeBasePaginated in interface BaseSearch

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

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

Description copied from interface: BaseSearch

Find simple node base paginated simple node base result set.

Specified by:

findSimpleNodeBasePaginated in interface BaseSearch

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

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

Description copied from interface: BaseSearch

Find simple node base paginated simple node base result set.

Specified by:

findSimpleNodeBasePaginated in interface BaseSearch

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

findWithMetadata

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

Description copied from interface: BaseSearch

Find with metadata list.

Specified by:

findWithMetadata in interface BaseSearch

Parameters:

queryParams - 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

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

Description copied from interface: BaseSearch

Find with metadata list.

Specified by:

findWithMetadata in interface BaseSearch

Parameters:

queryParams - 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

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

Description copied from interface: BaseSearch

Find with metadata paginated result set.

Specified by:

findWithMetadataPaginated in interface BaseSearch

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

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

Description copied from interface: BaseSearch

Find with metadata paginated result set.

Specified by:

findWithMetadataPaginated in interface BaseSearch

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

findByQuery

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

Description copied from interface: BaseSearch

Find by query list.

Specified by:

findByQuery in interface BaseSearch

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

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

Description copied from interface: BaseSearch

Find by query list.

Specified by:

findByQuery in interface BaseSearch

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

findSimpleNodeBaseByQueryPaginated

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

Description copied from interface: BaseSearch

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

Specified by:

findSimpleNodeBaseByQueryPaginated in interface BaseSearch

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

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

Description copied from interface: BaseSearch

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

Specified by:

findSimpleNodeBaseByQueryPaginated in interface BaseSearch

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

getCategorizedDocuments

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

Description copied from interface: BaseSearch

Gets categorized documents.

Specified by:

getCategorizedDocuments in interface BaseSearch

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

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

Description copied from interface: BaseSearch

Save search long.

Specified by:

saveSearch in interface BaseSearch

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

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

Description copied from interface: BaseSearch

Update search.

Specified by:

updateSearch in interface BaseSearch

Parameters:

params - the params

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSearch

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

Description copied from interface: BaseSearch

Gets search.

Specified by:

getSearch in interface BaseSearch

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

getAllSearches

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

Description copied from interface: BaseSearch

Gets all searches.

Specified by:

getAllSearches in interface BaseSearch

Returns:

the all searches

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteSearch

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

Description copied from interface: BaseSearch

Delete search.

Specified by:

deleteSearch in interface BaseSearch

Parameters:

qpId - the qp id

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSearchConfig

public NodeSearchConfig getSearchConfig(String pluginName)
                                 throws UnknownException,
WebserviceException

Description copied from interface: BaseSearch

Gets search config.

Specified by:

getSearchConfig in interface BaseSearch

Parameters:

pluginName - the plugin name

Returns:

search config

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

findAllDefaultByNodeClass

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

Description copied from interface: BaseSearch

Find all default by node class list.

Specified by:

findAllDefaultByNodeClass in interface BaseSearch

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

csvExport

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

Description copied from interface: BaseSearch

Csv export input stream.

Specified by:

csvExport in interface BaseSearch

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