Interface ResourceLocationReceiver

All Superinterfaces:

OsidReceiver

public interface ResourceLocationReceiver
extends OsidReceiver

The resource location receiver is the consumer supplied interface for receiving notifications pertaining to location changes of resources.

Method Summary

Modifier and Type	Method	Description
void	enteredLocation(Id notificationId, Id locationId, Id resourceId)	The callback for notifications of resources entering locations.
void	exitedLocation(Id notificationId, Id routeId, Id resourceId)	The callback for notifications of resources exiting locations.
void	newResourceCoordinate(Id notificationId, Coordinate coordinate, Id resourceId)	The callback for notifications of resources changing coordinates.

Methods inherited from interface OsidReceiver

down, up

Modifier and Type	Method	Description
void	down()	The callback for notifications that the notification bus is not operating.
void	up()	The callback for notifications that the notification bus is operational.

Method Details

enteredLocation

void enteredLocation(Id notificationId,
 Id locationId,
 Id resourceId)

The callback for notifications of resources entering locations.

Parameters:

notificationId - the notification Id

locationId - the Id of the Location

resourceId - the Id of the Resource

Compliance:

mandatory - This method must be implemented.

exitedLocation

void exitedLocation(Id notificationId,
 Id routeId,
 Id resourceId)

The callback for notifications of resources exiting locations.

Parameters:

notificationId - the notification Id

routeId - the Id of the Location

resourceId - the Id of the Resource

Compliance:

mandatory - This method must be implemented.

newResourceCoordinate

void newResourceCoordinate(Id notificationId,
 Coordinate coordinate,
 Id resourceId)

The callback for notifications of resources changing coordinates.

Parameters:

notificationId - the notification Id

coordinate - the new coordinate

resourceId - the Id of the Resource

Compliance:

mandatory - This method must be implemented.