Interface ObjectBean

    • 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 the WebObjectInfo 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 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.
      • getParentFolderBean

        FolderBean getParentFolderBean​(java.lang.String name,
                                       boolean populate)
                                throws WebBeanException
        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.
      • getFlags

        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:
        the object flags (EnumDSSXMLObjectFlags).
      • getBlockBegin

        int getBlockBegin()
        Returns the blockBegin property of the embedded WebObjectSource.
        Returns:
        the blockBegin property. The default value is 1.
      • setBlockBegin

        void setBlockBegin​(int blockBegin)
        Sets a new blockBegin property to the embedded WebObjectSource.
        Parameters:
        blockBegin - the blockBegin property.
      • getBlockCount

        int getBlockCount()
        Returns the blockCount property of the embedded WebObjectSource.
        Returns:
        the blockCount property. The default value is -1.
      • setBlockCount

        void setBlockCount​(int blockCount)
        Sets the blockCount property of the embedded WebObjectSource.
        Parameters:
        blockCount - the blockCount property.
      • getLevel

        int getLevel()
        Returns the level property of the embedded WebObjectSource.
        Returns:
        the level property. The default value is 0.
      • setLevel

        void setLevel​(int level)
        Sets the level property of the embedded WebObjectSource.
        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 - The WebObjectInfo object corresponding to the object bean.
        Since:
        MicroStrategy Web 9.0.0