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