org.sakaiproject.courier.api

Interface ObservingCourier

All Superinterfaces:

Observer

public interface ObservingCourier
extends Observer

ObservingCourier is an observer which uses the courier service to notify when things change.

Method Summary

Modifier and Type	Method and Description
boolean	check(Object arg) Check to see if we want to process or ignore this update.
void	disable() Disable.
void	enable() Enable.
String	getDeliveryId()
String	getElementId()
boolean	getEnabled()
String	getLocation()
void	justDelivered() Accept notification that the element has just been delivered.
void	setDeliveryId(String id) Set the delivery id.
void	setElementId(String id) Set the element id.

Methods inherited from interface java.util.Observer

update

Method Detail

check

boolean check(Object arg)

Check to see if we want to process or ignore this update.

Parameters:

arg - The arg from the update.

Returns:

true to continue, false to quit.

disable

void disable()

Disable.

enable

void enable()

Enable.

getDeliveryId

String getDeliveryId()

Returns:

the delivery id.

getElementId

String getElementId()

Returns:

The element id.

getEnabled

boolean getEnabled()

Returns:

the enabled status.

getLocation

String getLocation()

Returns:

the location this observer is observing.

justDelivered

void justDelivered()

Accept notification that the element has just been delivered. If there are pending requests to deliver, they can be cleared.

setDeliveryId

void setDeliveryId(String id)

Set the delivery id.

Parameters:

id - The delivery id.

setElementId

void setElementId(String id)

Set the element id.

Parameters:

id - the element id.