Interface TransformDefns

  • All Superinterfaces:
    java.lang.Cloneable, ConfigurationElement
    All Known Implementing Classes:
    TransformDefnsImpl

    public interface TransformDefns
    extends ConfigurationElement
    The TransformDefns interface is used to manage a collection of transform definition objects.
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Detail

      • getCount

        int getCount()
        Returns the number of TransformDefn objects in the collection.
        Returns:
        number of TransformDefn objects contained in the collection.
        See Also:
        TransformDefn
      • getTransformDefn

        TransformDefn getTransformDefn​(int index)
                                throws java.lang.IndexOutOfBoundsException
        Retrieves a specific TransformDefn object by its numeric index.
        Parameters:
        index - the index of the TransformDefn object in collection.
        Returns:
        the TransformDefn object in the collection with the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - thrown if the index is invalid.
      • getTransformDefn

        TransformDefn getTransformDefn​(java.lang.String name)
                                throws java.lang.IllegalArgumentException
        Retrives a specific TransformDefn object by its name.
        Parameters:
        name - the name of the TransformDefn object.
        Returns:
        the TransformDefn object in the collection with the given name.
        Throws:
        java.lang.IllegalArgumentException - thrown if no transform definition has the given name in the collection.
      • clear

        void clear()
            throws java.lang.UnsupportedOperationException
        Removes all of the TransformDefn objects from the collection
        Throws:
        java.lang.UnsupportedOperationException - thrown if the collection is read-only.
      • remove

        void remove​(int index)
             throws java.lang.IndexOutOfBoundsException,
                    java.lang.UnsupportedOperationException
        Removes the TransformDefn object at the specified position in the collection. This method will not remove the associations made to the object deleted in a Style object.
        Parameters:
        index - the index of the TransformDefn object to remove.
        Throws:
        IndexOutOfBoundException - thrown if the specified index is out of range.
        java.lang.UnsupportedOperationException - thrown if the collection is read-only.
        java.lang.IndexOutOfBoundsException
      • remove

        void remove​(int index,
                    boolean removeStyles)
             throws java.lang.IndexOutOfBoundsException,
                    java.lang.UnsupportedOperationException
        Removes the TransformDefn object at the specified position in the collection.
        Parameters:
        index - the index of the TransformDefn object to remove.
        removeStyles - whether you want to remove the styles associated with the TransformDefn object deleted or not.
        Throws:
        IndexOutOfBoundException - thrown if the specified index is out of range.
        java.lang.UnsupportedOperationException - thrown if the collection is read-only.
        java.lang.IndexOutOfBoundsException
      • remove

        void remove​(java.lang.String name)
             throws java.lang.IllegalArgumentException,
                    java.lang.UnsupportedOperationException
        Removes the TransformDefn object with the specified name from the collection. This method will not remove the associations made to the object deleted in a Style object.
        Parameters:
        name - the name of the TransformDefn object to remove.
        Throws:
        java.lang.IllegalArgumentException - thrown if no transform definition has the given name in the collection.
        java.lang.UnsupportedOperationException - thrown if the collection is read-only.
      • remove

        void remove​(java.lang.String name,
                    boolean removeStyles)
             throws java.lang.IllegalArgumentException,
                    java.lang.UnsupportedOperationException
        Removes the TransformDefn object with the specified name from the collection.
        Parameters:
        name - the name of the TransformDefn object to remove.
        removeStyles - whether you want to remove the styles associated with the TransformDefn object deleted or not.
        Throws:
        java.lang.IllegalArgumentException - thrown if no transform definition has the given name in the collection.
        java.lang.UnsupportedOperationException - thrown if the collection is read-only.
      • newTransformDefn

        TransformDefn newTransformDefn​(java.lang.String transformName)
                                throws java.lang.IllegalArgumentException,
                                       java.lang.UnsupportedOperationException
        Creates a new TransformDefn object and adds it to the collection.
        Parameters:
        transformName - the name of the new TransformDefn object.
        Returns:
        the TransformDefn object just created.
        Throws:
        java.lang.IllegalArgumentException - thrown if the transform definition name is used by another TransformDefn object in the collection or if the style name is empty.
        java.lang.UnsupportedOperationException - thrown if the collection is read-only.