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