org.sakaiproject.service.framework.courier
Interface Delivery

All Known Implementing Classes:
BaseDelivery

public interface Delivery

Delivery is the core interface for things sent to the Courier service that represent various sorts of deliveries to the client windows.

Address is a client window address.

Version:
$Revision: 632 $
Author:
University of Michigan, CHEF Software Development Team

Method Summary
 void act()
          Perform any pre-delivery actions.
 String compose()
          Compose a javascript message for delivery to the browser client window.
 String getAddress()
          Access the delivery address.
 String getElement()
          Access the HTML Element Id that this delivery is in reference to.
 void setAddress(String address)
          Set the delivery address.
 void setElement(String id)
          Set the HTML Element Id that this delivery is in reference to.
 

Method Detail

setAddress

public void setAddress(String address)
Set the delivery address.

Parameters:
address - The delivery address.

getAddress

public String getAddress()
Access the delivery address.

Returns:
The delivery address.

setElement

public void setElement(String id)
Set the HTML Element Id that this delivery is in reference to.

Parameters:
id - The HTML Element Id that this delivery is in reference to.

getElement

public String getElement()
Access the HTML Element Id that this delivery is in reference to.

Returns:
The HTML Element Id that this delivery is in reference to.

act

public void act()
Perform any pre-delivery actions. Note: this is run in the same usage session as is being delivered to.


compose

public String compose()
Compose a javascript message for delivery to the browser client window.

Returns:
The javascript message to send to the browser client window.