AppointmentDTO (Lutece appointment plugin 2.1.1-SNAPSHOT API)

java.lang.Object
- fr.paris.lutece.plugins.appointment.business.user.User
- - fr.paris.lutece.plugins.appointment.business.appointment.Appointment
  - - fr.paris.lutece.plugins.appointment.web.dto.AppointmentDTO

All Implemented Interfaces:

Serializable
```
public final class AppointmentDTO
extends Appointment
implements Serializable
```
The DTO for an appointment in front office

Author:

Laurent Payen

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String PROPERTY_APPOINTMENT_STATUS_RESERVED

static String PROPERTY_APPOINTMENT_STATUS_UNRESERVED
- Fields inherited from class fr.paris.lutece.plugins.appointment.business.appointment.Appointment
  APPOINTMENT_RESOURCE_TYPE

Fields
Modifier and Type	Field and Description
`static String`	`PROPERTY_APPOINTMENT_STATUS_RESERVED`
`static String`	`PROPERTY_APPOINTMENT_STATUS_UNRESERVED`

Constructor Summary

Constructors
Constructor and Description

AppointmentDTO()

Constructors
Constructor and Description
`AppointmentDTO()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearMapResponsesByIdEntry()`
`String`	`getAdminUser()` Get the name of the admin user
`static List<String>`	`getAllErrors(Locale locale)` Get all the possible errors of the form
`String`	`getDateOfTheAppointment()` Get the date of the appointment
`LocalTime`	`getEndingTime()` Get the ending time of the appointment
`int`	`getIdForm()` Get the form Id
`boolean`	`getIsCancelled()` Tell if the appointment is cancelled
`boolean`	`getIsSaved()` Returns the IsSaved
`List<fr.paris.lutece.plugins.genericattributes.business.Response>`	`getListResponse()` Get the list of the responses of the additional entries of the form
`Collection<fr.paris.lutece.plugins.workflowcore.business.action.Action>`	`getListWorkflowActions()` Get the available actions of the workflow for this appointment
`Map<Integer,List<fr.paris.lutece.plugins.genericattributes.business.Response>>`	`getMapResponsesByIdEntry()` Get the map of the responses of the additional entries of the form
`int`	`getNbBookedSeats()` Get the number of booked seats for the appointment
`int`	`getNbMaxPotentialBookedSeats()` Get the maximum number of booked seats the user can take
`LocalDateTime`	`getStartingDateTime()` Get the starting date time of the appointment
`LocalTime`	`getStartingTime()` Get the starting time of the appointment
`fr.paris.lutece.plugins.workflowcore.business.state.State`	`getState()` Get the state of the appointment
`void`	`setAdminUser(String strAdminUser)` Set the name of the admin user
`void`	`setDateOfTheAppointment(String strDateOfTheAppointment)` Set the date of the appointment
`void`	`setEndingTime(LocalTime endingTime)` Set the ending time of the appointment
`void`	`setIdForm(int nIdForm)` Set the Form Id
`void`	`setIsCancelled(boolean isCancelled)` Set if the appointment is cancelled
`void`	`setIsSaved(boolean bIsSaved)` Sets the IsSaved
`void`	`setListResponse(List<fr.paris.lutece.plugins.genericattributes.business.Response> listResponse)` Set the list of the responses of the additional entries of the form
`void`	`setListWorkflowActions(Collection<fr.paris.lutece.plugins.workflowcore.business.action.Action> listWorkflowActions)` Set the available actions of the workflow for this appointment
`void`	`setMapResponsesByIdEntry(Map<Integer,List<fr.paris.lutece.plugins.genericattributes.business.Response>> mapResponsesByIdEntry)` Set the map of the responses of the addtional entries of the form to the appointment
`void`	`setNbBookedSeats(int nNumberOfPlacesReserved)` Set the number of booked seats for the appointment
`void`	`setNbMaxPotentialBookedSeats(int nNbMaxPotentialBookedSeats)` Set the maximum number of booked seats the user can take
`void`	`setStartingDateTime(LocalDateTime startingDateTime)` Set the starting date time of the appointment
`void`	`setStartingTime(LocalTime startingTime)` Set the starting time of the appointment
`void`	`setState(fr.paris.lutece.plugins.workflowcore.business.state.State state)` Set the state of the appointment

