EAppointmentBookingError (FORMCYCLE: BOM 6.6.0 API)

java.lang.Object
- java.lang.Enum<EAppointmentBookingError>
- - de.xima.fc.appointment.EAppointmentBookingError

All Implemented Interfaces:

INamedUiElement, Serializable, Comparable<EAppointmentBookingError>
```
public enum EAppointmentBookingError
extends Enum<EAppointmentBookingError>
implements INamedUiElement
```
An enumeration of the possible errors that may occur when booking an appointment.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPOINTMENT_ALREADY_CANCELED` The action could not be performed because the appointment was already canceled.
`APPOINTMENT_ALREADY_CREATED` The appointment cannot be created (booked) because it exists already.
`APPOINTMENT_DOES_NOT_EXIST` The appointment cannot be moved or cancelled because it is not persisted.
`APPOINTMENT_NOT_FOUND` The appointment could not be found via the given UUID.
`DATABASE_ERROR` A general database error did occur.
`DISALLOWED_DURATION` The action could not be performed because the appointment's duration is not valid, i.e. because it is different than the duration defined by the appointment type.
`GENERAL` An unexpected error occured that cannot be classified any further.
`INVALID_DURATION` The action could not be performed because the appointment's duration is not valid. i.e. because the duration is infinite, zero, or negative.
`MAXIMUM_ADVANCE_BOOKING_EXCEEDED` The appointment cannot be booked or moved because it lies after the maximum allowed advance booking (prebook) duration..
`MINIMUM_BOOKING_NOTICE_EXCEEDED` The appointment cannot be booked or moved because it lies too close to the current server time.
`NO_APPOINTMENT_GIVEN` No appointment (UUID) was specified.
`NO_FREE_SLOT_AVAILABLE` The appointment cannot be booked or moved because no more free slots are available at the desired date.
`OUTSIDE_GRID` The appointment cannot be booked or moved because it lies outside the grid defined by the template.
`OUTSIDE_SLOTS` The appointment cannot be booked or moved because it lies outside the normal opening hours.
`WITHIN_CLOSING_TIME` The appointment cannot be booked or moved because it lies within the pre-defined closing times.

Field Summary
- Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
  ATTR_DISPLAY_NAME

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDisplayName(Locale locale)`
`static EAppointmentBookingError`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EAppointmentBookingError[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - APPOINTMENT_ALREADY_CANCELED
```
public static final EAppointmentBookingError APPOINTMENT_ALREADY_CANCELED
```
    The action could not be performed because the appointment was already canceled.
  - APPOINTMENT_ALREADY_CREATED
```
public static final EAppointmentBookingError APPOINTMENT_ALREADY_CREATED
```
    The appointment cannot be created (booked) because it exists already.
  - APPOINTMENT_DOES_NOT_EXIST
```
public static final EAppointmentBookingError APPOINTMENT_DOES_NOT_EXIST
```
    The appointment cannot be moved or cancelled because it is not persisted.
  - APPOINTMENT_NOT_FOUND
```
public static final EAppointmentBookingError APPOINTMENT_NOT_FOUND
```
    The appointment could not be found via the given UUID.
  - DATABASE_ERROR
```
public static final EAppointmentBookingError DATABASE_ERROR
```
    A general database error did occur.
  - DISALLOWED_DURATION
```
public static final EAppointmentBookingError DISALLOWED_DURATION
```
    The action could not be performed because the appointment's duration is not valid, i.e. because it is different than the duration defined by the appointment type.
  - GENERAL
```
public static final EAppointmentBookingError GENERAL
```
    An unexpected error occured that cannot be classified any further.
  - INVALID_DURATION
```
public static final EAppointmentBookingError INVALID_DURATION
```
    The action could not be performed because the appointment's duration is not valid. i.e. because the duration is infinite, zero, or negative.
  - MAXIMUM_ADVANCE_BOOKING_EXCEEDED
```
public static final EAppointmentBookingError MAXIMUM_ADVANCE_BOOKING_EXCEEDED
```
    The appointment cannot be booked or moved because it lies after the maximum allowed advance booking (prebook) duration..
  - MINIMUM_BOOKING_NOTICE_EXCEEDED
```
public static final EAppointmentBookingError MINIMUM_BOOKING_NOTICE_EXCEEDED
```
    The appointment cannot be booked or moved because it lies too close to the current server time.
  - NO_APPOINTMENT_GIVEN
```
public static final EAppointmentBookingError NO_APPOINTMENT_GIVEN
```
    No appointment (UUID) was specified.
  - NO_FREE_SLOT_AVAILABLE
```
public static final EAppointmentBookingError NO_FREE_SLOT_AVAILABLE
```
    The appointment cannot be booked or moved because no more free slots are available at the desired date.
  - OUTSIDE_GRID
```
public static final EAppointmentBookingError OUTSIDE_GRID
```
    The appointment cannot be booked or moved because it lies outside the grid defined by the template.
  - OUTSIDE_SLOTS
```
public static final EAppointmentBookingError OUTSIDE_SLOTS
```
    The appointment cannot be booked or moved because it lies outside the normal opening hours.
  - WITHIN_CLOSING_TIME
```
public static final EAppointmentBookingError WITHIN_CLOSING_TIME
```
    The appointment cannot be booked or moved because it lies within the pre-defined closing times.
- Method Detail
  - values
```
public static EAppointmentBookingError[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EAppointmentBookingError c : EAppointmentBookingError.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EAppointmentBookingError valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getDisplayName
```
public String getDisplayName(Locale locale)
```
    Specified by:
    
    getDisplayName in interface INamedUiElement
    
    Returns:
    
    Wert, der das entsprechende Objekt an Oberfläche repräsentiert (wird i.A. zur Laufzeit ermittelt).

Enum EAppointmentBookingError

Enum Constant Summary

Field Summary

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APPOINTMENT_ALREADY_CANCELED

APPOINTMENT_ALREADY_CREATED

APPOINTMENT_DOES_NOT_EXIST

APPOINTMENT_NOT_FOUND

DATABASE_ERROR

DISALLOWED_DURATION

GENERAL

INVALID_DURATION

MAXIMUM_ADVANCE_BOOKING_EXCEEDED

MINIMUM_BOOKING_NOTICE_EXCEEDED

NO_APPOINTMENT_GIVEN

NO_FREE_SLOT_AVAILABLE

OUTSIDE_GRID

OUTSIDE_SLOTS

WITHIN_CLOSING_TIME

Method Detail

values

valueOf

getDisplayName