ComponentInstanceManualUserNotification (Silverpeas Core 6.3 API)

All Known Implementing Classes:

AbstractCalendarInstanceManualUserNotification, AbstractComponentInstanceManualUserNotification, UserCalendarInstanceManualUserNotification, UserNotificationInstanceManualUserNotification
```
public interface ComponentInstanceManualUserNotification
```
This interface provides the initialization of a manual UserNotification from a NotificationContext.

Each component dealing with manual UserNotification has to implement this interface and the implementation has to be qualified with the @Named annotation by a name satisfying the following convention [COMPONENT NAME]InstanceManualUserNotification. For example, for an application Kmelia, the implementation must be qualified with @Named("kmeliaInstanceManualUserNotification")

Author:

silveryocha

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`ComponentInstanceManualUserNotification.Constants`	Constants are predefined value used by manual user notification to work with and that carries a semantic that has to be shared by all the implementations of this interface.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static Optional<ComponentInstanceManualUserNotification>`	`get(String componentNameOrInstanceId)`	Gets the implementation of this interface with the qualified name guessed from the given component instance identifier.
`UserNotification`	`initializesWith(NotificationContext context)`	Initializes a `UserNotification` object with the specified notification context.

- Method Detail
  - get
```
static Optional<ComponentInstanceManualUserNotification> get(String componentNameOrInstanceId)
```
    Gets the implementation of this interface with the qualified name guessed from the given component instance identifier.
    
    Parameters:
    
    componentNameOrInstanceId - the component instance identifier or component name from which the qualified name of the implementation is guessed.
    
    Returns:
    
    an optional implementation of this interface.
  - initializesWith
```
UserNotification initializesWith(NotificationContext context)
```
    Initializes a UserNotification object with the specified notification context.
    
    Parameters:
    
    context - a Map of key-values describing the context within which the user notification has to be built.
    
    Returns:
    
    a UserNotification object.