Package org.pentaho.platform.api.repository

Interface IRuntimeElement

  • public interface IRuntimeElement

    • Method Detail

      • getParentId

        String getParentId()
        Returns:
        Returns the parent ID

      • setParentId

        void setParentId​(String parentId)
        Parameters:
        parentId - The parentId to set.

      • getParentType

        String getParentType()
        Returns:
        Returns the parent Type

      • setParentType

        void setParentType​(String parentType)
        Parameters:
        parentType - The parent type to set

      • getInstanceId

        String getInstanceId()
        Returns:
        Returns the instance Id

      • setInstanceId

        void setInstanceId​(String instanceId)
        Parameters:
        instanceId - The instance Id to set

      • getSolutionId

        String getSolutionId()
        Returns:
        Returns the solution Id.

      • setSolutionId

        void setSolutionId​(String solutionId)
        Parameters:
        solutionId - The solution Id to set

      • getRevision

        int getRevision()
        Returns:
        Returns the revision (updated by Hibernate)

      • getStringProperty

        String getStringProperty​(String key)
        Gets a string property from the Runtime Element.
        Parameters:
        key - The key of the property
        Returns:
        The value of the property, or NULL if the property doesn't exist.

      • getStringProperty

        String getStringProperty​(String key,
                         String defaultValue)
        Gets a string property from the Runtime Element.
        Parameters:
        key - The key of the property
        defaultValue - The value to return if the property doesn't exist
        Returns:
        The value of the property.

      • setStringProperty

        void setStringProperty​(String key,
                       String value)
        Sets a string property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.
        Parameters:
        key - The key of the property to set
        value - The value to associate with the key

      • getBigDecimalProperty

        BigDecimal getBigDecimalProperty​(String key)
        Gets a BigDecimal property from the Runtime Element.
        Parameters:
        key - The key of the property
        Returns:
        The value of the property, or null if the property doesn't exist.

      • getBigDecimalProperty

        BigDecimal getBigDecimalProperty​(String key,
                                 BigDecimal defaultValue)
        Gets a BigDecimal property from the Runtime Element.
        Parameters:
        key - The key of the property
        defaultValue - The value to return if the property doesn't exist
        Returns:
        The value of the property, or defaultValue if the property doesn't exist.

      • setBigDecimalProperty

        void setBigDecimalProperty​(String key,
                           BigDecimal value)
        Sets a BigDecimal property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.
        Parameters:
        key - The key of the property to set
        value - The value to associate with the key.

      • getDateProperty

        Date getDateProperty​(String key)
        Gets a Date property from the Runtime Element.
        Parameters:
        key - The key of the property
        Returns:
        The value of the property, or NULL if the property doesn't exist.

      • getDateProperty

        Date getDateProperty​(String key,
                     Date defaultValue)
        Gets a Date property from the Runtime Element.
        Parameters:
        key - The key of the property
        defaultValue - The value to return if the property doesn't exist
        Returns:
        The value of the property, or defaultValue if the property doesn't exist.

      • setDateProperty

        void setDateProperty​(String key,
                     Date value)
        Sets a Date property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.
        Parameters:
        key - The key of the property to set
        value - The value to associate with the key.

      • getLongProperty

        Long getLongProperty​(String key,
                     Long defaultValue)
        Gets a Long property from the Runtime Element.
        Parameters:
        key - The key of the property
        defaultValue - The value to return if the property doesn't exist
        Returns:
        The value of the property, or defaultValue if the property doesn't exist.

      • getLongProperty

        long getLongProperty​(String key,
                     long defaultValue)
        Gets a property from the paramMap as a long using a default value if it doesn't exist in the map
        Parameters:
        key - Key in the paramMap
        defaultValue - The default value if the property doesn't exist in the paramMap.
        Returns:
        The property in the map.

      • setLongProperty

        void setLongProperty​(String key,
                     Long value)
        Sets a Long property in the Runtime Element.
        Parameters:
        key - The key of the property to set
        value - The value to associate with the key.

      • setLongProperty

        void setLongProperty​(String key,
                     long value)
        Sets a Long property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.
        Parameters:
        key - The key of the property to set
        value - The value to associate with the key. Note - A new Long object is constructed and stored.

      • getListProperty

        List getListProperty​(String key)
        Gets a List property from the Runtime Element
        Parameters:
        key - The key of the property to get
        Returns:
        The list associated with the key, or NULL if it doesn't exist.

      • getMapProperty

        Map getMapProperty​(String key)
        Gets a Map property from the Runtime Element Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.
        Parameters:
        key - The key of the property to get
        Returns:
        The Map associated with the key, or NULL if it doesn't exist.

      • setListProperty

        void setListProperty​(String key,
                     List value)
        Sets a List Property in the Runtime Element
        Parameters:
        key - The key of the property to set
        value - The List value to associate with the key.

      • setMapProperty

        void setMapProperty​(String key,
                    Map value)
        Sets a Map Property in the Runtime Element Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.
        Parameters:
        key - The key of the property to set
        value - The Map value to associate with the key.

      • toXML

        String toXML()
        Returns:
        A string containing the XML representation of the Runtime Element

      • getLoggingLevel

        int getLoggingLevel()
        Returns:
        Returns the loggingLevel.

      • setAllowableAttributeNames

        void setAllowableAttributeNames​(Collection allowableReadAttributeNames)
        Parameters:
        allowableReadAttributeNames - The names of the attributes that this process is allowed to read.

      • getParameterNames

        Set getParameterNames()
        Returns:
        The set of currently defined parameter names

      • getParameterType

        String getParameterType​(String name)
        Gets the type of the parameter
        Parameters:
        name - Parameter name
        Returns:
        String type of the parameter

      • setLoaded

        void setLoaded​(boolean value)

      • getLoaded

        boolean getLoaded()

      • forceSave

        void forceSave()
        Causes an immediate call to the underlying persistence mechanism's write-now method. For Hibernate, this results in a call to HibernateUtil.flush().