fr.paris.lutece.plugins.appointment.web

Class AppointmentApp

java.lang.Object

fr.paris.lutece.portal.util.mvc.xpage.MVCApplication

fr.paris.lutece.plugins.appointment.web.AppointmentApp

All Implemented Interfaces:

fr.paris.lutece.portal.web.xpages.XPageApplication, Serializable

@Controller(xpageName="appointment",
            pageTitleI18nKey="appointment.appointmentApp.defaultTitle",
            pagePathI18nKey="appointment.appointment.name")
public class AppointmentApp
extends fr.paris.lutece.portal.util.mvc.xpage.MVCApplication

This class provides a simple implementation of an Appointment XPage (On Front Office)

Author:

Laurent Payen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_DEFAULT_PAGE_TITLE Default page title of XPages of this app
static String	MESSAGE_DEFAULT_PATH Default page of XPages of this app
static String	VIEW_APPOINTMENT_CALENDAR
static String	VIEW_APPOINTMENT_FORM
protected static String	XPAGE_NAME The name of the XPage

Constructor Summary

Constructors

Constructor and Description
AppointmentApp()

Method Summary

Modifier and Type	Method and Description
fr.paris.lutece.portal.web.xpages.XPage	displayRecapAppointment(javax.servlet.http.HttpServletRequest request) Display the recap before validating an appointment
fr.paris.lutece.portal.web.xpages.XPage	doCancelAppointment(javax.servlet.http.HttpServletRequest request) Cancel an appointment
fr.paris.lutece.portal.web.xpages.XPage	doMakeAppointment(javax.servlet.http.HttpServletRequest request) Do save an appointment into the database if it is valid
fr.paris.lutece.portal.web.xpages.XPage	doValidateForm(javax.servlet.http.HttpServletRequest request) Do validate data entered by a user to fill a form
fr.paris.lutece.portal.web.xpages.XPage	getAppointmentCanceled(javax.servlet.http.HttpServletRequest request) Get the page to confirm that the appointment has been canceled
fr.paris.lutece.portal.web.xpages.XPage	getAppointmentCreated(javax.servlet.http.HttpServletRequest request) Get the page to notify the user that the appointment has been created
static String	getCancelAppointmentUrl(Appointment appointment) Get the URL
static String	getCancelAppointmentUrl(javax.servlet.http.HttpServletRequest request, Appointment appointment) Get the URL
fr.paris.lutece.portal.web.xpages.XPage	getFormList(javax.servlet.http.HttpServletRequest request) Get the view of all the forms on front office side
static String	getFormListHtml(javax.servlet.http.HttpServletRequest request, Locale locale) Get the html content of the list of forms
fr.paris.lutece.portal.web.xpages.XPage	getMyAppointments(javax.servlet.http.HttpServletRequest request) Get the page to view the appointments of a user
static String	getMyAppointmentsXPage(javax.servlet.http.HttpServletRequest request, Locale locale) Get the HTML content of the my appointment page of a user
fr.paris.lutece.portal.web.xpages.XPage	getViewAppointmentCalendar(javax.servlet.http.HttpServletRequest request) Get the calendar view
fr.paris.lutece.portal.web.xpages.XPage	getViewAppointmentForm(javax.servlet.http.HttpServletRequest request) Get the form appointment view (front office)
fr.paris.lutece.portal.web.xpages.XPage	getViewCancelAppointment(javax.servlet.http.HttpServletRequest request) Get the view for he user who wants to cancel its appointment
void	setUserInfo(javax.servlet.http.HttpServletRequest request, AppointmentDTO appointment) Set the user infos to the appointment DTO

Methods inherited from class fr.paris.lutece.portal.util.mvc.xpage.MVCApplication

addError, addError, addInfo, addInfo, addWarning, addWarning, download, download, fillCommons, getActionFullUrl, getActionUrl, getDefaultPagePath, getDefaultPageTitle, getLocale, getModel, getPage, getViewFullUrl, getViewUrl, getXPage, getXPage, getXPage, getXPage, getXPageName, populate, populate, redirect, redirect, redirect, redirect, redirectMessageBox, redirectView, responseJSON, responseXML, validateBean, validateBean

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGE_DEFAULT_PATH

public static final String MESSAGE_DEFAULT_PATH

Default page of XPages of this app

See Also:

Constant Field Values

MESSAGE_DEFAULT_PAGE_TITLE

public static final String MESSAGE_DEFAULT_PAGE_TITLE

Default page title of XPages of this app

See Also:

Constant Field Values

XPAGE_NAME

protected static final String XPAGE_NAME

The name of the XPage

See Also:

Constant Field Values

VIEW_APPOINTMENT_FORM

public static final String VIEW_APPOINTMENT_FORM

See Also:

Constant Field Values

VIEW_APPOINTMENT_CALENDAR

public static final String VIEW_APPOINTMENT_CALENDAR

See Also:

Constant Field Values

Constructor Detail

AppointmentApp

public AppointmentApp()

Method Detail

getViewAppointmentCalendar

@View(value="getViewAppointmentCalendar")
public fr.paris.lutece.portal.web.xpages.XPage getViewAppointmentCalendar(javax.servlet.http.HttpServletRequest request)

Get the calendar view

Parameters:

request -

Returns:

the Xpage

getViewAppointmentForm

@View(value="getViewAppointmentForm")
public fr.paris.lutece.portal.web.xpages.XPage getViewAppointmentForm(javax.servlet.http.HttpServletRequest request)
                                                                                                     throws fr.paris.lutece.portal.service.security.UserNotSignedException

