public interface

WebFormat

implements WebObjectInfo
com.microstrategy.web.objects.WebFormat

Class Overview

The WebFormat interface represents a format object, which is a first class object. In a WebFormat object, the most important information is its properties. The information about the properties of the format object can be retrieved through the property-related methods of the WebObjectInfo interface.

Summary

Public Methods
abstract void generateDeltaBody(RWDelta delta, boolean reset)
abstract boolean getBoolValue(String category, String name, boolean defaultValue)
abstract boolean getBoolValue(String category, String name)
abstract WebFormat getDefinition()
abstract float getFloatValue(String category, String name)
abstract float getFloatValue(String category, String name, float defaultValue)
abstract int getIntValue(String category, String name)
abstract int getIntValue(String category, String name, int defaultValue)
abstract WebFormatIterator getIterator()
abstract boolean getUseDefault(String category, String name)
abstract String getValue(String category, String name)
abstract String getValue(String category, String name, String defaultValue)
abstract boolean hasOwnProperty(String psName, String name)
abstract boolean hasProperty(String psName, String propName)
abstract boolean hasPropertySet(String psName)
abstract boolean propertySetEqual(WebFormat f2, String psName)
abstract void setIfNotEmpty(String category, String name, String value)
abstract void setUseDefault(String category, String name, boolean value)
abstract void setValue(String category, String name, boolean value)
abstract void setValue(String category, String name, int value)
abstract void setValue(String category, String name, String value)
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract void generateDeltaBody (RWDelta delta, boolean reset)

public abstract boolean getBoolValue (String category, String name, boolean defaultValue)

Throws
NumberFormatException
WebObjectsException

public abstract boolean getBoolValue (String category, String name)

Throws
IllegalArgumentException
NumberFormatException
WebObjectsException

public abstract WebFormat getDefinition ()

public abstract float getFloatValue (String category, String name)

Throws
IllegalArgumentException
NumberFormatException
WebObjectsException

public abstract float getFloatValue (String category, String name, float defaultValue)

Throws
NumberFormatException
WebObjectsException

public abstract int getIntValue (String category, String name)

Throws
IllegalArgumentException
NumberFormatException
WebObjectsException

public abstract int getIntValue (String category, String name, int defaultValue)

Throws
NumberFormatException
WebObjectsException

public abstract WebFormatIterator getIterator ()

public abstract boolean getUseDefault (String category, String name)

Throws
IllegalArgumentException
WebObjectsException

public abstract String getValue (String category, String name)

Throws
IllegalArgumentException
WebObjectsException

public abstract String getValue (String category, String name, String defaultValue)

public abstract boolean hasOwnProperty (String psName, String name)

public abstract boolean hasProperty (String psName, String propName)

public abstract boolean hasPropertySet (String psName)

public abstract boolean propertySetEqual (WebFormat f2, String psName)

public abstract void setIfNotEmpty (String category, String name, String value)

Throws
IllegalArgumentException
WebObjectsException

public abstract void setUseDefault (String category, String name, boolean value)

Throws
IllegalArgumentException
WebObjectsException

public abstract void setValue (String category, String name, boolean value)

Throws
IllegalArgumentException
WebObjectsException

public abstract void setValue (String category, String name, int value)

Throws
IllegalArgumentException
WebObjectsException

public abstract void setValue (String category, String name, String value)

Throws
IllegalArgumentException
WebObjectsException