public class

WebDeliveryThresholdsMetricImpl

extends AbstractPersistable
implements WebThresholds
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.objects.WebDeliveryThresholdsMetricImpl

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
WebThreshold add(String tmpId, WebThreshold template)
WebThreshold add(String tmpId)
Adds a new threshold object with the given temporary identifier.
void clear()
Removes all threshold instances.
WebThresholds createCopy()
Returns a WebThresholds collection that is a copy of the current object.
Enumeration elements()
WebThreshold get(int index)
WebThreshold get(String id)
boolean isModified()
Returns whether the WebThresholds object is modified or not.
void populate(WebThresholds thresholds)
The populate method will populate the current collection with the contents of the given one.
WebThreshold remove(String id)
Removes a threshold.
void reorder(String[] ids)
The array of identifiers define the new relative ordering of thresholds.
int size()
Protected Methods
AbstractHandler getStateHandler()
void saveXMLState(StringBuffer buf, int howMuchState)
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebThresholds

Public Methods

public WebThreshold add (String tmpId, WebThreshold template)

public WebThreshold add (String tmpId)

Adds a new threshold object with the given temporary identifier. The identifier is no longer valid once the manipulation is submitted.

Parameters
tmpId a temporary id used to refer to the new threshold
Returns
  • a new threshold instance

public void clear ()

Removes all threshold instances. This is equivalent to invoking remove(String) for all threshold identifiers.

public WebThresholds createCopy ()

Returns a WebThresholds collection that is a copy of the current object. Note that this copy will still be aware of its container, but the container will still be attached to the original WebThresholds object. The primary purpose of this method is to allow the caller to capture the state of the thresholds collection, and then edit the state without affecting the original collection. Typical usage will see this method being used along with the populate method, to move the information back from the copy to the original collection.

Returns
  • A WebThresholds collection that is in exactly the same state as the original.

public Enumeration elements ()

public WebThreshold get (int index)

public WebThreshold get (String id)

public boolean isModified ()

Returns whether the WebThresholds object is modified or not.

Returns
  • True if the collection is modified, false otherwise.

public void populate (WebThresholds thresholds)

The populate method will populate the current collection with the contents of the given one. This is primarily intended to be used to propagate changes made to a copy obtained via the createCopy method back to the original.

Parameters
thresholds The source object whose definition will be copied into the current object.

public WebThreshold remove (String id)

Removes a threshold.

Parameters
id identifier of threshold to remove.
Returns
  • the threshold instance removed.

public void reorder (String[] ids)

The array of identifiers define the new relative ordering of thresholds. Each identifier pair is subject to moveByKey(Object, Object). For example, if thresholds "a, b, c, d, e" were reordered with the parameter array "b, e", we would have "a, c, d, b, e".

Parameters
ids array of threshold identifiers in relative order

public int size ()

Protected Methods

protected AbstractHandler getStateHandler ()

Throws
UnsupportedOperationException

protected void saveXMLState (StringBuffer buf, int howMuchState)