Get the form appointment view (front office)

Parameters:

request - the request

Returns:

the xpage

Throws:

fr.paris.lutece.portal.service.security.UserNotSignedException

doValidateForm

@Action(value="doValidateForm")
public fr.paris.lutece.portal.web.xpages.XPage doValidateForm(javax.servlet.http.HttpServletRequest request)
                                                                                       throws fr.paris.lutece.portal.service.message.SiteMessageException,
                                                                                              fr.paris.lutece.portal.service.security.UserNotSignedException

Do validate data entered by a user to fill a form

Parameters:

request - The request

Returns:

The next URL to redirect to

Throws:

fr.paris.lutece.portal.service.message.SiteMessageException

fr.paris.lutece.portal.service.security.UserNotSignedException

displayRecapAppointment

@View(value="displayRecapAppointment")
public fr.paris.lutece.portal.web.xpages.XPage displayRecapAppointment(javax.servlet.http.HttpServletRequest request)
                                                                                                       throws fr.paris.lutece.portal.service.security.UserNotSignedException

Display the recap before validating an appointment

Parameters:

request - The request

Returns:

The HTML content to display or the next URL to redirect to

Throws:

fr.paris.lutece.portal.service.security.UserNotSignedException

doMakeAppointment

@Action(value="doMakeAppointment")
public fr.paris.lutece.portal.web.xpages.XPage doMakeAppointment(javax.servlet.http.HttpServletRequest request)
                                                                                             throws fr.paris.lutece.portal.service.security.UserNotSignedException

Do save an appointment into the database if it is valid

Parameters:

request - The request

Returns:

The XPage to display

Throws:

fr.paris.lutece.portal.service.security.UserNotSignedException

getAppointmentCreated

@View(value="getAppointmentCreated")
public fr.paris.lutece.portal.web.xpages.XPage getAppointmentCreated(javax.servlet.http.HttpServletRequest request)

Get the page to notify the user that the appointment has been created

Parameters:

request - The request

Returns:

The XPage to display

getFormList

@View(value="getViewFormList",
      defaultView=true)
public fr.paris.lutece.portal.web.xpages.XPage getFormList(javax.servlet.http.HttpServletRequest request)

Get the view of all the forms on front office side

Parameters:

request - the request

Returns:

the xpage

getViewCancelAppointment

@View(value="getViewCancelAppointment")
public fr.paris.lutece.portal.web.xpages.XPage getViewCancelAppointment(javax.servlet.http.HttpServletRequest request)
                                                                                                         throws fr.paris.lutece.portal.service.message.SiteMessageException

Get the view for he user who wants to cancel its appointment

Parameters:

request -

Returns:

the view

Throws:

fr.paris.lutece.portal.service.message.SiteMessageException

doCancelAppointment

@Action(value="doCancelAppointment")
public fr.paris.lutece.portal.web.xpages.XPage doCancelAppointment(javax.servlet.http.HttpServletRequest request)
                                                                                                 throws fr.paris.lutece.portal.service.message.SiteMessageException

Cancel an appointment

Parameters:

request -

Returns:

the confirmation view of the appointment cancelled

Throws:

fr.paris.lutece.portal.service.message.SiteMessageException

getAppointmentCanceled

@View(value="getAppointmentCanceled")
public fr.paris.lutece.portal.web.xpages.XPage getAppointmentCanceled(javax.servlet.http.HttpServletRequest request)

Get the page to confirm that the appointment has been canceled

Parameters:

request - The request

Returns:

The XPage to display

getMyAppointments

@View(value="getMyAppointments")
public fr.paris.lutece.portal.web.xpages.XPage getMyAppointments(javax.servlet.http.HttpServletRequest request)
                                                                                           throws fr.paris.lutece.portal.service.security.UserNotSignedException

Get the page to view the appointments of a user

Parameters:

request - The request

Returns:

The XPage to display

Throws:

fr.paris.lutece.portal.service.security.UserNotSignedException - If the authentication is enabled and the user has not signed in

getMyAppointmentsXPage

public static String getMyAppointmentsXPage(javax.servlet.http.HttpServletRequest request,
                                            Locale locale)
                                     throws fr.paris.lutece.portal.service.security.UserNotSignedException

Get the HTML content of the my appointment page of a user

Parameters:

request - The request

locale - The locale

Returns:

The HTML content, or null if the

Throws:

fr.paris.lutece.portal.service.security.UserNotSignedException - If the user has not signed in

getFormListHtml

public static String getFormListHtml(javax.servlet.http.HttpServletRequest request,
                                     Locale locale)

Get the html content of the list of forms

Parameters:

appointmentFormService - The service to use

strTitle - The title to display, or null to display the default title.

locale - The locale

Returns:

The HTML content to display

getCancelAppointmentUrl

public static String getCancelAppointmentUrl(javax.servlet.http.HttpServletRequest request,
                                             Appointment appointment)

Get the URL

Parameters:

request - Get the URL to cancel an appointment in FO

appointment - The appointment

Returns:

The URL to cancel the appointment

getCancelAppointmentUrl

public static String getCancelAppointmentUrl(Appointment appointment)

Get the URL

Parameters:

request - Get the URL to cancel an appointment in FO

appointment - The appointment

Returns:

The URL to cancel the appointment

setUserInfo

public void setUserInfo(javax.servlet.http.HttpServletRequest request,
                        AppointmentDTO appointment)

Set the user infos to the appointment DTO

Parameters:

request - the request

appointment - the appointment DTO