01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/search/tags/sakai_2-4-1/search-api/api/src/java/org/sakaiproject/search/api/SearchStatus.java $
03: * $Id: SearchStatus.java 13426 2006-08-07 13:33:43Z ian@caret.cam.ac.uk $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.search.api;
21:
22: import java.util.List;
23:
24: /**
25: * A search status object
26: *
27: * @author ieb
28: */
29: public interface SearchStatus {
30: /**
31: * Last time the index was loaded
32: *
33: * @return
34: */
35: String getLastLoad();
36:
37: /**
38: * How long it tool to load the index
39: *
40: * @return
41: */
42: String getLoadTime();
43:
44: /**
45: * the current operational worker performing an index, none if there is none
46: * actively indexing
47: *
48: * @return
49: */
50: String getCurrentWorker();
51:
52: /**
53: * The latest expected time of completion of the current worker
54: *
55: * @return
56: */
57: String getCurrentWorkerETC();
58:
59: /**
60: * A list of all worker nodes in the cluster
61: *
62: * @return
63: */
64: List getWorkerNodes();
65:
66: /**
67: * the number of documents in the index, including those marked as deleted
68: *
69: * @return
70: */
71: String getNDocuments();
72:
73: /**
74: * get the number of documents pending to be indexed, including master
75: * items.
76: *
77: * @return
78: */
79: String getPDocuments();
80:
81: }
|