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.plugins.crmclient.business;
35
36 import java.io.Serializable;
37
38 import java.util.Map;
39
40
41 /**
42 *
43 * ICRMItem
44 *
45 */
46 public interface ICRMItem extends Serializable
47 {
48 // Keys
49 String NOTIFICATION_OBJECT = "notification_object";
50 String NOTIFICATION_MESSAGE = "notification_message";
51 String NOTIFICATION_SENDER = "notification_sender";
52 String ID_DEMAND = "id_demand";
53 String STATUS_TEXT = "status_text";
54 String ID_DEMAND_TYPE = "id_demand_type";
55 String USER_GUID = "user_guid";
56 String ID_STATUS_CRM = "id_status_crm";
57 String ID_CRM_USER = "id_crm_user";
58 String DEMAND_DATA = "demand_data";
59 String USER_ATTRIBUTE = "attribute";
60 String MEDIA_TYPE = "media_type";
61
62 /**
63 * Get the url for WS
64 * @return the url for WS
65 */
66 String getUrlForWS( );
67
68 /**
69 * Set the parameters of the crm item
70 * @param mapParameters the parameters
71 */
72 void setParameters( Map<String, String> mapParameters );
73
74 /**
75 * Get the parameters
76 * @return the parameters
77 */
78 Map<String, String> getParameters( );
79
80 /**
81 * @return strCRMWebAppBaseURL the CRM webapp URL
82 */
83 String getCRMWebAppBaseURL( );
84
85 /**
86 * Put a new parameter to the map parameters
87 * @param strKey the key of the parameter
88 * @param strValue the value of the parameter
89 */
90 void putParameter( String strKey, String strValue );
91
92 /**
93 * the CRM web app Code
94 * @return the CRM web app Code
95 */
96 String getCRMWebAppCode( );
97
98 /**
99 * set the CRM web app code
100 * @param _strmCRMWebAppCode the CRM web app code
101 */
102 void setCRMWebAppCode( String _strmCRMWebAppCode );
103 }