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.portal.service.resource;
35
36 import java.util.Locale;
37
38 /**
39 *
40 * This interface is used to fetch the {@link IExtendableResource}. The implementations are developed in each plugins that have a {@link IExtendableResource}.
41 *
42 */
43 public interface IExtendableResourceService
44 {
45 /**
46 * Checks if is invoked.
47 *
48 * @param strResourceType
49 * the str resource type
50 * @return true, if is invoked
51 */
52 boolean isInvoked( String strResourceType );
53
54 /**
55 * Gets the resource.
56 *
57 * @param strIdResource
58 * the str id resource
59 * @param strResourceType
60 * the str resource type
61 * @return the resource
62 */
63 IExtendableResource getResource( String strIdResource, String strResourceType );
64
65 /**
66 * Gets the resource type.
67 *
68 * @return the resource type.
69 */
70 String getResourceType( );
71
72 /**
73 * Gets the description of the resource type.
74 *
75 * @param locale
76 * The locale to use
77 * @return the description of the resource type.
78 */
79 String getResourceTypeDescription( Locale locale );
80
81 /**
82 * Get the main URL to access a resource
83 *
84 * @param strIdResource
85 * The id of the resource
86 * @param strResourceType
87 * The type of a resource
88 * @return The main URL to access a resource, or null if the resource has no main URL
89 */
90 String getResourceUrl( String strIdResource, String strResourceType );
91 }