NotificationSendingState (MyTISM API Documentation)

java.lang.Object
- java.lang.Enum<NotificationSendingState>
- - de.ipcon.db.notification.NotificationSendingState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NotificationSendingState>
```
public enum NotificationSendingState
extends java.lang.Enum<NotificationSendingState>
```
Represents the state of a notification sending process.
This enum defines the various states that a notification can be in during the sending process. Each state provides information about whether the notification was sent successfully, if it should be retried, and a human-readable description of the state.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`FAILED_ULTIMATELY` The state of a notification that has failed to send to all (mandatory) receivers' addresses and should not be retried (handling is finished).
`IN_SENDING_PROCESS` The state of a notification that is currently being sent.
`ONLY_PARTIALLY_SENT` The state of a notification for which sending was successful for a subset of the receivers' (mandatory) addresses, but ultimately failed for other (mandatory) addresses and handling is finished.
`SUCCESSFULLY_SENT` The state of a notification that has been successfully sent to all (mandatory) receivers' addresses and handling is finished.
`TO_BE_RETRIED_NOW` The state of a notification for which sending should be attempted as soon as the notification system can do that.
`TO_BE_SENT_INITIALLY` The initial state of a notification before any sending attempts have been made.
`WAITING_FOR_RETRY` The state of a notification that has failed to send to at least one receivers' address and should be retried later.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static NotificationSendingState`	`fromCode(int code)` Returns the state corresponding to the given code.
`static java.util.Collection<NotificationSendingState>`	`getAllStates()`
`int`	`getCode()` Returns the code associated with this state.
`java.lang.String`	`getDescription()` Returns a human-readable description of this state.
`boolean`	`isFailedUltimately()`
`boolean`	`isInSendingProcess()`
`boolean`	`isOnlyPartiallySent()`
`boolean`	`isSuccessfullySent()`
`boolean`	`isToBeRetriedNow()`
`boolean`	`isToBeSentInitially()`
`boolean`	`isWaitingForRetry()`
`boolean`	`meansHandlingFinishedFinally()`
`boolean`	`meansHandlingFinishedForCurrentRun()`
`boolean`	`stillNeedsToBeSentOut()`
`java.lang.String`	`toString()` Returns a string representation of this state.
`static NotificationSendingState`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static NotificationSendingState[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

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

- Enum Constant Detail
  - TO_BE_SENT_INITIALLY
```
public static final NotificationSendingState TO_BE_SENT_INITIALLY
```
    The initial state of a notification before any sending attempts have been made.
  - IN_SENDING_PROCESS
```
public static final NotificationSendingState IN_SENDING_PROCESS
```
    The state of a notification that is currently being sent.
  - WAITING_FOR_RETRY
```
public static final NotificationSendingState WAITING_FOR_RETRY
```
    The state of a notification that has failed to send to at least one receivers' address and should be retried later.
  - SUCCESSFULLY_SENT
```
public static final NotificationSendingState SUCCESSFULLY_SENT
```
    The state of a notification that has been successfully sent to all (mandatory) receivers' addresses and handling is finished. Includes case "Successfully sent to all mandatory addresses, at least one optional address failed", at least for now.
  - FAILED_ULTIMATELY
```
public static final NotificationSendingState FAILED_ULTIMATELY
```
    The state of a notification that has failed to send to all (mandatory) receivers' addresses and should not be retried (handling is finished).
  - TO_BE_RETRIED_NOW
```
public static final NotificationSendingState TO_BE_RETRIED_NOW
```
    The state of a notification for which sending should be attempted as soon as the notification system can do that.
  - ONLY_PARTIALLY_SENT
```
public static final NotificationSendingState ONLY_PARTIALLY_SENT
```
    The state of a notification for which sending was successful for a subset of the receivers' (mandatory) addresses, but ultimately failed for other (mandatory) addresses and handling is finished.
- Method Detail
  - values
```
public static NotificationSendingState[] 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 (NotificationSendingState c : NotificationSendingState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static NotificationSendingState valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - fromCode
```
public static NotificationSendingState fromCode(int code)
```
    Returns the state corresponding to the given code.
    
    Parameters:
    
    code - The code of the state.
    
    Returns:
    
    The corresponding NotificationSendingState.
    
    Throws:
    
    java.lang.IllegalArgumentException - if no state matches the code.
  - getAllStates
```
public static java.util.Collection<NotificationSendingState> getAllStates()
```
  - getCode
```
public int getCode()
```
    Returns the code associated with this state.
    
    Returns:
    
    The code of this state.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns a human-readable description of this state.
    
    Returns:
    
    The description of this state.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this state.
    
    Overrides:
    
    toString in class java.lang.Enum<NotificationSendingState>
    
    Returns:
    
    The description of this state.
  - meansHandlingFinishedForCurrentRun
```
public boolean meansHandlingFinishedForCurrentRun()
```
  - meansHandlingFinishedFinally
```
public boolean meansHandlingFinishedFinally()
```
  - stillNeedsToBeSentOut
```
public boolean stillNeedsToBeSentOut()
```
  - isToBeSentInitially
```
public boolean isToBeSentInitially()
```
  - isInSendingProcess
```
public boolean isInSendingProcess()
```
  - isWaitingForRetry
```
public boolean isWaitingForRetry()
```
  - isSuccessfullySent
```
public boolean isSuccessfullySent()
```
  - isFailedUltimately
```
public boolean isFailedUltimately()
```
  - isToBeRetriedNow
```
public boolean isToBeRetriedNow()
```
  - isOnlyPartiallySent
```
public boolean isOnlyPartiallySent()
```

Enum NotificationSendingState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TO_BE_SENT_INITIALLY

IN_SENDING_PROCESS

WAITING_FOR_RETRY

SUCCESSFULLY_SENT

FAILED_ULTIMATELY

TO_BE_RETRIED_NOW

ONLY_PARTIALLY_SENT

Method Detail

values

valueOf

fromCode

getAllStates

getCode

getDescription

toString

meansHandlingFinishedForCurrentRun

meansHandlingFinishedFinally

stillNeedsToBeSentOut

isToBeSentInitially

isInSendingProcess

isWaitingForRetry

isSuccessfullySent

isFailedUltimately

isToBeRetriedNow

isOnlyPartiallySent