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.provider;
35
36 import fr.paris.lutece.plugins.resource.business.IResource;
37 import fr.paris.lutece.plugins.resource.business.IResourceType;
38
39 import java.util.List;
40
41 /**
42 * Interface for resource providers. Providers must be declared as Spring beans.
43 */
44 public interface IResourceProvider
45 {
46 /**
47 * Get the list of resource types managed by this provider
48 *
49 * @return The list of resource types managed by this provider
50 */
51 List<IResourceType> getResourceTypeList( );
52
53 /**
54 * Check if a resource type is managed by this provider
55 *
56 * @param strResourceTypeName
57 * The resource type
58 * @return True if the resource type is managed by this provider, false otherwise
59 */
60 boolean isResourceTypeManaged( String strResourceTypeName );
61
62 /**
63 * Get a resource. The resources is assured to be associated with this provider.
64 *
65 * @param strIdResource
66 * The id of the resource
67 * @param strResourceTypeName
68 * the resource type
69 * @return The resource, or null if no resource is associated with the given resource id and resource type for this provider
70 */
71 IResource getResource( String strIdResource, String strResourceTypeName );
72
73 /**
74 * Get the list of resources managed by this provider that have a given resource type
75 *
76 * @param strResourceTypeName
77 * The resource type
78 * @return The list of resources, or an empty list if no resource is associated with the resource type
79 */
80 List<IResource> getListResources( String strResourceTypeName );
81 }