Package com.microstrategy.web.beans
Interface ObjectBean
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebBean
,WebComponent
- All Known Subinterfaces:
AppSchemaBean
,AttributeBean
,CustomGroupBean
,DataExplorerBean
,DocumentBean
,EditableObjectBean
,FilterBean
,FolderBean
,PromptAnswerBean
,PromptDefinitionBean
,ReportBean
,ResultSetBean
,RWBean
,SecurityFilterBean
,SecurityRoleBean
,UserBean
,UserEntityBean
,UserGroupBean
public interface ObjectBean extends WebBean
This interface represents a generic metadata object. While it is derived from theWebBean
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getBlockBegin()
Returns the blockBegin property of the embeddedWebObjectSource
.int
getBlockCount()
Returns the blockCount property of the embeddedWebObjectSource
.java.lang.String
getDisplayName()
Display name of the bean.int
getFlags()
Returns the object flags from the embeddedWebObjectSource
.int
getLevel()
Returns the level property of the embeddedWebObjectSource
.java.lang.String
getObjectID()
Returns the object's unique ID in the metadata.WebObjectInfo
getObjectInfo()
Returns the theWebObjectInfo
of the object.java.lang.String
getObjectName()
Returns the object's exact name in the metadata.int
getObjectType()
Returns the type (EnumDSSXMLObjectTypes
) of the object.FolderBean
getParentFolderBean(java.lang.String name)
Returns aFolderBean
representing the parent folder of the current object.FolderBean
getParentFolderBean(java.lang.String name, boolean populate)
Returns aFolderBean
representing the parent folder of the current object.java.lang.String
getParentID()
Returns the unique ID of the parent of the object.void
setBlockBegin(int blockBegin)
Sets a new blockBegin property to the embeddedWebObjectSource
.void
setBlockCount(int blockCount)
Sets the blockCount property of the embeddedWebObjectSource
.void
setFlags(int flags)
Sets a new object flags on the embeddedWebObjectSource
.void
setLevel(int level)
Sets the level property of the embeddedWebObjectSource
.void
setObjectID(java.lang.String objectID)
Sets the object's ID.void
setObjectInfo(WebObjectInfo oi)
Sets the WebObjectInfo object that refers to the object.void
setObjectName(java.lang.String objectName)
Sets the object's name.void
setObjectType(int objectType)
Sets the object' type (EnumDSSXMLObjectTypes
).-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.beans.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
getObjectName
java.lang.String getObjectName() throws WebBeanException
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.
-
setObjectName
void setObjectName(java.lang.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.
-
getObjectType
int getObjectType()
Returns the type (EnumDSSXMLObjectTypes
) of the object.- Returns:
- the type of the object.
-
setObjectType
void setObjectType(int objectType)
Sets the object' type (EnumDSSXMLObjectTypes
).- Parameters:
objectType
- the object't type.
-
getObjectID
java.lang.String getObjectID() throws WebBeanException
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.
-
setObjectID
void setObjectID(java.lang.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.
-
getObjectInfo
WebObjectInfo getObjectInfo() throws WebBeanException
Returns the theWebObjectInfo
of the object.- Returns:
- the
WebObjectInfo
of the object. - Throws:
WebBeanException
- thrown if the object can not be obtained.
-
getParentID
java.lang.String getParentID() throws WebBeanException
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.
-
getParentFolderBean
FolderBean getParentFolderBean(java.lang.String name) throws WebBeanException
Returns aFolderBean
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.
-
getParentFolderBean
FolderBean getParentFolderBean(java.lang.String name, boolean populate) throws WebBeanException
Returns aFolderBean
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.
-
getFlags
int getFlags()
Returns the object flags from the embeddedWebObjectSource
. The default value isEnumDSSXMLObjectFlags.DssXmlObjectAncestors | EnumDSSXMLObjectFlags.DssXmlObjectDefn | EnumDSSXMLObjectFlags.DssXmlObjectDates | EnumDSSXMLObjectFlags.DssXmlObjectSecurity | EnumDSSXMLObjectFlags.DssXmlObjectDepnSecurity
.- Returns:
- the object flags (
EnumDSSXMLObjectFlags
).
-
setFlags
void setFlags(int flags)
Sets a new object flags on the embeddedWebObjectSource
.- Parameters:
flags
- an object flags (EnumDSSXMLObjectFlags
).
-
getBlockBegin
int getBlockBegin()
Returns the blockBegin property of the embeddedWebObjectSource
.- Returns:
- the blockBegin property. The default value is 1.
-
setBlockBegin
void setBlockBegin(int blockBegin)
Sets a new blockBegin property to the embeddedWebObjectSource
.- Parameters:
blockBegin
- the blockBegin property.
-
getBlockCount
int getBlockCount()
Returns the blockCount property of the embeddedWebObjectSource
.- Returns:
- the blockCount property. The default value is -1.
-
setBlockCount
void setBlockCount(int blockCount)
Sets the blockCount property of the embeddedWebObjectSource
.- Parameters:
blockCount
- the blockCount property.
-
getLevel
int getLevel()
Returns the level property of the embeddedWebObjectSource
.- Returns:
- the level property. The default value is 0.
-
setLevel
void setLevel(int level)
Sets the level property of the embeddedWebObjectSource
.- Parameters:
level
- the level property.
-
setObjectInfo
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
- TheWebObjectInfo
object corresponding to the object bean.- Since:
- MicroStrategy Web 9.0.0
-
getDisplayName
java.lang.String getDisplayName() throws WebBeanException
Display name of the bean. By default, this is identical togetObjectName()
, but for beans that contain an underlyingWebMessage
theWebMessage.getDisplayName()
is returned, which may be aliased differently.- Returns:
- display name.
- Throws:
WebBeanException
- if there is a problem retrieving the display name.- Since:
- MicroStrategy Web 9.0.0
-
-