Java Doc for ActiveSearch.java in » ERP-CRM-Financial » sakai » org » sakaiproject » citation » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.citation.api

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.citation.api .ActiveSearch

ActiveSearch
public interface ActiveSearch (Code)

Field Summary
final public static String	ADVANCED_SEARCH_TYPE
final public static String	BASIC_SEARCH_TYPE

Method Summary
public SearchQuery	getAdvancedQuery()
public SearchQuery	getBasicQuery()
public int	getFirstRecordIndex() Access the index of the first record in the current view page.
public Map	getIndex()
public int	getLastRecordIndex() Access the index of the last record in the current view page.
public Integer	getNumRecordsFetched()
public Integer	getNumRecordsFound()
public Integer	getNumRecordsMerged()
public Integer	getPageSize()
public String	getRepositoryId()
public String	getRepositoryName()
public String	getSearchId()
public CitationCollection	getSearchResults()
public Thread	getSearchThread()
public String	getSearchType()
public String	getSortBy()
public Integer	getStartRecord()
public String	getStatusMessage() Access the status message for this search.
public int	getViewPageNumber() Access the zero-based index indicating the page that was most recently accessed using the viewPage method.
public int	getViewPageSize() Access the zero-based index indicating the page that was most recently accessed using the viewPage method.
public boolean	isFirstPage()
public boolean	isLastPage()
public boolean	isNewSearch()
public void	prepareForNextPage()
public void	setAdvancedQuery(SearchQuery advancedCriteria)
public void	setBasicQuery(SearchQuery basicCriteria)
public void	setFirstPage(boolean firstPage)
public void	setIndex(Map index)
public void	setLastPage(boolean lastPage)
public void	setNewSearch(boolean newSearch)
public void	setNumRecordsFetched(Integer numRecordsFetched)
public void	setNumRecordsFound(Integer numRecordsFound)
public void	setNumRecordsMerged(Integer numRecordsMerged)
public void	setPageSize(Integer pageSize)
public void	setPageSize(String pageSize)
public void	setRepositoryName(String repositoryName)
public void	setSearchThread(Thread searchThread)
public void	setSearchType(String searchType)
public void	setSortBy(String sortBy)
public void	setStartRecord(Integer startRecord)
public void	setStartRecord(String startRecord)
public void	setStatusMessage() Set the status message for this search to null.
public void	setStatusMessage(String msg) Set the status message for this search.
public void	setViewPageSize(int size)
public List	viewPage() This method gives access to a list of citations representing the first page of output based on a predefined "page size".
public List	viewPage(int page) This method gives access to a list of citations representing a page of output based on a predefined "page size".

Field Detail

ADVANCED_SEARCH_TYPE
final public static String ADVANCED_SEARCH_TYPE(Code)

BASIC_SEARCH_TYPE
final public static String BASIC_SEARCH_TYPE(Code)

Method Detail

getAdvancedQuery
public SearchQuery getAdvancedQuery()(Code)

getBasicQuery
public SearchQuery getBasicQuery()(Code)

getFirstRecordIndex
public int getFirstRecordIndex()(Code)
	Access the index of the first record in the current view page. Record indexes start at 1.

getIndex
public Map getIndex()(Code)

getLastRecordIndex
public int getLastRecordIndex()(Code)
	Access the index of the last record in the current view page. Record indexes start at 1, and the maximum legal value equals the size() of the full search results list or start index of the next page minus 1, which is start index of the current page plus the size of the current page minus 1.

getNumRecordsFetched
public Integer getNumRecordsFetched()(Code)

getNumRecordsFound
public Integer getNumRecordsFound()(Code)

getNumRecordsMerged
public Integer getNumRecordsMerged()(Code)

getPageSize
public Integer getPageSize()(Code)

getRepositoryId
public String getRepositoryId()(Code)

getRepositoryName
public String getRepositoryName()(Code)

getSearchId
public String getSearchId()(Code)

getSearchResults
public CitationCollection getSearchResults()(Code)

getSearchThread
public Thread getSearchThread()(Code)
	Gets the thread that is handling the active search Thread that is handling this active search

getSearchType
public String getSearchType()(Code)

getSortBy
public String getSortBy()(Code)

getStartRecord
public Integer getStartRecord()(Code)

getStatusMessage
public String getStatusMessage()(Code)
	Access the status message for this search. The current status message.

getViewPageNumber
public int getViewPageNumber()(Code)
	Access the zero-based index indicating the page that was most recently accessed using the viewPage method.

getViewPageSize
public int getViewPageSize()(Code)
	Access the zero-based index indicating the page that was most recently accessed using the viewPage method.

isFirstPage
public boolean isFirstPage()(Code)
	the firstPage

isLastPage
public boolean isLastPage()(Code)
	the lastPage

isNewSearch
public boolean isNewSearch()(Code)
	the newSearch

prepareForNextPage
public void prepareForNextPage()(Code)

setAdvancedQuery
public void setAdvancedQuery(SearchQuery advancedCriteria)(Code)
	Parameters: advancedCriteria -

setBasicQuery
public void setBasicQuery(SearchQuery basicCriteria)(Code)
	Parameters: searchCriteria -

setFirstPage
public void setFirstPage(boolean firstPage)(Code)
	Parameters: firstPage -

setIndex
public void setIndex(Map index)(Code)
	Parameters: index -

setLastPage
public void setLastPage(boolean lastPage)(Code)
	Parameters: lastPage -

setNewSearch
public void setNewSearch(boolean newSearch)(Code)
	Parameters: newSearch -

setNumRecordsFetched
public void setNumRecordsFetched(Integer numRecordsFetched)(Code)
	Parameters: numRecordsFetched -

setNumRecordsFound
public void setNumRecordsFound(Integer numRecordsFound)(Code)
	Parameters: numRecordsFound -

setNumRecordsMerged
public void setNumRecordsMerged(Integer numRecordsMerged)(Code)
	Parameters: numRecordsMerged -

setPageSize
public void setPageSize(Integer pageSize)(Code)
	Parameters: pageSize -

setPageSize
public void setPageSize(String pageSize)(Code)
	Parameters: pageSize -

setRepositoryName
public void setRepositoryName(String repositoryName)(Code)
	Parameters: repositoryName -

setSearchThread
public void setSearchThread(Thread searchThread)(Code)
	Sets the thread that is handling the active search Parameters: searchThread -

setSearchType
public void setSearchType(String searchType)(Code)
	Parameters: searchType -

setSortBy
public void setSortBy(String sortBy)(Code)
	Parameters: sortBy -

setStartRecord
public void setStartRecord(Integer startRecord)(Code)
	Parameters: startRecord -

setStartRecord
public void setStartRecord(String startRecord)(Code)
	Parameters: startRecord -

setStatusMessage
public void setStatusMessage()(Code)
	Set the status message for this search to null.

setStatusMessage
public void setStatusMessage(String msg)(Code)
	Set the status message for this search. Parameters: msg - The message to set.

setViewPageSize
public void setViewPageSize(int size)(Code)
	Parameters: size -

viewPage
public List viewPage()(Code)
	This method gives access to a list of citations representing the first page of output based on a predefined "page size". In zero-based page numbering, this method returns page zero.

viewPage
public List viewPage(int page) throws SearchException(Code)
	This method gives access to a list of citations representing a page of output based on a predefined "page size". The page number is zero-based. This method can return any page that has already been accessed or the "next" page, a page that can be generated by retrieving no more than pageSize additional citations. Parameters: page - The zero-based index of the desired page. throws: SearchException - if the requested page is beyond the next page (i.e. it can't be supplied without doing more than one additional search of size pageSize.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.