public interface

ObjectBean

implements WebBean
com.microstrategy.web.beans.ObjectBean
Known Indirect Subclasses

Class Overview

This interface represents a generic metadata object. While it is derived from the WebBean interface, this interface includes additional services: (a) Retrieval of an object by name (with wildcard); (b) Retrieval of an object ID; (c) Access to the remaining properties; (d) Parent folder support.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract int getBlockBegin()
Returns the blockBegin property of the embedded WebObjectSource.
abstract int getBlockCount()
Returns the blockCount property of the embedded WebObjectSource.
abstract String getDisplayName()
Display name of the bean.
abstract int getFlags()
Returns the object flags from the embedded WebObjectSource.
abstract int getLevel()
Returns the level property of the embedded WebObjectSource.
abstract String getObjectID()
Returns the object's unique ID in the metadata.
abstract WebObjectInfo getObjectInfo()
Returns the the WebObjectInfo of the object.
abstract String getObjectName()
Returns the object's exact name in the metadata.
abstract int getObjectType()
Returns the type (EnumDSSXMLObjectTypes) of the object.
abstract FolderBean getParentFolderBean(String name)
Returns a FolderBean representing the parent folder of the current object.
abstract FolderBean getParentFolderBean(String name, boolean populate)
Returns a FolderBean representing the parent folder of the current object.
abstract String getParentID()
Returns the unique ID of the parent of the object.
abstract void setBlockBegin(int blockBegin)
Sets a new blockBegin property to the embedded WebObjectSource.
abstract void setBlockCount(int blockCount)
Sets the blockCount property of the embedded WebObjectSource.
abstract void setFlags(int flags)
Sets a new object flags on the embedded WebObjectSource.
abstract void setLevel(int level)
Sets the level property of the embedded WebObjectSource.
abstract void setObjectID(String objectID)
Sets the object's ID.
abstract void setObjectInfo(WebObjectInfo oi)
Sets the WebObjectInfo object that refers to the object.
abstract void setObjectName(String objectName)
Sets the object's name.
abstract void setObjectType(int objectType)
Sets the object' type (EnumDSSXMLObjectTypes).
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract int getBlockBegin ()

Returns the blockBegin property of the embedded WebObjectSource.

Returns
  • the blockBegin property. The default value is 1.

public abstract int getBlockCount ()

Returns the blockCount property of the embedded WebObjectSource.

Returns
  • the blockCount property. The default value is -1.

public abstract String getDisplayName ()

Display name of the bean. By default, this is identical to getObjectName(), but for beans that contain an underlying WebMessage the getDisplayName() is returned, which may be aliased differently.

Returns
  • display name.
Throws
WebBeanException if there is a problem retrieving the display name.

public abstract int getFlags ()

Returns the object flags from the embedded WebObjectSource. The default value is EnumDSSXMLObjectFlags.DssXmlObjectAncestors | EnumDSSXMLObjectFlags.DssXmlObjectDefn | EnumDSSXMLObjectFlags.DssXmlObjectDates | EnumDSSXMLObjectFlags.DssXmlObjectSecurity | EnumDSSXMLObjectFlags.DssXmlObjectDepnSecurity .

Returns

public abstract int getLevel ()

Returns the level property of the embedded WebObjectSource.

Returns
  • the level property. The default value is 0.

public abstract String getObjectID ()

Returns the object's unique ID in the metadata.

Returns
  • the object's id
Throws
WebBeanException thrown if the object ID can not be obtained.

public abstract WebObjectInfo getObjectInfo ()

Returns the the WebObjectInfo of the object.

Returns
  • the WebObjectInfo of the object.
Throws
WebBeanException thrown if the object can not be obtained.

public abstract String getObjectName ()

Returns the object's exact name in the metadata.

Returns
  • the name of the object.
Throws
WebBeanException thrown if the object name can be retrieved.

public abstract int getObjectType ()

Returns the type (EnumDSSXMLObjectTypes) of the object.

Returns
  • the type of the object.

public abstract FolderBean getParentFolderBean (String name)

Returns a FolderBean representing the parent folder of the current object. Null is returned if the current object is the root folder of a project.

Parameters
name the name set on the parent FolderBean.
Returns
  • a FolderBean representing the parent folder of the current object.
Throws
WebBeanException thrown if the parent folder can not be retrieved.

public abstract FolderBean getParentFolderBean (String name, boolean populate)

Returns a FolderBean representing the parent folder of the current object. Null is returned if the current object is the root folder of a project.

Parameters
name the name set on the parent FolderBean.
populate indicates whether the folder object shall be populated.
Returns
  • a FolderBean representing the parent folder of the current object.
Throws
WebBeanException thrown if the parent folder can not be retrieved.

public abstract String getParentID ()

Returns the unique ID of the parent of the object. The parent object must be a folder, and null is returned if the object itself is the root folder of a project.

Returns
  • the object's parent folder's ID; null if backend error occurs.
Throws
WebBeanException thrown if the parent folder can not be retrieved.

public abstract void setBlockBegin (int blockBegin)

Sets a new blockBegin property to the embedded WebObjectSource.

Parameters
blockBegin the blockBegin property.

public abstract void setBlockCount (int blockCount)

Sets the blockCount property of the embedded WebObjectSource.

Parameters
blockCount the blockCount property.

public abstract void setFlags (int flags)

Sets a new object flags on the embedded WebObjectSource.

Parameters
flags an object flags (EnumDSSXMLObjectFlags).

public abstract void setLevel (int level)

Sets the level property of the embedded WebObjectSource.

Parameters
level the level property.

public abstract void setObjectID (String objectID)

Sets the object's ID. The ID must be unique, otherwise an error will be returned when the object is being lazily initialized from the metedata.

Parameters
objectID the object's ID.

public abstract void setObjectInfo (WebObjectInfo oi)

Sets the WebObjectInfo object that refers to the object. This can be used instead of setObjectName or setObjectID to point the bean to the object it should refer to. The most common usage of this method is to use an ObjectBean with an embedded object, which does not exist in metadata as a stand-alone object.

Parameters
oi The WebObjectInfo object corresponding to the object bean.

public abstract void setObjectName (String objectName)

Sets the object's name. Wildcard characters are allowed in the name. A search in the metadata will be performed and the first object found is returned to the caller.

Parameters
objectName the name of the object.

public abstract void setObjectType (int objectType)

Sets the object' type (EnumDSSXMLObjectTypes).

Parameters
objectType the object't type.