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.calendar.web;
35
36 import javax.servlet.http.HttpServletRequest;
37
38 import fr.paris.lutece.plugins.calendar.business.MultiAgenda;
39
40
41 /**
42 * This interface describes the minimum implementation for a Calendar View
43 *
44 */
45 public interface CalendarView
46 {
47 int TYPE_DAY = 0;
48 int TYPE_WEEK = 1;
49 int TYPE_MONTH = 2;
50
51 /**
52 * Returns the HTML view of the Month corresponding to the given date and displaying
53 * events of a given agenda
54 * @return The view in HTML
55 * @param options The options
56 * @param strDate The date code
57 * @param agenda An agenda
58 * @param request HttpServletRequest
59 */
60 String getCalendarView( String strDate, MultiAgenda agenda, CalendarUserOptions options, HttpServletRequest request );
61
62 /**
63 * Returns the next code date corresponding to the current view and the current date
64 * @param strDate The current date code
65 * @return The next code date
66 */
67 String getNext( String strDate );
68
69 /**
70 * Returns the previous code date corresponding to the current view and the current date
71 * @param strDate The current date code
72 * @return The previous code date
73 */
74 String getPrevious( String strDate );
75
76 /**
77 * Returns the view title
78 * @return The view title
79 * @param options The options
80 * @param strDate The current date code
81 */
82 String getTitle( String strDate, CalendarUserOptions options );
83
84 /**
85 * Returns the view path
86 * @return The view path
87 * @param options The options
88 * @param strDate The current date code
89 */
90 String getPath( String strDate, CalendarUserOptions options );
91
92 /**
93 * Returns the view type
94 * @return The view type
95 */
96 int getType( );
97 }