Package com.microstrategy.web.objects

Interface WebFormat

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

public interface WebFormat
extends WebObjectInfo

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
void	generateDeltaBody(RWDelta delta, boolean reset)
boolean	getBoolValue(java.lang.String category, java.lang.String name)
boolean	getBoolValue(java.lang.String category, java.lang.String name, boolean defaultValue)
WebFormat	getDefinition()
float	getFloatValue(java.lang.String category, java.lang.String name)
float	getFloatValue(java.lang.String category, java.lang.String name, float defaultValue)
int	getIntValue(java.lang.String category, java.lang.String name)
int	getIntValue(java.lang.String category, java.lang.String name, int defaultValue)
WebFormatIterator	getIterator()
boolean	getUseDefault(java.lang.String category, java.lang.String name)
java.lang.String	getValue(java.lang.String category, java.lang.String name)
java.lang.String	getValue(java.lang.String category, java.lang.String name, java.lang.String defaultValue)
boolean	hasOwnProperty(java.lang.String psName, java.lang.String name)
boolean	hasProperty(java.lang.String psName, java.lang.String propName)
boolean	hasPropertySet(java.lang.String psName)
boolean	propertySetEqual(WebFormat f2, java.lang.String psName)
void	setIfNotEmpty(java.lang.String category, java.lang.String name, java.lang.String value)
void	setUseDefault(java.lang.String category, java.lang.String name, boolean value)
void	setValue(java.lang.String category, java.lang.String name, boolean value)
void	setValue(java.lang.String category, java.lang.String name, int value)
void	setValue(java.lang.String category, java.lang.String name, java.lang.String value)

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getValue

java.lang.String getValue(java.lang.String category,
                          java.lang.String name)
                   throws WebObjectsException,
                          java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 8.0.0

getValue

java.lang.String getValue(java.lang.String category,
                          java.lang.String name,
                          java.lang.String defaultValue)

Since:

MicroStrategy Web 8.0.0

getIntValue

int getIntValue(java.lang.String category,
                java.lang.String name)
         throws WebObjectsException,
                java.lang.IllegalArgumentException,
                java.lang.NumberFormatException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

java.lang.NumberFormatException

Since:

MicroStrategy Web 8.0.0

getIntValue

int getIntValue(java.lang.String category,
                java.lang.String name,
                int defaultValue)
         throws WebObjectsException,
                java.lang.NumberFormatException

Throws:

WebObjectsException

java.lang.NumberFormatException

Since:

MicroStrategy Web 8.0.0

getBoolValue

boolean getBoolValue(java.lang.String category,
                     java.lang.String name)
              throws WebObjectsException,
                     java.lang.IllegalArgumentException,
                     java.lang.NumberFormatException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

java.lang.NumberFormatException

Since:

MicroStrategy Web 8.0.0

getBoolValue

boolean getBoolValue(java.lang.String category,
                     java.lang.String name,
                     boolean defaultValue)
              throws WebObjectsException,
                     java.lang.NumberFormatException

Throws:

WebObjectsException

java.lang.NumberFormatException

Since:

MicroStrategy Web 8.0.0

setValue

void setValue(java.lang.String category,
              java.lang.String name,
              java.lang.String value)
       throws WebObjectsException,
              java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 8.0.0

setValue

void setValue(java.lang.String category,
              java.lang.String name,
              int value)
       throws WebObjectsException,
              java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 8.1.0

setValue

void setValue(java.lang.String category,
              java.lang.String name,
              boolean value)
       throws WebObjectsException,
              java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 8.1.0

setIfNotEmpty

void setIfNotEmpty(java.lang.String category,
                   java.lang.String name,
                   java.lang.String value)
            throws WebObjectsException,
                   java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 8.0.0

getUseDefault

boolean getUseDefault(java.lang.String category,
                      java.lang.String name)
               throws WebObjectsException,
                      java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 9.0.0

setUseDefault

void setUseDefault(java.lang.String category,
                   java.lang.String name,
                   boolean value)
            throws WebObjectsException,
                   java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 9.0.0

hasPropertySet

boolean hasPropertySet(java.lang.String psName)

Since:

MicroStrategy Web 9.0.0

hasProperty

boolean hasProperty(java.lang.String psName,
                    java.lang.String propName)

Since:

MicroStrategy Web 9.0.0

getDefinition

WebFormat getDefinition()

Since:

MicroStrategy Web 9.0.0

getFloatValue

float getFloatValue(java.lang.String category,
                    java.lang.String name)
             throws WebObjectsException,
                    java.lang.IllegalArgumentException,
                    java.lang.NumberFormatException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

java.lang.NumberFormatException

Since:

MicroStrategy Web 9.0.0

getFloatValue

float getFloatValue(java.lang.String category,
                    java.lang.String name,
                    float defaultValue)
             throws WebObjectsException,
                    java.lang.NumberFormatException

Throws:

WebObjectsException

java.lang.NumberFormatException

Since:

MicroStrategy Web 9.0.0

getIterator

WebFormatIterator getIterator()

Since:

MicroStrategy Web 9.0.1

propertySetEqual

boolean propertySetEqual(WebFormat f2,
                         java.lang.String psName)

Since:

MicroStrategy Web 9.0.1

hasOwnProperty

boolean hasOwnProperty(java.lang.String psName,
                       java.lang.String name)

generateDeltaBody

void generateDeltaBody(RWDelta delta,
                       boolean reset)