Merged V2.1 to HEAD

6515: Fix for AWC-1362 (system error page when clicking on space that doesn't exist in navigator)
   6516: Fix for AR-1688 - Vista
   6518: Fix for AWC-1479, AWC-1199 and AWC-426 (javascript insertion into forum posts security related fixes) limit to subset of safe tags for posting
   6519: Fix AR-1690 Web Scripts url.args is missing even though it's documented in WIKI
   6520: Fix for AWC-1271 (component generator config ignored for associations)
   6521: Fix AWC-1492 Some included javascript files in template/webscripts use the wrong app context path i.e. /alfresco when the app is called /alfzip
   6522: Build fix
   6523: - Fix rendering of tasks with no description in office portlets
   6524: Added thread pool for index merging (AR-1633, AR-1579)
   6525: One more fix for rendering of tasks with no description in office portlets
   6527: Renamed axis jar to reflect version number.
   6528: WebServices query cache refactoring


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@6741 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/webservice/QuerySession.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.webservice;
+
+import java.io.Serializable;
+
+import org.alfresco.service.ServiceRegistry;
+
+/**
+ * An interface for objects that track the query and its results.  The only commonality between
+ * the different types of results used in the WebServices return values is that they are
+ * Serializable.
+ * 
+ * @author Derek Hulley
+ */
+public interface QuerySession<RESULTSET> extends Serializable
+{
+    /**
+     * Retrieves the id this query session can be identified as
+     * 
+     * @return Id of this query session
+     */
+    public String getId();
+    
+    /**
+     * Check if the session is expecting more results.  This will be <tt>false</tt> if the
+     * cursor previously passed the end of a given set of results.
+     */
+    public boolean haveMoreResults();
+
+    /**
+     * Get the next batch of results from the full set of available results.  If there are no results
+     * available, then this session must go and fetch them.  It is up to the implementation to provide
+     * a means for this to occur.
+     *
+     * @param serviceRegistry
+     *      the services to perform a query
+     * @param allResults
+     *      All available results.  It may be necessary to requery to get the results.
+     * @return
+     *      Returns the next batch of results based on the maximum fetch size.  If there are no
+     *      more results, the resultset will be empty.
+     */
+    public RESULTSET getNextResults(ServiceRegistry serviceRegistry);
+}