org.apache.cocoon.components.notification
Interface NotifyingBuilder

All Superinterfaces:

Component

All Known Implementing Classes:

DefaultNotifyingBuilder

public interface NotifyingBuilder
extends Component

Generates an Notifying representation of widely used objects.

Version:

CVS $Id: NotifyingBuilder.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Nicola Ken Barozzi

Field Summary

static String

ROLE The role implemented by a NotifyingBuilder.

Method Summary

Notifying	build(Object sender, Object o) Builds a Notifying object (SimpleNotifyingObject in this case) that tries to explain what the Object o can reveal.
Notifying	build(Object sender, Object o, String type, String title, String source, String message, String description, Map extra) Builds a Notifying object (SimpleNotifyingObject in this case) that explains a notification.

Field Detail

ROLE

static final String ROLE

The role implemented by a NotifyingBuilder.

Method Detail

build

Notifying build(Object sender,
                Object o)

Builds a Notifying object (SimpleNotifyingObject in this case) that tries to explain what the Object o can reveal.

Parameters:

sender - who sent this Object.

o - the object to use when building the SimpleNotifyingObject

Returns:

the Notifying Object that was build

See Also:

Notifying

build

Notifying build(Object sender,
                Object o,
                String type,
                String title,
                String source,
                String message,
                String description,
                Map extra)

Builds a Notifying object (SimpleNotifyingObject in this case) that explains a notification.

Parameters:

sender - who sent this Object.

o - the object to use when building the SimpleNotifyingObject

type - see the Notifying apidocs

title - see the Notifying apidocs

source - see the Notifying apidocs

message - see the Notifying apidocs

description - see the Notifying apidocs

extra - see the Notifying apidocs

Returns:

the Notifying Object that was build

See Also:

Notifying