public interface

WebProperty

com.microstrategy.web.objects.WebProperty
Known Indirect Subclasses

Class Overview

WebProperty represents a property, which is an item in WebPropertySet. It is not a first class concept in MetaData, so it tightly linked to a WebPropertySet. This interface provides the ability to retrieve the property information about this property. Also provides the method to save the changed information back to MetaData.

Summary

Public Methods
abstract String getDefaultValue()
Return the default value for this WebProperty.
abstract int getID()
Return the ID information of this WebProperty.
abstract String getName()
Return the name of this WebProperty.
abstract int getType()
Return the type of this WebProperty.
abstract boolean getUseDefault()
Return whether current WebProperty using the default value in MetaData.
abstract String getValue()
Return the value of this WebProperty.
abstract boolean isDirty()
Return true if this WebProperty has been changed since first time initialization or last time saving.
abstract void save()
Save the change back to MetaData.
abstract void save(WebIServerSession session)
Saves changes back to the MetaData using the specified session.
abstract void setUseDefault(boolean useDefault)
Set this WebProperty to use the default value in MetaData or not.
abstract void setValue(String value)
Set the value of this WebProperty.

Public Methods

public abstract String getDefaultValue ()

Return the default value for this WebProperty.

Returns
  • The String representation of the default value, corresponding to the attribute "pdv" of "property" node.

public abstract int getID ()

Return the ID information of this WebProperty.

Returns
  • The integer value of the ID, corresponding to the attribute "pri" of "property" node.

public abstract String getName ()

Return the name of this WebProperty.

Returns
  • The name of this WebProperty, corresponding to the attribute "n" of "property" node.

public abstract int getType ()

Return the type of this WebProperty. The value is from the enumeration EnumVariantTypes

Returns
  • The type of this WebProperty, corresponding to the attribute "dt" of "property" node.

public abstract boolean getUseDefault ()

Return whether current WebProperty using the default value in MetaData. It is corresponding to the "pru" attribute of "property" node.

Returns
  • True If current WebProperty using the default value in Metadata for this property, else false.

public abstract String getValue ()

Return the value of this WebProperty.

Returns
  • The String representation of the value of this WebProperty, corresponding to the attribute "v" of "property" node.
See Also

public abstract boolean isDirty ()

Return true if this WebProperty has been changed since first time initialization or last time saving.

Returns
  • True if this WebProperty has been changed since the initialization or last time saving. Else, return false.

public abstract void save ()

Save the change back to MetaData. If there is no change since initialization or last time saving, do nothing.

Throws
WebObjectsException If there is anything wrong during the saving process, an exception of WebObjectsException will be thrown.

public abstract void save (WebIServerSession session)

Saves changes back to the MetaData using the specified session. Required if a given WebProperty is cached across multiple sessions.

Parameters
session session used to perform the save.
Throws
WebObjectsException thrown if an error occurs during the saving process.

public abstract void setUseDefault (boolean useDefault)

Set this WebProperty to use the default value in MetaData or not.

Parameters
useDefault If it is true, then this WebProperty should use the default value ("pdv" attribute), else it should use the value ("v" attribute). This setting corresponds to "pru" attribute of "property" node.
Throws
UnsupportedOperationException
See Also

public abstract void setValue (String value)

Set the value of this WebProperty.

Parameters
value The String representation of the value to be set, corresponding to the "v" attribute of "property" node.
Throws
UnsupportedOperationException
See Also