/*
 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Nuxeo - initial API and implementation
 *
 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
 */

package org.eclipse.ecr.core.api.impl;

import java.io.Serializable;

import org.eclipse.ecr.core.api.DocumentRef;

/**
 *
 * @author <a href="mailto:dm@nuxeo.com>Dragos Mihalache</a>
 */
public class DocsQueryProviderDef implements Serializable {

    private static final long serialVersionUID = 6296251214655196508L;

    public enum DefType {
        TYPE_CHILDREN, TYPE_CHILDREN_NON_FOLDER, TYPE_CHILDREN_FOLDERS, TYPE_QUERY, TYPE_QUERY_FTS
    }

    private final DefType type;

    private DocumentRef parentRef;

    private String query;

    private String startingPath;

    // Private constructor, there are no other defs than those defined inhere.
    public DocsQueryProviderDef(DefType type) {
        this.type = type;
    }

    public DefType getType() {
        return type;
    }

    public void setParent(DocumentRef parentRef) {
        this.parentRef = parentRef;
    }

    public DocumentRef getParent() {
        return parentRef;
    }

    public String getQuery() {
        return query;
    }

    public void setQuery(String query) {
        this.query = query;
    }

    /**
     * The document models path to search within.
     */
    public String getStartingPath() {
        return startingPath;
    }

    public void setStartingPath(String startingPath) {
        this.startingPath = startingPath;
    }

}