Difference between revisions of "OKMSearch"
From OpenKM Documentation
(Created page with '{{TOCright}} __TOC__ Methods related to repository search. Category: Webservices Guide') |
|||
| Line 2: | Line 2: | ||
Methods related to repository search. | Methods related to repository search. | ||
| + | |||
| + | == QueryResultArray findByContent(String token, String words) == | ||
| + | Search for documents using it indexed content. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''expression'' - Expression to be searched. | ||
| + | |||
| + | '''Returns''' | ||
| + | * A collection of document which content matched the searched expression. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''RepositoryException'' - If there is any general repository problem. | ||
| + | |||
| + | == QueryResultArray findByName(String token, String words) == | ||
| + | Search for documents by document name. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''expression'' – Expression to be searched. | ||
| + | |||
| + | '''Returns''' | ||
| + | * A collection of document which name matched the searched expression. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''RepositoryException'' - If there is any general repository problem. | ||
| + | |||
| + | == QueryResultArray findByKeywords(String token, String words) == | ||
| + | Search for documents using it associated keywords. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''expression'' – Expression to be searched. | ||
| + | |||
| + | '''Returns''' | ||
| + | * A collection of document which keywords matched the searched expression. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''RepositoryException'' - If there is any general repository problem. | ||
| + | |||
| + | == QueryResultArray findByStatement(String token, String statement, String type) == | ||
| + | Search for documents and folder nodes specifying a complex query statement. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''statement'' - Query statement to be executed. | ||
| + | * ''type'' - The query language can be "sql" or "xpath". | ||
| + | |||
| + | '''Returns''' | ||
| + | * A collection of document from the resulting query statement. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''RepositoryException'' - If there is any general repository problem or the query fails. | ||
[[Category: Webservices Guide]] | [[Category: Webservices Guide]] | ||
Revision as of 13:08, 8 March 2010
Methods related to repository search.
QueryResultArray findByContent(String token, String words)
Search for documents using it indexed content.
Parameters
- token - The session authorization token.
- expression - Expression to be searched.
Returns
- A collection of document which content matched the searched expression.
Throws
- RepositoryException - If there is any general repository problem.
QueryResultArray findByName(String token, String words)
Search for documents by document name.
Parameters
- token - The session authorization token.
- expression – Expression to be searched.
Returns
- A collection of document which name matched the searched expression.
Throws
- RepositoryException - If there is any general repository problem.
QueryResultArray findByKeywords(String token, String words)
Search for documents using it associated keywords.
Parameters
- token - The session authorization token.
- expression – Expression to be searched.
Returns
- A collection of document which keywords matched the searched expression.
Throws
- RepositoryException - If there is any general repository problem.
QueryResultArray findByStatement(String token, String statement, String type)
Search for documents and folder nodes specifying a complex query statement.
Parameters
- token - The session authorization token.
- statement - Query statement to be executed.
- type - The query language can be "sql" or "xpath".
Returns
- A collection of document from the resulting query statement.
Throws
- RepositoryException - If there is any general repository problem or the query fails.
