1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.resource.service.action;
35
36 import java.util.Locale;
37
38 /**
39 * Interface for action to apply on resources <br />
40 * IResourceAction only represents action button displayed. The content of the action should be implemented by a controller pointed by the URL of the action.
41 */
42 public interface IResourceAction
43 {
44 /**
45 * Check if the action can be performed hover a given resource
46 *
47 * @param strIdResource
48 * The id of the resource
49 * @param strResourceType
50 * The resource type
51 * @return True if the action can be performed, false otherwise
52 */
53 boolean canActionBePerformed( String strIdResource, String strResourceType );
54
55 /**
56 * Get the URL of the action to perform
57 *
58 * @param strIdResource
59 * The id of the resource
60 * @param strResourceType
61 * The resource type
62 * @return The URL of the action
63 */
64 String getActionUrl( String strIdResource, String strResourceType );
65
66 /**
67 * Get the CSS class to display the icon of the action
68 *
69 * @param strIdResource
70 * The id of the resource
71 * @param strResourceType
72 * The resource type
73 * @return the CSS class to display the icon of the action
74 */
75 String getIcon( String strIdResource, String strResourceType );
76
77 /**
78 * Get the title of the action
79 *
80 * @param strIdResource
81 * The id of the resource
82 * @param strResourceType
83 * The resource type
84 * @param locale
85 * The locale
86 * @return The title of the action
87 */
88 String getTitle( String strIdResource, String strResourceType, Locale locale );
89 }