Package com.microstrategy.web.objects

Interface WebPropertySet

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

public interface WebPropertySet
extends WebObjectInfo

WebPropertySet represents a property set, which is a first class object. It is a collection of several WebProperty. This interface provides methods to retrieve the property information about this property set, also provides methods to retrieve a WebProperty in its collection.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
java.util.Enumeration	elements()	Return an Enumeration of WebProperty objects inside this object.
WebProperty	findItemByID(int id)	Return the WebProperty object according to the ID.
WebProperty	findItemByName(java.lang.String name)	Return the WebProperty object, according to the name.
WebProperty	get(int index)	Return the WebProperty object according to the index.
WebProperty	getItemByID(int id)	Return the WebProperty object according to the ID.
WebProperty	getItemByName(java.lang.String name)	Return the WebProperty object, according to the name.
boolean	hasItemByName(java.lang.String propertyName)
boolean	isDirty()	Return true if any property of this WebPropertySet has been changed, or if any child child WebProperty has been changed.
boolean	isEmpty()	Return true if there is WebProperty object inside this object, else return false.
void	save()	Save the current WebPorpertySet information back to MetaData.
int	size()	Return the number of WebProperty objects inside this object.

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, 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

get

WebProperty get(int index)
         throws java.lang.IndexOutOfBoundsException

Return the WebProperty object according to the index.

Parameters:

index - 0-based index

Returns:

The WebProperty object according to the index

Throws:

java.lang.IndexOutOfBoundsException - If the index is less than 0 or greater than the size, an exception of IndexOutOfBoundsException will be thrown.

getItemByID

WebProperty getItemByID(int id)
                 throws java.lang.IllegalArgumentException

Return the WebProperty object according to the ID.

Parameters:

id - an ID corresponding to the "pri" attribute of "properties" node.

Returns:

The WebProperty object whose ID, "pri" attribute, matches input parameter id.

Throws:

java.lang.IllegalArgumentException - If there is no matching WebProperty object, an exception of IllegalArgumentException will be thrown.

getItemByName

WebProperty getItemByName(java.lang.String name)
                   throws java.lang.IllegalArgumentException

Return the WebProperty object, according to the name.

Parameters:

name - The name of the property, which corresponds to the attribute "n".

Returns:

The WebProperty object whose name, "n" attribute, matches input parameter name.

Throws:

java.lang.IllegalArgumentException - If there is no matching WebProperty object, an exception of IllegalArgumentException will be thrown.

size

int size()

Return the number of WebProperty objects inside this object.

Returns:

The number of WebProperty objects inside this object.

isEmpty

boolean isEmpty()

Return true if there is WebProperty object inside this object, else return false.

Returns:

True if there is WebProperty object inside this object, else return false.

elements

java.util.Enumeration elements()

Return an Enumeration of WebProperty objects inside this object.

Returns:

An Enumeration representation child WebProperty objects.

isDirty

boolean isDirty()

Return true if any property of this WebPropertySet has been changed, or if any child child WebProperty has been changed.

Specified by:

isDirty in interface WebObjectInfo

Returns:

Ture if any property of this WebPropertySet object has been changed, or if any WebProperty object in this collection has been changed. Else, return false.

save

void save()
   throws WebObjectsException

Save the current WebPorpertySet information back to MetaData. If there is no change since initialize or last time saving, there will be no request back to MetaData.

Throws:

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

hasItemByName

boolean hasItemByName(java.lang.String propertyName)

Since:

MicroStrategy Web 8.0.0

findItemByName

WebProperty findItemByName(java.lang.String name)

Return the WebProperty object, according to the name. Null is returned if object does not exist.

Parameters:

name - The name of the property, which corresponds to the attribute "n".

Returns:

The WebProperty object whose name, "n" attribute, matches input parameter name.

Since:

MicroStrategy Web 8.0.0

findItemByID

WebProperty findItemByID(int id)

Return the WebProperty object according to the ID. Null is returned if object does not exist.

Parameters:

id - an ID corresponding to the "pri" attribute of "properties" node.

Returns:

The WebProperty object whose ID, "pri" attribute, matches input parameter id.

Since:

MicroStrategy Web 8.0.0