Skip to main content
summaryrefslogtreecommitdiffstats
blob: 24dfc31384e897c36d4006b47996e52bb1d2dadb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*******************************************************************************
 * Copyright (c) 2003 - 2005 University Of British Columbia and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     University Of British Columbia - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylar.bugzilla.search;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;

/**
 * Interface for the bugzilla search result collector.
 * @author sminto
 */
public interface IBugzillaSearchResultCollector
{

	/**
	 * Called before the actual search starts
	 * @param startCount - The starting count for the number of matches
	 * @throws CoreException
	 */
	public void aboutToStart(int startCount) throws CoreException;
	
	/**
	 * Accept a search hit and add it as a match and set the markers
	 * @param hit The search hit that was a match
	 * @throws CoreException
	 */
	public void accept(BugzillaSearchHit hit) throws CoreException;
	
	/**
	 * Called when the search has ended.
	 */
	public void done();
	
	/**
	 * Get the progress monitor for the search
	 * @return The progress monitor
	 */
	public IProgressMonitor getProgressMonitor();
	
	/**
	 * Set the progress monitor
	 * @param monitor The progress monitor the search should use
	 */
	public void setProgressMonitor(IProgressMonitor monitor);
	
	/**
	 * Set the current search operation
	 * @param operation The operation to set the search to
	 */
	public void setOperation(IBugzillaSearchOperation operation);
	
	/**
	 * Get the current operation
	 * @return The current search operation
	 */
	public IBugzillaSearchOperation getOperation();
}

Back to the top