Methods inherited from class fr.paris.lutece.plugins.appointment.business.appointment.Appointment
getAdminUserCreate, getAppointmentTakenSqlDate, getDateAppointmentTaken, getIdActionCancelled, getIdAdminUser, getIdAppointment, getIdSlot, getIdUser, getNbPlaces, getNotification, getReference, getSlot, getUser, setAdminUserCreate, setAppointmentTakenSqlDate, setDateAppointmentTaken, setIdActionCancelled, setIdAdminUser, setIdAppointment, setIdSlot, setIdUser, setNbPlaces, setNotification, setReference, setSlot, setUser

Methods inherited from class fr.paris.lutece.plugins.appointment.business.user.User
getAppointments, getEmail, getFirstName, getGuid, getLastName, getPhoneNumber, setAppointments, setEmail, setFirstName, setGuid, setLastName, setPhoneNumber

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPERTY_APPOINTMENT_STATUS_UNRESERVED
```
public static final String PROPERTY_APPOINTMENT_STATUS_UNRESERVED
```
    See Also:
    
    Constant Field Values
  - PROPERTY_APPOINTMENT_STATUS_RESERVED
```
public static final String PROPERTY_APPOINTMENT_STATUS_RESERVED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AppointmentDTO
```
public AppointmentDTO()
```
- Method Detail
  - getAdminUser
```
public String getAdminUser()
```
    Get the name of the admin user
    
    Returns:
    
    the admin user name
  - setAdminUser
```
public void setAdminUser(String strAdminUser)
```
    Set the name of the admin user
    
    Parameters:
    
    _strAdminUser - the admin user name to set
  - getState
```
public fr.paris.lutece.plugins.workflowcore.business.state.State getState()
```
    Get the state of the appointment
    
    Returns:
    
    the state of the appointment
  - setState
```
public void setState(fr.paris.lutece.plugins.workflowcore.business.state.State state)
```
    Set the state of the appointment
    
    Parameters:
    
    state - the state to set
  - getStartingDateTime
```
public LocalDateTime getStartingDateTime()
```
    Get the starting date time of the appointment
    
    Returns:
    
    the starting date time
  - setStartingDateTime
```
public void setStartingDateTime(LocalDateTime startingDateTime)
```
    Set the starting date time of the appointment
    
    Parameters:
    
    startingDateTime - the starting date time
  - getStartingTime
```
public LocalTime getStartingTime()
```
    Get the starting time of the appointment
    
    Returns:
    
    the starting time
  - setStartingTime
```
public void setStartingTime(LocalTime startingTime)
```
    Set the starting time of the appointment
    
    Parameters:
    
    startingTime - the starting time to set
  - getEndingTime
```
public LocalTime getEndingTime()
```
    Get the ending time of the appointment
    
    Returns:
    
    the ending time
  - setEndingTime
```
public void setEndingTime(LocalTime endingTime)
```
    Set the ending time of the appointment
    
    Parameters:
    
    endingTime - the ending time
  - getIsCancelled
```
public boolean getIsCancelled()
```
    Tell if the appointment is cancelled
    
    Overrides:
    
    getIsCancelled in class Appointment
    
    Returns:
    
    true if the appointment is cancelled
  - setIsCancelled
```
public void setIsCancelled(boolean isCancelled)
```
    Set if the appointment is cancelled
    
    Overrides:
    
    setIsCancelled in class Appointment
    
    Parameters:
    
    isCancelled - the boolean value
  - getDateOfTheAppointment
```
public String getDateOfTheAppointment()
```
    Get the date of the appointment
    
    Returns:
    
    the date of the appointment
  - setDateOfTheAppointment
```
public void setDateOfTheAppointment(String strDateOfTheAppointment)
```
    Set the date of the appointment
    
    Parameters:
    
    strDateOfTheAppointment - the date to set
  - getListResponse
```
public List<fr.paris.lutece.plugins.genericattributes.business.Response> getListResponse()
```
    Get the list of the responses of the additional entries of the form
    
    Returns:
    
    the list of the responses
  - setListResponse
```
public void setListResponse(List<fr.paris.lutece.plugins.genericattributes.business.Response> listResponse)
```
    Set the list of the responses of the additional entries of the form
    
    Parameters:
    
    listResponse - the list of the responses to set
  - getIdForm
```
public int getIdForm()
```
    Get the form Id
    
    Returns:
    
    the form Id
  - setIdForm
```
public void setIdForm(int nIdForm)
```
    Set the Form Id
    
    Parameters:
    
    nIdForm - the form Id to set
  - getNbBookedSeats
```
public int getNbBookedSeats()
```
    Get the number of booked seats for the appointment
    
    Returns:
    
    the number of booked seats
  - setNbBookedSeats
```
public void setNbBookedSeats(int nNumberOfPlacesReserved)
```
    Set the number of booked seats for the appointment
    
    Parameters:
    
    nNumberOfPlacesReserved - the number to set
  - getNbMaxPotentialBookedSeats
```
public int getNbMaxPotentialBookedSeats()
```
    Get the maximum number of booked seats the user can take
    
    Returns:
    
    the max number of booked seats
  - setNbMaxPotentialBookedSeats
```
public void setNbMaxPotentialBookedSeats(int nNbMaxPotentialBookedSeats)
```
    Set the maximum number of booked seats the user can take
    
    Parameters:
    
    nNbMaxPotentialBookedSeats - the maximum number to set
  - getListWorkflowActions
```
public Collection<fr.paris.lutece.plugins.workflowcore.business.action.Action> getListWorkflowActions()
```
    Get the available actions of the workflow for this appointment
    
    Returns:
    
    the actions
  - setListWorkflowActions
```
public void setListWorkflowActions(Collection<fr.paris.lutece.plugins.workflowcore.business.action.Action> listWorkflowActions)
```
    Set the available actions of the workflow for this appointment
    
    Parameters:
    
    listWorkflowActions -
  - getMapResponsesByIdEntry
```
public Map<Integer,List<fr.paris.lutece.plugins.genericattributes.business.Response>> getMapResponsesByIdEntry()
```
    Get the map of the responses of the additional entries of the form
    
    Returns:
    
    the map of the responses
  - setMapResponsesByIdEntry
```
public void setMapResponsesByIdEntry(Map<Integer,List<fr.paris.lutece.plugins.genericattributes.business.Response>> mapResponsesByIdEntry)
```
    Set the map of the responses of the addtional entries of the form to the appointment
    
    Parameters:
    
    mapResponsesByIdEntry - the map to set
  - clearMapResponsesByIdEntry
```
public void clearMapResponsesByIdEntry()
```
  - getIsSaved
```
public boolean getIsSaved()
```
    Returns the IsSaved
    
    Returns:
    
    The IsSaved
  - setIsSaved
```
public void setIsSaved(boolean bIsSaved)
```
    Sets the IsSaved
    
    Parameters:
    
    bIsSaved - The IsSaved
  - getAllErrors
```
public static List<String> getAllErrors(Locale locale)
```
    Get all the possible errors of the form
    
    Parameters:
    
    locale - the locale
    
    Returns:
    
    a list of all the possible errors of the form

Class AppointmentDTO

Field Summary

Fields inherited from class fr.paris.lutece.plugins.appointment.business.appointment.Appointment

Constructor Summary

Method Summary

Methods inherited from class fr.paris.lutece.plugins.appointment.business.appointment.Appointment

Methods inherited from class fr.paris.lutece.plugins.appointment.business.user.User

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_APPOINTMENT_STATUS_UNRESERVED

PROPERTY_APPOINTMENT_STATUS_RESERVED

Constructor Detail

AppointmentDTO

Method Detail

getAdminUser

setAdminUser

getState

setState

getStartingDateTime

setStartingDateTime

getStartingTime

setStartingTime

getEndingTime

setEndingTime

getIsCancelled

setIsCancelled

getDateOfTheAppointment

setDateOfTheAppointment

getListResponse

setListResponse

getIdForm

setIdForm

getNbBookedSeats

setNbBookedSeats

getNbMaxPotentialBookedSeats

setNbMaxPotentialBookedSeats

getListWorkflowActions

setListWorkflowActions

getMapResponsesByIdEntry

setMapResponsesByIdEntry

clearMapResponsesByIdEntry

getIsSaved

setIsSaved

getAllErrors