001/*
002 * (C) Copyright 2006-2007 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 *     Nuxeo - initial API and implementation
018 *
019 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
020 */
021
022package org.nuxeo.ecm.webapp.tree;
023
024import java.io.Serializable;
025import java.util.ArrayList;
026import java.util.List;
027
028import org.nuxeo.common.xmap.annotation.XNode;
029import org.nuxeo.common.xmap.annotation.XNodeList;
030import org.nuxeo.common.xmap.annotation.XObject;
031
032/**
033 * Plugin holding filter and sort configuration information for a document tree.
034 *
035 * @author Florent BONNET
036 * @author Anahide Tchertchian
037 */
038@XObject("treeManagerPlugin")
039public class TreeManagerPluginDescriptor implements Serializable {
040
041    private static final long serialVersionUID = 1L;
042
043    @XNode("@name")
044    protected String name;
045
046    @XNode("filterClass")
047    protected String filterClassName;
048
049    @XNode("leafFilterClass")
050    protected String leafFilterClassName;
051
052    @XNode("sorterClass")
053    protected String sorterClassName;
054
055    /**
056     * @since 5.4.2
057     */
058    @XNode("pageProvider")
059    protected String pageProvider;
060
061    @XNodeList(value = "excludedTypes/type", type = ArrayList.class, componentType = String.class)
062    protected List<String> excludedTypes;
063
064    @XNodeList(value = "excludedFacets/facet@name", type = ArrayList.class, componentType = String.class)
065    protected List<String> excludedFacets;
066
067    @XNodeList(value = "includedFacets/facet@name", type = ArrayList.class, componentType = String.class)
068    protected List<String> includedFacets;
069
070    @XNode("sortPropertyPath")
071    protected String sortPropertyPath;
072
073    public String getName() {
074        return name;
075    }
076
077    public String getFilterClassName() {
078        return filterClassName;
079    }
080
081    public String getLeafFilterClassName() {
082        return leafFilterClassName;
083    }
084
085    public String getSorterClassName() {
086        return sorterClassName;
087    }
088
089    public List<String> getExcludedTypes() {
090        return excludedTypes;
091    }
092
093    public List<String> getExcludedFacets() {
094        return excludedFacets;
095    }
096
097    public List<String> getIncludedFacets() {
098        return includedFacets;
099    }
100
101    public String getSortPropertyPath() {
102        return sortPropertyPath;
103    }
104
105    public String getPageProvider() {
106        return pageProvider;
107    }
108}