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