com.openkm.ws.ws20.OKMSearch Class Reference

More...

Inheritance diagram for com.openkm.ws.ws20.OKMSearch:

Collaboration diagram for com.openkm.ws.ws20.OKMSearch:

Public Member Functions
	OKMSearch ()
	OKMSearch (String Url)
long	saveSearch ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @params)
void	saveSearchAsync (string token, queryParams @params)
void	saveSearchAsync (string token, queryParams @params, object userState)
resultSet	findMoreLikeThis ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string uuid, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int max)
void	findMoreLikeThisAsync (string token, string uuid, int max)
void	findMoreLikeThisAsync (string token, string uuid, int max, object userState)
queryParams	getSearch ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int qpId)
void	getSearchAsync (string token, int qpId)
void	getSearchAsync (string token, int qpId, object userState)
void	deleteSearch ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int qpId)
void	deleteSearchAsync (string token, int qpId)
void	deleteSearchAsync (string token, int qpId, object userState)
queryResult[]	findByName ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string name)
void	findByNameAsync (string token, string name)
void	findByNameAsync (string token, string name, object userState)
void	updateSearch ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @params)
void	updateSearchAsync (string token, queryParams @params)
void	updateSearchAsync (string token, queryParams @params, object userState)
queryResult[]	findByKeywords ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute("keywords", Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string[] keywords)
void	findByKeywordsAsync (string token, string[] keywords)
void	findByKeywordsAsync (string token, string[] keywords, object userState)
queryResult[]	find ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @params)
void	findAsync (string token, queryParams @params)
void	findAsync (string token, queryParams @params, object userState)
queryResult[]	findByContent ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string content)
void	findByContentAsync (string token, string content)
void	findByContentAsync (string token, string content, object userState)
resultSet	findPaginated ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @params, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int offset, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int limit)
void	findPaginatedAsync (string token, queryParams @params, int offset, int limit)
void	findPaginatedAsync (string token, queryParams @params, int offset, int limit, object userState)
document[]	getCategorizedDocuments ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string categoryId)
void	getCategorizedDocumentsAsync (string token, string categoryId)
void	getCategorizedDocumentsAsync (string token, string categoryId, object userState)
queryParams[]	getAllSearchs ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token)
void	getAllSearchsAsync (string token)
void	getAllSearchsAsync (string token, object userState)
resultSet	findSimpleQueryPaginated ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string statement, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int offset, [System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int limit)
void	findSimpleQueryPaginatedAsync (string token, string statement, int offset, int limit)
void	findSimpleQueryPaginatedAsync (string token, string statement, int offset, int limit, object userState)
integerPair[]	getKeywordMap ([System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string token, [System.Xml.Serialization.XmlElementAttribute("filter", Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string[] filter)
void	getKeywordMapAsync (string token, string[] filter)
void	getKeywordMapAsync (string token, string[] filter, object userState)
new void	CancelAsync (object userState)

Events
saveSearchCompletedEventHandler	saveSearchCompleted
findMoreLikeThisCompletedEventHandler	findMoreLikeThisCompleted
getSearchCompletedEventHandler	getSearchCompleted
deleteSearchCompletedEventHandler	deleteSearchCompleted
findByNameCompletedEventHandler	findByNameCompleted
updateSearchCompletedEventHandler	updateSearchCompleted
findByKeywordsCompletedEventHandler	findByKeywordsCompleted
findCompletedEventHandler	findCompleted
findByContentCompletedEventHandler	findByContentCompleted
findPaginatedCompletedEventHandler	findPaginatedCompleted
getCategorizedDocumentsCompletedEventHandler	getCategorizedDocumentsCompleted
getAllSearchsCompletedEventHandler	getAllSearchsCompleted
findSimpleQueryPaginatedCompletedEventHandler	findSimpleQueryPaginatedCompleted
getKeywordMapCompletedEventHandler	getKeywordMapCompleted

Detailed Description

Constructor & Destructor Documentation

com.openkm.ws.ws20.OKMSearch.OKMSearch

(

)

com.openkm.ws.ws20.OKMSearch.OKMSearch

(

String

Url

)

Member Function Documentation

new void com.openkm.ws.ws20.OKMSearch.CancelAsync

(

object

userState

)

void com.openkm.ws.ws20.OKMSearch.deleteSearch	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int	qpId
	)

void com.openkm.ws.ws20.OKMSearch.deleteSearchAsync	(	string	token,
		int	qpId
	)

void com.openkm.ws.ws20.OKMSearch.deleteSearchAsync	(	string	token,
		int	qpId,
		object	userState
	)

queryResult [] com.openkm.ws.ws20.OKMSearch.find	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @	params
	)

void com.openkm.ws.ws20.OKMSearch.findAsync	(	string	token,
		queryParams @	params
	)

void com.openkm.ws.ws20.OKMSearch.findAsync	(	string	token,
		queryParams @	params,
		object	userState
	)

queryResult [] com.openkm.ws.ws20.OKMSearch.findByContent	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	content
	)

void com.openkm.ws.ws20.OKMSearch.findByContentAsync	(	string	token,
		string	content
	)

void com.openkm.ws.ws20.OKMSearch.findByContentAsync	(	string	token,
		string	content,
		object	userState
	)

queryResult [] com.openkm.ws.ws20.OKMSearch.findByKeywords	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute("keywords", Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string[]	keywords
	)

void com.openkm.ws.ws20.OKMSearch.findByKeywordsAsync	(	string	token,
		string[]	keywords
	)

void com.openkm.ws.ws20.OKMSearch.findByKeywordsAsync	(	string	token,
		string[]	keywords,
		object	userState
	)

queryResult [] com.openkm.ws.ws20.OKMSearch.findByName	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	name
	)

