001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.util;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.util.TreeView;
020    import com.liferay.portal.model.LayoutTypePortlet;
021    import com.liferay.portal.model.User;
022    
023    import javax.servlet.ServletContext;
024    
025    /**
026     * @author Jorge Ferrer
027     * @author Dennis Ju
028     * @author Brian Wing Shun Chan
029     */
030    public interface PortletLister {
031    
032            public TreeView getTreeView() throws PortalException, SystemException;
033    
034            public void setIncludeInstanceablePortlets(
035                    boolean includeInstanceablePortlets);
036    
037            public void setIteratePortlets(boolean iteratePortlets);
038    
039            public void setLayoutTypePortlet(LayoutTypePortlet layoutTypePortlet);
040    
041            public void setRootNodeName(String rootNodeName);
042    
043            public void setServletContext(ServletContext servletContext);
044    
045            public void setUser(User user);
046    
047    }