public interface

WebObjectInfo

implements WebDisplayUnit WebFeatures WebPromptSite
com.microstrategy.web.objects.WebObjectInfo
Known Indirect Subclasses

Class Overview

The WebObjectInfo interface represents the fields on any first class object which resides in metadata. All Web Objects classes which represent first class objects implement this interface.

Note that most of these objects are read-only, some of these objects are editable and can be saved back to metadata, Some of them are editable but cannot be saved back to metadata. Refer to WebObjectSource for more detail information.

Summary

Public Methods
abstract void buildShortObjectAttributes(WebXMLBuilder builder)
abstract void buildShortXML(WebXMLBuilder builder)
abstract String getAbbreviation()
Returns the abbreviation of this object.
abstract int getAccessGranted()
Returns the current access granted on this object, if available.
abstract SimpleList getAncestors()
Returns a SimpleList containing the ancestors of this object, if they exist in the object XML.
abstract String[] getComments()
Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String getContainerDid()
abstract String getContainerType()
abstract String getCreationTime()
Returns the creation time of this object, if that information is available.
abstract String getDataSources()
abstract String getDescription()
Returns the description of the object.
abstract int getExtendedType()
The current extended type
abstract WebObjectsFactory getFactory()
Returns WebObjectsFactory
abstract int getFlags()
Returns the flags which determine what data to populate upon calling populate.
abstract String getID()
Returns the DSS ID of the object, if one exists.
abstract String getIconPath()
Return the icon path for the object
abstract String getModificationTime()
Returns the last modification time of the object, if that information is available.
abstract long getModificationTimeStamp()
abstract String getName()
Returns the name of this object.
abstract boolean getNonSchedulable()
Get flag of whether the object is not schedulable
abstract int getOtherNameTransCount()
Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo getOwner()
Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder getParent()
Returns the parent folder of the current object, if it exists.
abstract int getPropertyFlags()
Retrieve the current property flags
abstract SimpleList getPropertySetFilter()
Returns an editable SimpleList where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup getPropertySets()
Returns the property sets associated with this object.
abstract WebObjectSecurity getSecurity()
Returns the WebObjectSecurity object associated with this WebObjectInfo object.
abstract int getState()
Returns the state of the object.
abstract int getSubType()
Returns the subtype of the object.
abstract int getType()
Returns the type of this object.
abstract String getVersionID()
Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings getViewMediaSettings()
abstract int getVisualizationViewMode()
abstract String getXML(boolean encode)
Returns the XML representation of this object.
abstract String getXML()
Returns the XML representation of this object.
abstract boolean hasOwner()
abstract boolean isAncestorNamedFolder(int folderName)
Returns whether the named folder is this object's ancestor.
abstract boolean isDirty()
Returns whether this object has been modified to be different from the object in metadata.
abstract boolean isEmbedded()
abstract boolean isHidden()
Returns whether the object is a hidden object.
abstract boolean isNew()
Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean isPopulated()
Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void populate()
Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void populate(String xml)
Populates the fields on this object by loading the given object definition XML.
abstract void setAbbreviation(String abbreviation)
abstract void setComments(String[] comments)
Set the long description of the object as an array of strings.
abstract void setDataSources(String dataSourcesXML)
abstract void setDescription(String description)
Sets the description of the object.
abstract void setExtendedType(int extendedType)
Set the current extended type
abstract void setFlags(int flags)
Sets the flags which determine what data to populate upon calling populate.
abstract void setHidden(boolean hidden)
Sets whether the object is a hidden object.
abstract void setIconPath(String iconPath)
Set the icon path for the object
abstract void setName(String _name)
abstract void setNonSchedulable(boolean nonSchedulable)
Set flag of whether the object is not schedulable
abstract void setPropertyFlags(int flags)
Set the current property flags
[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.WebPromptSite

Public Methods

public abstract void buildShortObjectAttributes (WebXMLBuilder builder)

public abstract void buildShortXML (WebXMLBuilder builder)

public abstract String getAbbreviation ()

Returns the abbreviation of this object.

Returns
  • The object's abbreviation, if one exists.

public abstract int getAccessGranted ()

Returns the current access granted on this object, if available. This comes from the bitwise or(|) of values from EnumDSSXMLAccessRightFlags.

Returns
  • The numeric representation of the access this user has to the object.

public abstract SimpleList getAncestors ()

Returns a SimpleList containing the ancestors of this object, if they exist in the object XML. If they do not exist in object XML, and this is object has a valid DSSID, a request will be sent back to Intelligence Server to retrieve the ancestors information. These objects will be in order from highest ancestor (usually the root folder) to lowest ancestor (the parent folder).

Returns
  • A SimpleList containing the ancestors of the object.
Throws
UnsupportedOperationException Thrown if the ancestors could not be found or retrieved for the object.

public abstract String[] getComments ()

Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object. These comments can be set programmatically or using MicroStrategy Desktop (Properties editor -> Long description tab) and are separated by a carriage return.

Returns
  • String array of comments

public abstract String getContainerDid ()

public abstract String getContainerType ()

public abstract String getCreationTime ()

Returns the creation time of this object, if that information is available.

Returns
  • A string representing the creation time of this object.

public abstract String getDataSources ()

public abstract String getDescription ()

Returns the description of the object.

Returns
  • The current description of this object.

public abstract int getExtendedType ()

The current extended type

Returns

public abstract WebObjectsFactory getFactory ()

Returns WebObjectsFactory

Returns
  • WebObjectsFactory

public abstract int getFlags ()

Returns the flags which determine what data to populate upon calling populate. This value is the bitwise or(|) of values from EnumDSSXMLObjectFlags.

Returns
  • The currently set flags value.
See Also

public abstract String getID ()

Returns the DSS ID of the object, if one exists.

Returns
  • A String representing the ID of the object.

public abstract String getIconPath ()

Return the icon path for the object

Returns
  • String containing the icon path for the object

public abstract String getModificationTime ()

Returns the last modification time of the object, if that information is available.

Returns
  • A string representing the last modification time of the object.

public abstract long getModificationTimeStamp ()

public abstract String getName ()

Returns the name of this object. the name retrieved with this method is read-only on this interface, comes from the MetaData name of a first-class object. If you wish to change the name displayed to the screen, setDisplayName(String) should be used along with the getDisplayName() call. Please also note that while only first-class objects (i.e. WebObjectInfo) has a "name" property, many object types (WebElements, and WebDimtyUnit) can have their respective "names" accessed or changed on the screen via getDisplayName() and setDisplayName(String). If you want to change the object's actual metadata name, it can be done via the appropriate save(WebObjectInfo, String) or save(WebObjectInfo, String, WebFolder) calls.

Returns
  • The name of the object.

public abstract boolean getNonSchedulable ()

Get flag of whether the object is not schedulable

Returns
  • whether the object is not schedulable

public abstract int getOtherNameTransCount ()

Returns the count of name translations for locales other than the current effective locale.

Returns
  • The count of name translations for locales other than the current effective locale.

public abstract WebObjectInfo getOwner ()

Returns a WebObjectInfo object which corresponds to the owner of this object.

Returns
  • A WebObjectInfo object, representing the owner of this object
Throws
WebObjectsException Thrown if the owner of this object is not available.

public abstract WebFolder getParent ()

Returns the parent folder of the current object, if it exists. Note that the WebFolder object returned will not be automatically populated.

Returns
  • The parent folder of the current object. If this is the root folder, then this method will return null.
Throws
UnsupportedOperationException Thrown if the parent could not be found or retrieved for the object.

public abstract int getPropertyFlags ()

Retrieve the current property flags

Returns

public abstract SimpleList getPropertySetFilter ()

Returns an editable SimpleList where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state. Also, once the filter is defined and propertySets are retrieved for an instance, there is no way to retrieve a different set of propertySets

public abstract WebPropertyGroup getPropertySets ()

Returns the property sets associated with this object. Note that this will generally only work with a non-embedded (i.e. standalone) object.

Returns
  • A WebPropertyGroup object, which contains the property sets associated with this object.
Throws
WebObjectsException Thrown if the property sets could not be retrieved.

public abstract WebObjectSecurity getSecurity ()

Returns the WebObjectSecurity object associated with this WebObjectInfo object. The WebObjectSecurity interfaces allows viewing and modification of the ACL of this object, and the ability to take ownership of the object.

Returns

public abstract int getState ()

Returns the state of the object. This value comes from EnumDSSXMLObjectState.

Returns
  • The state of this object.

public abstract int getSubType ()

Returns the subtype of the object. This will be a value from EnumDSSXMLObjectSubTypes.

Returns
  • The subtype of the object.

public abstract int getType ()

Returns the type of this object. This will be a value from EnumDSSXMLObjectTypes.

Returns
  • The type of the object.

public abstract String getVersionID ()

Returns the Version ID of the object, if one exists.

Returns
  • A String representing the ID of the object version.

public abstract WebViewMediaSettings getViewMediaSettings ()

public abstract int getVisualizationViewMode ()

public abstract String getXML (boolean encode)

Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell. The encoding parameter will tell whether the XML generated should have special characters HTML encoded.

Parameters
encode If this is true, then the returned string will have all special characters HTML-encoded.
Returns
  • The XML representation of the current state of this object.

public abstract String getXML ()

Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell.

Returns
  • The XML representation of the current state of this object.

public abstract boolean hasOwner ()

Returns
  • whether there is an owner object available.

public abstract boolean isAncestorNamedFolder (int folderName)

Returns whether the named folder is this object's ancestor.

Parameters
folderName An Enumeration in EnumDSSXMLFolderNames
Returns
  • true if the named folder in the ancestor list, false otherwise.
Throws
WebObjectsException Thrown if an error occurs in obtaining the DSSID for the named folder.
UnsupportedOperationException Thrown if the ancestors could not be found or retrieved for the object.

public abstract boolean isDirty ()

Returns whether this object has been modified to be different from the object in metadata. Any changes to this object self or the objects it contains will make this flag to be true. For a modified object, after saving it back to metadata will make this flag to be false.

Returns
  • boolean true returned when this object has been modified at client side. false returned when this object is the same as in metadata.

public abstract boolean isEmbedded ()

public abstract boolean isHidden ()

Returns whether the object is a hidden object.

Returns
  • True if the object is a hidden object in metadata, false if it is not.

public abstract boolean isNew ()

Returns whether this object is newly created at client side, which is not in the metadata. For a new object, after saving it back to metadata will turn this flag to false.

Returns
  • boolean true returned when this is a newly created object at client side. false returned when this object is persisted in metadata.

public abstract boolean isPopulated ()

Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.

Returns
  • The current population status of this object.

public abstract void populate ()

Populates the fields on this object by asking the Intelligence Server for the object definition.

Throws
WebObjectsException Signals an error while trying to populate this object.

public abstract void populate (String xml)

Populates the fields on this object by loading the given object definition XML.

Parameters
xml The XML String to use to populate this object.
Throws
WebObjectsException Thrown if the XML string could not be loaded into this object.

public abstract void setAbbreviation (String abbreviation)

public abstract void setComments (String[] comments)

Set the long description of the object as an array of strings. The long description is also known as the comments.

Parameters
comments String array of comments

public abstract void setDataSources (String dataSourcesXML)

public abstract void setDescription (String description)

Sets the description of the object. The object must be saved by the save or copy methods on the WebObjectSource object to cause a change to this object to be saved.

Parameters
description The description for the object.

public abstract void setExtendedType (int extendedType)

Set the current extended type

public abstract void setFlags (int flags)

Sets the flags which determine what data to populate upon calling populate. This value should be the bitwise or(|) of values from EnumDSSXMLObjectFlags.

Parameters
flags The flags value to use for object definition retrieval.
See Also

public abstract void setHidden (boolean hidden)

Sets whether the object is a hidden object. To save the change of this property to metadata, DssXmlObjectBrowser flag need to be set on WebObjectSource before calling save(WebObjectInfo) with this object as input parameter.

Parameters
hidden boolean true to set this object to hidden.

public abstract void setIconPath (String iconPath)

Set the icon path for the object

public abstract void setName (String _name)

public abstract void setNonSchedulable (boolean nonSchedulable)

Set flag of whether the object is not schedulable

public abstract void setPropertyFlags (int flags)

Set the current property flags

Parameters
flags int binary OR of EnumDSSXMLPropertyXmlFlags