void com.openkm.ws.ws20.OKMSearch.findByNameAsync	(	string	token,
		string	name
	)

void com.openkm.ws.ws20.OKMSearch.findByNameAsync	(	string	token,
		string	name,
		object	userState
	)

resultSet com.openkm.ws.ws20.OKMSearch.findMoreLikeThis	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	uuid,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int	max
	)

void com.openkm.ws.ws20.OKMSearch.findMoreLikeThisAsync	(	string	token,
		string	uuid,
		int	max
	)

void com.openkm.ws.ws20.OKMSearch.findMoreLikeThisAsync	(	string	token,
		string	uuid,
		int	max,
		object	userState
	)

resultSet com.openkm.ws.ws20.OKMSearch.findPaginated	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @	params,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int	offset,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int	limit
	)

void com.openkm.ws.ws20.OKMSearch.findPaginatedAsync	(	string	token,
		queryParams @	params,
		int	offset,
		int	limit
	)

void com.openkm.ws.ws20.OKMSearch.findPaginatedAsync	(	string	token,
		queryParams @	params,
		int	offset,
		int	limit,
		object	userState
	)

resultSet com.openkm.ws.ws20.OKMSearch.findSimpleQueryPaginated	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	statement,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int	offset,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int	limit
	)

void com.openkm.ws.ws20.OKMSearch.findSimpleQueryPaginatedAsync	(	string	token,
		string	statement,
		int	offset,
		int	limit
	)

void com.openkm.ws.ws20.OKMSearch.findSimpleQueryPaginatedAsync	(	string	token,
		string	statement,
		int	offset,
		int	limit,
		object	userState
	)

queryParams [] com.openkm.ws.ws20.OKMSearch.getAllSearchs

(

[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string

token

)

void com.openkm.ws.ws20.OKMSearch.getAllSearchsAsync

(

string

token

)

void com.openkm.ws.ws20.OKMSearch.getAllSearchsAsync	(	string	token,
		object	userState
	)

document [] com.openkm.ws.ws20.OKMSearch.getCategorizedDocuments	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	categoryId
	)

void com.openkm.ws.ws20.OKMSearch.getCategorizedDocumentsAsync	(	string	token,
		string	categoryId
	)

void com.openkm.ws.ws20.OKMSearch.getCategorizedDocumentsAsync	(	string	token,
		string	categoryId,
		object	userState
	)

integerPair [] com.openkm.ws.ws20.OKMSearch.getKeywordMap	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute("filter", Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string[]	filter
	)

void com.openkm.ws.ws20.OKMSearch.getKeywordMapAsync	(	string	token,
		string[]	filter
	)

void com.openkm.ws.ws20.OKMSearch.getKeywordMapAsync	(	string	token,
		string[]	filter,
		object	userState
	)

queryParams com.openkm.ws.ws20.OKMSearch.getSearch	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] int	qpId
	)

void com.openkm.ws.ws20.OKMSearch.getSearchAsync	(	string	token,
		int	qpId
	)

void com.openkm.ws.ws20.OKMSearch.getSearchAsync	(	string	token,
		int	qpId,
		object	userState
	)

long com.openkm.ws.ws20.OKMSearch.saveSearch	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @	params
	)

void com.openkm.ws.ws20.OKMSearch.saveSearchAsync	(	string	token,
		queryParams @	params
	)

void com.openkm.ws.ws20.OKMSearch.saveSearchAsync	(	string	token,
		queryParams @	params,
		object	userState
	)

void com.openkm.ws.ws20.OKMSearch.updateSearch	(	[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] string	token,
		[System.Xml.Serialization.XmlElementAttribute(Form=System.Xml.Schema.XmlSchemaForm.Unqualified)] queryParams @	params
	)

void com.openkm.ws.ws20.OKMSearch.updateSearchAsync	(	string	token,
		queryParams @	params
	)

void com.openkm.ws.ws20.OKMSearch.updateSearchAsync	(	string	token,
		queryParams @	params,
		object	userState
	)

Event Documentation

deleteSearchCompletedEventHandler com.openkm.ws.ws20.OKMSearch.deleteSearchCompleted

findByContentCompletedEventHandler com.openkm.ws.ws20.OKMSearch.findByContentCompleted

findByKeywordsCompletedEventHandler com.openkm.ws.ws20.OKMSearch.findByKeywordsCompleted

findByNameCompletedEventHandler com.openkm.ws.ws20.OKMSearch.findByNameCompleted

findCompletedEventHandler com.openkm.ws.ws20.OKMSearch.findCompleted

findMoreLikeThisCompletedEventHandler com.openkm.ws.ws20.OKMSearch.findMoreLikeThisCompleted

findPaginatedCompletedEventHandler com.openkm.ws.ws20.OKMSearch.findPaginatedCompleted

findSimpleQueryPaginatedCompletedEventHandler com.openkm.ws.ws20.OKMSearch.findSimpleQueryPaginatedCompleted

getAllSearchsCompletedEventHandler com.openkm.ws.ws20.OKMSearch.getAllSearchsCompleted

getCategorizedDocumentsCompletedEventHandler com.openkm.ws.ws20.OKMSearch.getCategorizedDocumentsCompleted

getKeywordMapCompletedEventHandler com.openkm.ws.ws20.OKMSearch.getKeywordMapCompleted

getSearchCompletedEventHandler com.openkm.ws.ws20.OKMSearch.getSearchCompleted

saveSearchCompletedEventHandler com.openkm.ws.ws20.OKMSearch.saveSearchCompleted

updateSearchCompletedEventHandler com.openkm.ws.ws20.OKMSearch.updateSearchCompleted

---

The documentation for this class was generated from the following file:

• OKMWebservice/com/openkm/ws/ws20/Webservice20.cs