org.sakaiproject.courier.api

Interface Delivery

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.

Method Summary

Modifier and Type	Method and Description
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

void setAddress(String address)

Set the delivery address.

Parameters:

address - The delivery address.

getAddress

String getAddress()

Access the delivery address.

Returns:

The delivery address.

setElement

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

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

void act()

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

compose

String compose()

Compose a javascript message for delivery to the browser client window.

Returns:

The javascript message to send to the browser client window.