001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.core.operations.document;
020
021import org.nuxeo.ecm.automation.core.Constants;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.automation.core.annotations.Param;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.core.api.DocumentModelList;
028import org.nuxeo.ecm.core.query.sql.NXQL;
029
030/**
031 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
032 * @deprecated Since 6.0, document query operation logic has been moved. This class is not used/registered anymore into
033 *             the platform as Automation Operation. Replaced by
034 *             {@link org.nuxeo.ecm.automation.core.operations .services.query.DocumentPaginatedQuery}.
035 */
036@Deprecated
037@Operation(id = Query.ID, category = Constants.CAT_FETCH, label = "Query", description = "Perform a query on the repository. The query result "
038        + "will become the input for the next operation.", addToStudio = false, deprecatedSince = "6.0")
039public class Query {
040
041    public static final String ID = "Document.Query";
042
043    @Context
044    protected CoreSession session;
045
046    @Param(name = "query")
047    protected String query;
048
049    @Param(name = "language", required = false, widget = Constants.W_OPTION, values = { NXQL.NXQL, "CMISQL" })
050    protected String lang = NXQL.NXQL;
051
052    @OperationMethod
053    public DocumentModelList run() {
054        return session.query(query, lang, null, 0, 0, false);
055    }
056
057}