FavoriteResourceType


1   /*
2    *  SSL-Explorer
3    *
4    *  Copyright (C) 2003-2006 3SP LTD. All Rights Reserved
5    *
6    *  This program is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU General Public License
8    *  as published by the Free Software Foundation; either version 2 of
9    *  the License, or (at your option) any later version.
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public
16   *  License along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18   */
19              
20  package com.sslexplorer.navigation;
21  
22  import javax.servlet.http.HttpServletRequest  ;
23  
24  import com.sslexplorer.policyframework.ResourceType;
25  
26  /**
27   * Extension of {@link com.sslexplorer.policyframework.ResourceType} to be
28   * used by resources that are capable of supporting favorites.
29   * 
30   * @author Brett Smith <a HREF="mailto: brett@3sp.com">&lt;brett@3sp.com&gt;</a>
31   */
32  public interface FavoriteResourceType extends ResourceType {
33  
34      /**
35       * Create a {@link WrappedFavoriteItem} from a policy assigned favorite
36       * given its resource Id. This method should return <code>null</null> if
37       * the resource doesn't exist. This causes the favorite to be deleted. 
38       * 
39       * @param resourceId resource id
40       * @param request request
41       * @param type will be one on {@link AbstractFavoriteItem#GLOBAL_FAVORITE} or
42       *        {@link AbstractFavoriteItem#USER_FAVORITE}.
43       * @return wrapped favorite item or <code>null</code> if resource doesn't exist
44       * @throws Exception on any error
45       */
46      public WrappedFavoriteItem createWrappedFavoriteItem(int resourceId, HttpServletRequest   request, String   type) throws Exception  ;
47  
48  }
49
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags