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 /**
37 *
38 * This interface represents resources that are eligible to the extend functionalities.
39 *
40 */
41 public interface IExtendableResource
42 {
43 /**
44 * Gets the id.
45 *
46 * @return The id
47 */
48 String getIdExtendableResource( );
49
50 /**
51 * Gets the resource type.
52 *
53 * @return The resource type
54 */
55 String getExtendableResourceType( );
56
57 /**
58 * Gets the name.
59 *
60 * @return The name
61 */
62 String getExtendableResourceName( );
63
64 /**
65 * Gets the name.
66 *
67 * @return The name
68 */
69 String getExtendableResourceDescription( );
70
71 /**
72 * Gets the URL of the image describing the resource. If the given URL does NOT starts with <i>http://</i>, then the base URL will be prefixed.
73 *
74 * @return The URL of the image describing the resource, or null if not image is associated to this resource
75 */
76 String getExtendableResourceImageUrl( );
77 }