001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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    }