KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > repo > webservice > repository > QuerySession


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */
17 package org.alfresco.repo.webservice.repository;
18
19 import java.io.Serializable JavaDoc;
20
21 import org.alfresco.service.cmr.repository.NodeService;
22 import org.alfresco.service.cmr.search.SearchService;
23 import org.alfresco.service.namespace.NamespaceService;
24
25 /**
26  * Interface definition for a QuerySession.
27  *
28  * @author gavinc
29  */
30 public interface QuerySession extends Serializable JavaDoc
31 {
32    /**
33     * Retrieves the id this query session can be identified as
34     *
35     * @return Id of this query session
36     */
37    public String JavaDoc getId();
38    
39    /**
40     * Returns a QueryResult object representing the next batch of results.
41     * QueryResult will contain a maximum of items as determined by the
42     * <code>fetchSize</code> element of the QueryConfiguration SOAP header.
43     *
44     * When the last batch of results is being returned the querySession of
45     * QueryResult will be null.
46     *
47     * @see org.alfresco.repo.webservice.repository.QuerySession#getId()
48     * @param searchService The SearchService to use for gathering the results
49     * @param nodeService The NodeService to use for gathering the results
50     * @param namespaceService The NamespaceService to use
51     * @return QueryResult containing the next batch of results or null if there
52     * are no more results
53     */
54    public QueryResult getNextResultsBatch(SearchService searchService, NodeService nodeService,
55                                           NamespaceService namespaceService);
56 }
57
Popular Tags