View Javadoc
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.workflow.service.security;
35  
36  import fr.paris.lutece.portal.service.security.UserAttributesService;
37  
38  import java.util.Map;
39  
40  /**
41   *
42   * IWorkflowUserAttributesManager
43   *
44   */
45  public interface IWorkflowUserAttributesManager
46  {
47      /**
48       * Check if the UserAttributesService is enabled
49       * 
50       * @return true if the service is enabled, false otherwise
51       */
52      boolean isEnabled( );
53  
54      /**
55       * Set the UserAttributesService
56       * 
57       * @param userAttributesService
58       *            the UserAttributesService
59       */
60      void setUserAttributesService( UserAttributesService userAttributesService );
61  
62      /**
63       * Get the attribute
64       * 
65       * @param strUserId
66       *            the id user guid
67       * @param strAttribute
68       *            the attribute
69       * @return the attribute value
70       */
71      String getAttribute( String strUserId, String strAttribute );
72  
73      /**
74       * Get the attributes
75       * 
76       * @param strUserId
77       *            the user id
78       * @return a map of attribute key - attribute value
79       */
80      Map<String, String> getAttributes( String strUserId );
81  }