Package com.microstrategy.web.objects

Class WebReusableThresholdsImpl

    • Method Detail

      • size

        public int size()
        Specified by:
        size in interface WebThresholds
        Returns:
        the number of threshold instances.

      • elements

        public java.util.Enumeration elements()
        Specified by:
        elements in interface WebThresholds
        Returns:
        Enumeration of threshold instances.

      • get

        public WebThreshold get​(java.lang.String id)
        Specified by:
        get in interface WebThresholds
        Parameters:
        id - identifier of the threshold instance
        Returns:
        the threshold instance matching the given identifier.

      • get

        public WebThreshold get​(int index)
        Specified by:
        get in interface WebThresholds
        Parameters:
        index - the index (starting from 0) of the threshold instance in the list
        Returns:
        the threshold instance at the index

      • add

        public WebThreshold add​(java.lang.String tmpId)
        Description copied from interface: WebThresholds
        Adds a new threshold object with the given temporary identifier. The identifier is no longer valid once the manipulation is submitted.
        Specified by:
        add in interface WebThresholds
        Parameters:
        tmpId - a temporary id used to refer to the new threshold
        Returns:
        a new threshold instance

      • reorder

        public void reorder​(java.lang.String[] ids)
        Description copied from interface: WebThresholds
        The array of identifiers define the new relative ordering of thresholds. Each identifier pair is subject to KeyedList.moveByKey(Object, Object). For example, if thresholds "a, b, c, d, e" were reordered with the parameter array "b, e", we would have "a, c, d, b, e".
        Specified by:
        reorder in interface WebThresholds
        Parameters:
        ids - array of threshold identifiers in relative order

      • remove

        public WebThreshold remove​(java.lang.String id)
        Description copied from interface: WebThresholds
        Removes a threshold.
        Specified by:
        remove in interface WebThresholds
        Parameters:
        id - identifier of threshold to remove.
        Returns:
        the threshold instance removed.

      • createCopy

        public WebThresholds createCopy()
        Description copied from interface: WebThresholds
        Returns a WebThresholds collection that is a copy of the current object. Note that this copy will still be aware of its container, but the container will still be attached to the original WebThresholds object. The primary purpose of this method is to allow the caller to capture the state of the thresholds collection, and then edit the state without affecting the original collection. Typical usage will see this method being used along with the populate method, to move the information back from the copy to the original collection.
        Specified by:
        createCopy in interface WebThresholds
        Returns:
        A WebThresholds collection that is in exactly the same state as the original.

      • populate

        public void populate​(WebThresholds template)
        Description copied from interface: WebThresholds
        The populate method will populate the current collection with the contents of the given one. This is primarily intended to be used to propagate changes made to a copy obtained via the createCopy method back to the original.
        Specified by:
        populate in interface WebThresholds
        Parameters:
        template - The source object whose definition will be copied into the current object.

      • isModified

        public boolean isModified()
        Description copied from interface: WebThresholds
        Returns whether the WebThresholds object is modified or not.
        Specified by:
        isModified in interface WebThresholds
        Returns:
        True if the collection is modified, false otherwise.

      • getID

        public java.lang.String getID()
        Description copied from interface: WebObjectInfo
        Returns the DSS ID of the object, if one exists.
        Specified by:
        getID in interface WebDisplayUnit
        Specified by:
        getID in interface WebObjectInfo
        Returns:
        A String representing the ID of the object.

      • setName

        public void setName​(java.lang.String _name)
        Specified by:
        setName in interface WebObjectInfo

      • getOtherNameTransCount

        public int getOtherNameTransCount()
        Description copied from interface: WebObjectInfo
        Returns the count of name translations for locales other than the current effective locale.
        Specified by:
        getOtherNameTransCount in interface WebObjectInfo
        Returns:
        The count of name translations for locales other than the current effective locale.

      • getAbbreviation

        public java.lang.String getAbbreviation()
        Description copied from interface: WebObjectInfo
        Returns the abbreviation of this object.
        Specified by:
        getAbbreviation in interface WebObjectInfo
        Returns:
        The object's abbreviation, if one exists.

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: WebObjectInfo
        Returns the description of the object.
        Specified by:
        getDescription in interface WebObjectInfo
        Returns:
        The current description of this object.

      • getVersionID

        public java.lang.String getVersionID()
        Description copied from interface: WebObjectInfo
        Returns the Version ID of the object, if one exists.
        Specified by:
        getVersionID in interface WebObjectInfo
        Returns:
        A String representing the ID of the object version.

      • setDescription

        public void setDescription​(java.lang.String _description)
        Description copied from interface: WebObjectInfo
        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.
        Specified by:
        setDescription in interface WebObjectInfo
        Parameters:
        _description - The description for the object.
        Since:
        MicroStrategy Web 7.5.2

      • getCreationTime

        public java.lang.String getCreationTime()
        Description copied from interface: WebObjectInfo
        Returns the creation time of this object, if that information is available.
        Specified by:
        getCreationTime in interface WebObjectInfo
        Returns:
        A string representing the creation time of this object.

      • getModificationTime

        public java.lang.String getModificationTime()
        Description copied from interface: WebObjectInfo
        Returns the last modification time of the object, if that information is available.
        Specified by:
        getModificationTime in interface WebObjectInfo
        Returns:
        A string representing the last modification time of the object.

      • isHidden

        public boolean isHidden()
        Description copied from interface: WebObjectInfo
        Returns whether the object is a hidden object.
        Specified by:
        isHidden in interface WebObjectInfo
        Returns:
        True if the object is a hidden object in metadata, false if it is not.

      • setComments

        public void setComments​(java.lang.String[] _comments)
        Description copied from interface: WebObjectInfo
        Set the long description of the object as an array of strings. The long description is also known as the comments.
        Specified by:
        setComments in interface WebObjectInfo
        Parameters:
        _comments - String array of comments
        Since:
        MicroStrategy Web 8.0.1

      • getComments

        public java.lang.String[] getComments()
        Description copied from interface: WebObjectInfo
        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.
        Specified by:
        getComments in interface WebObjectInfo
        Returns:
        String array of comments
        Since:
        MicroStrategy Web 8.0.1

      • getAccessGranted

        public int getAccessGranted()
        Description copied from interface: WebObjectInfo
        Returns the current access granted on this object, if available. This comes from the bitwise or(|) of values from EnumDSSXMLAccessRightFlags.
        Specified by:
        getAccessGranted in interface WebObjectInfo
        Returns:
        The numeric representation of the access this user has to the object.

      • hasOwner

        public boolean hasOwner()
        Specified by:
        hasOwner in interface WebObjectInfo
        Returns:
        whether there is an owner object available.

      • getPropertySetFilter

        public SimpleList getPropertySetFilter()
        Description copied from interface: WebObjectInfo
        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
        Specified by:
        getPropertySetFilter in interface WebObjectInfo
        Since:
        MicroStrategy Web 8.0.3

      • setFlags

        public void setFlags​(int _flags)
        Description copied from interface: WebObjectInfo
        Sets the flags which determine what data to populate upon calling populate. This value should be the bitwise or(|) of values from EnumDSSXMLObjectFlags.
        Specified by:
        setFlags in interface WebObjectInfo
        Parameters:
        _flags - The flags value to use for object definition retrieval.
        See Also:
        WebObjectInfo.getFlags()

      • getParent

        public WebFolder getParent()
                    throws java.lang.UnsupportedOperationException
        Description copied from interface: WebObjectInfo
        Returns the parent folder of the current object, if it exists. Note that the WebFolder object returned will not be automatically populated.
        Specified by:
        getParent in interface WebObjectInfo
        Returns:
        The parent folder of the current object. If this is the root folder, then this method will return null.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the parent could not be found or retrieved for the object.

      • setDisplayName

        public void setDisplayName​(java.lang.String _displayName)
        Description copied from interface: WebDisplayUnit
        This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.
        Specified by:
        setDisplayName in interface WebDisplayUnit
        Parameters:
        _displayName - The display name to associate with the object.
        See Also:
        WebDisplayUnit.getDisplayName(), WebObjectInfo.getName()

      • getNonSchedulable

        public boolean getNonSchedulable()
        Description copied from interface: WebObjectInfo
        Get flag of whether the object is not schedulable
        Specified by:
        getNonSchedulable in interface WebObjectInfo
        Returns:
        whether the object is not schedulable

      • setNonSchedulable

        public void setNonSchedulable​(boolean non_schedulable)
        Description copied from interface: WebObjectInfo
        Set flag of whether the object is not schedulable
        Specified by:
        setNonSchedulable in interface WebObjectInfo

      • isAncestorNamedFolder

        public boolean isAncestorNamedFolder​(int folderName)
                              throws WebObjectsException,
                                     java.lang.UnsupportedOperationException
        Description copied from interface: WebObjectInfo
        Returns whether the named folder is this object's ancestor.
        Specified by:
        isAncestorNamedFolder in interface WebObjectInfo
        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.
        java.lang.UnsupportedOperationException - Thrown if the ancestors could not be found or retrieved for the object.

      • isFeatureAvailable

        public boolean isFeatureAvailable​(java.lang.String feature)
        Description copied from interface: WebFeatures
        Returns whether the given feature is available or not.
        Specified by:
        isFeatureAvailable in interface WebFeatures
        Parameters:
        feature - The feature to check for, from EnumWebObjectsFeatures.
        Returns:
        Whether the given feature is available.
        Since:
        MicroStrategy Web 8.0.0

      • isFeatureAvailable

        public boolean isFeatureAvailable​(java.lang.String feature,
                                  java.lang.Object dependencyObject)
        Description copied from interface: WebFeatures
        Returns whether the given feature is available or not.
        Specified by:
        isFeatureAvailable in interface WebFeatures
        Parameters:
        feature - The feature to check for, from EnumWebObjectsFeatures.
        dependencyObject - A dependency object which can be used as an additional parameter for certain feature types.
        Returns:
        Whether the given feature is available.
        Since:
        MicroStrategy Web 8.0.0

      • getXMLForSave

        protected java.lang.String getXMLForSave()

      • getXML

        public java.lang.String getXML()
        Description copied from interface: WebObjectInfo
        Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell.
        Specified by:
        getXML in interface WebObjectInfo
        Returns:
        The XML representation of the current state of this object.

      • getXML

        public java.lang.String getXML​(boolean encode)
        Description copied from interface: WebObjectInfo
        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.
        Specified by:
        getXML in interface WebObjectInfo
        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.

      • getExtParams

        protected java.lang.String getExtParams()

      • performIncrFetchLocally

        protected boolean performIncrFetchLocally()
        Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
        Returns:
        True if the incremental fetch should be performed on the Web Server Tier otherwise, false.
        Since:
        MicroStrategy Web 8.0.2

      • populate

        public void populate​(java.lang.String xml)
              throws WebObjectsException
        Description copied from interface: WebObjectInfo
        Populates the fields on this object by loading the given object definition XML.
        Specified by:
        populate in interface WebObjectInfo
        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.

      • isPopulated

        public boolean isPopulated()
        Description copied from interface: WebObjectInfo
        Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
        Specified by:
        isPopulated in interface WebObjectInfo
        Returns:
        The current population status of this object.

      • getAncestors

        public SimpleList getAncestors()
                        throws java.lang.UnsupportedOperationException
        Description copied from interface: WebObjectInfo
        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).
        Specified by:
        getAncestors in interface WebObjectInfo
        Returns:
        A SimpleList containing the ancestors of the object.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the ancestors could not be found or retrieved for the object.

      • addDetails

        public void addDetails​(boolean details)
                throws WebObjectsException
        Description copied from interface: WebDisplayUnit
        This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.
        Specified by:
        addDetails in interface WebDisplayUnit
        Parameters:
        details - The desired state of details for the display unit.
        Throws:
        WebObjectsException - Thrown if the details cannot be retrieved from the Intelligence Server.

      • postProcessOi

        protected void postProcessOi​(com.microstrategy.web.objects.WebObjectInfoImpl obj,
                             SAXSupport parser,
                             AttributesXt attrs)
                      throws org.xml.sax.SAXException
        Throws:
        org.xml.sax.SAXException
        Since:
        MicroStrategy Web 8.0.0

      • handleOiBody

        protected void handleOiBody​(SAXSupport parser,
                            java.lang.String local,
                            org.xml.sax.Attributes attrs)
                     throws org.xml.sax.SAXException
        Throws:
        org.xml.sax.SAXException

      • handleOiEnd

        protected void handleOiEnd​(SAXSupport parser,
                           java.lang.String local,
                           java.lang.String buf)

      • equals

        public boolean equals​(java.lang.Object otherObject)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • setAbbreviation

        public void setAbbreviation​(java.lang.String ab)
        Specified by:
        setAbbreviation in interface WebObjectInfo
        Since:
        MicroStrategy Web 7.5.2

      • checkAccessRights

        protected boolean checkAccessRights​(java.lang.String feature)
        Since:
        MicroStrategy Web 8.0.0

      • checkAccessFlags

        protected boolean checkAccessFlags​(int flags)
        Since:
        MicroStrategy Web 8.0.0

      • isDirty

        public boolean isDirty()
        Description copied from interface: WebObjectInfo
        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.
        Specified by:
        isDirty in interface WebObjectInfo
        Returns:
        boolean true returned when this object has been modified at client side. false returned when this object is the same as in metadata.
        Since:
        MicroStrategy Web 8.0.0

      • isNew

        public boolean isNew()
        Description copied from interface: WebObjectInfo
        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.
        Specified by:
        isNew in interface WebObjectInfo
        Returns:
        boolean true returned when this is a newly created object at client side. false returned when this object is persisted in metadata.
        Since:
        MicroStrategy Web 8.0.0

      • isBodyDirty

        protected boolean isBodyDirty()
        Since:
        MicroStrategy Web 8.0.0

      • createSAXParser

        protected com.microstrategy.web.objects.WebOISAXParser createSAXParser()
        Since:
        MicroStrategy Web 8.0.0

      • createDOMHandler

        protected com.microstrategy.web.objects.WebOIDOMHandler createDOMHandler()
        Since:
        MicroStrategy Web 8.0.0

      • createDisplayXMLHandler

        protected com.microstrategy.web.objects.WebOIDisplayXMLHandler createDisplayXMLHandler()
        Since:
        MicroStrategy Web 8.0.0

      • createXMLBuilder

        protected com.microstrategy.web.objects.WebOIXMLBuilder createXMLBuilder()
        Since:
        MicroStrategy Web 8.0.0

      • getIconPath

        public java.lang.String getIconPath()
        Description copied from interface: WebObjectInfo
        Return the icon path for the object
        Specified by:
        getIconPath in interface WebObjectInfo
        Returns:
        String containing the icon path for the object

      • setIconPath

        public void setIconPath​(java.lang.String iconPath)
        Description copied from interface: WebObjectInfo
        Set the icon path for the object
        Specified by:
        setIconPath in interface WebObjectInfo

      • setCardStatus

        public void setCardStatus​(int cardStatus)

      • setExtendedType

        public void setExtendedType​(int extendedType)
        Description copied from interface: WebObjectInfo
        Set the current extended type
        Specified by:
        setExtendedType in interface WebObjectInfo

      • setCertifiedInfo

        public void setCertifiedInfo​(WebCertifiedInfo certifiedInfo)

      • setTemplateInfo

        public void setTemplateInfo​(WebTemplateInfo templateInfo)

      • getProjectId

        public java.lang.String getProjectId()
        Specified by:
        getProjectId in interface WebObjectInfo
        Returns:
        project id of the object

      • getDefaultLanguage

        public java.lang.String getDefaultLanguage()
        Specified by:
        getDefaultLanguage in interface WebObjectInfo
        Returns:
        default language of the object

      • getProjectName

        public java.lang.String getProjectName()
        Specified by:
        getProjectName in interface WebObjectInfo
        Returns:
        project name of the object

      • setRecommendationInfo

        public void setRecommendationInfo​(WebRecommendationInfo recommendationInfo)

      • setProjectId

        public void setProjectId​(java.lang.String projectId)

      • isHighlighted

        public boolean isHighlighted()
        Description copied from interface: WebDisplayUnit
        Returns whether this unit is highlighted.
        Specified by:
        isHighlighted in interface WebDisplayUnit
        Returns:
        True if the display unit is highlighted, false otherwise.

      • highlightUnit

        public void highlightUnit()
        Description copied from interface: WebDisplayUnit
        Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.
        Specified by:
        highlightUnit in interface WebDisplayUnit

      • highlightUnit

        public void highlightUnit​(boolean details)
                   throws WebObjectsException
        Description copied from interface: WebDisplayUnit
        Sets this display unit to be highlighted. The details value will determine whether it should include details as well.
        Specified by:
        highlightUnit in interface WebDisplayUnit
        Parameters:
        details - Whether the highlighted unit should include details.
        Throws:
        WebObjectsException - Thrown if the details for a highlighted unit cannot be retrieved from the Intelligence Server.

      • isSelected

        public boolean isSelected()
        Description copied from interface: WebDisplayUnit
        Returns whether this display unit is selected.
        Specified by:
        isSelected in interface WebDisplayUnit
        Returns:
        True if the unit is selected, false otherwise.

      • setSelected

        public void setSelected​(boolean selected)
        Description copied from interface: WebDisplayUnit
        Sets the current unit's selection status.
        Specified by:
        setSelected in interface WebDisplayUnit
        Parameters:
        selected - Whether the unit should be set to be selected or not.

      • _getObKey

        public java.lang.Object _getObKey()
        Specified by:
        _getObKey in interface KeyedObject
        Since:
        MicroStrategy Web 8.0.0

      • getChildUnits

        public WebDisplayUnits getChildUnits()
                              throws WebObjectsException
        Description copied from interface: WebDisplayUnit
        Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.
        Specified by:
        getChildUnits in interface WebDisplayUnit
        Returns:
        The collection of child display units of this instance, or null if this object is not a collection.
        Throws:
        WebObjectsException

      • hasDetails

        public boolean hasDetails()
        Description copied from interface: WebDisplayUnit
        Returns whether this display unit currently has details enabled.
        Specified by:
        hasDetails in interface WebDisplayUnit
        Returns:
        True if details are enabled, false otherwise.

      • canHighlight

        public boolean canHighlight()
        Specified by:
        canHighlight in interface WebDisplayUnit
        Since:
        MicroStrategy Web 8.0.0

      • saveXMLState

        protected void saveXMLState​(WebXMLBuilder builder,
                            int howMuchState)