com.uc4.communication.requests

Class DeleteForecast

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.DeleteForecast

public class DeleteForecast
extends XMLRequest

Deletes an existing Forecast.

This request will return a message box with number U4001229 if the forecast calculation is active. The parameter force can be used to delete the forcast in this case.

Constructor Summary

Constructors

Constructor and Description
DeleteForecast(ForecastItem item) Creates a new DeleteForecast.
DeleteForecast(ForecastItem item, boolean force) Creates a new DeleteForecast request.
DeleteForecast(java.util.List<ForecastItem> items, boolean force) Creates a new DeleteForecast for multiple forecast items.

Method Summary

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeleteForecast

public DeleteForecast(ForecastItem item)

Creates a new DeleteForecast.

Parameters:

item - Forecast which should be removed

DeleteForecast

public DeleteForecast(ForecastItem item,
                      boolean force)

Creates a new DeleteForecast request.

Parameters:

item - Forecast which should be removed

force - If true the forecast will be removed even if it is currently running

DeleteForecast

public DeleteForecast(java.util.List<ForecastItem> items,
                      boolean force)

Creates a new DeleteForecast for multiple forecast items.

Parameters:

items - List of Forecast items which should be removed

force - If true forecast items will be removed even if they are currently running