Derek Hulley 2be73ece54 Merged DEV/SWIFT to HEAD
25927: (RECORD ONLY) Initial work on a Data List spreadsheet exporter. Needs more work in another iDay, but the basics are in place
   25938: (RECORD ONLY) Move the Data List Export Webscript to a dev branch for now
   25944: Added copyright notices
          Enhancements to SOLR remote api client library
          - get node text content transform status and exception
   25945: Removed superfluous file
   25952: ALF-7339: SOLR 020 Index track and build from SOLR
          - WIP - tracking transactions (accounting for holes), Adding and removing leaf docs with ID only, tracker status reporting via admin update handler
   25953: ALF-7339: SOLR 020 Index track and build from SOLR
          - WIP - compile fix
   25976: Query related build fixes (mixture of collateral damage from SOLR and OpenCMIS)


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@28117 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2011-05-30 20:21:29 +00:00

89 lines
3.2 KiB
Java

/*
* Copyright (C) 2005-2011 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.solr;
import java.util.List;
import org.alfresco.repo.domain.node.Node;
/**
* DAO support for SOLR web scripts.
*
* @since 4.0
*/
// TODO - permit shortened form of QNames for e.g. aspects i.e. cm:content vs {http://www.alfresco.org/model/content/1.0}content?
public interface SOLRDAO
{
/**
* Get the transactions from either minTxnId or fromCommitTime, optionally limited to maxResults
*
* @param minTxnId greater than or equal to minTxnId
* @param fromCommitTime greater than or equal to transaction commit time
* @param maxResults limit the results. 0 or Integer.MAX_VALUE does not limit the results
* @return list of transactions
*/
public List<Transaction> getTransactions(Long minTxnId, Long fromCommitTime, int maxResults);
/**
* Get the nodes satisfying the constraints in nodeParameters
*
* @param nodeParameters set of constraints for which nodes to return
* @param maxResults limit the results. 0 or Integer.MAX_VALUE does not limit the results
* @param callback a callback to receive the results
*/
public void getNodes(NodeParameters nodeParameters, NodeQueryCallback callback);
/**
* Returns metadata for a set of node ids
*
* @param nodeIds a set of nodeIds for which to return node metadata
* @param maxResults limit the results. 0 or Integer.MAX_VALUE does not limit the results
* @param callback a callback to receive the results
*/
public void getNodesMetadata(NodeMetaDataParameters nodeMetaDataParameters, MetaDataResultsFilter resultFilter, NodeMetaDataQueryCallback callback);
/**
* The interface that will be used to give query results to the calling code.
*/
public static interface NodeQueryCallback
{
/**
* Handle a node.
*
* @param node the node
* @return Return <tt>true</tt> to continue processing rows or <tt>false</tt> to stop
*/
boolean handleNode(Node node);
}
/**
* The interface that will be used to give query results to the calling code.
*/
public static interface NodeMetaDataQueryCallback
{
/**
* Handle a node.
*
* @param node the node meta data
* @return Return <tt>true</tt> to continue processing rows or <tt>false</tt> to stop
*/
boolean handleNodeMetaData(NodeMetaData nodeMetaData);
}
}