Package com.microstrategy.web.app.tasks

Class AbstractMobileSubscriptionTask.SimpleSubscriptionTransform

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canTransform​(Transformable data)
      Checks that the transform supports specified data object and that object is in the state supported by this transform.
      java.lang.String getDescription()
      Returns a textual description of the transform.
      FormalParameters getFormalParams()
      Returns the collection of formal parameters associated with this transform.
      java.lang.String getID()
      Returns the unique name of the component to be used as the ID for its shell
      MarkupOutput getPreview()
      Produces a preview output for this transform.
      java.lang.Class getSupportedBeanType()
      Returns a root class/interface supported by this transform.
      boolean isPreviewAvailable()
      Returns true if this transform supports preview functionality, false otherwise.
      boolean isResolved()
      Returns whether each required formal parameter has a value associated with it.
      boolean supports​(Transformable data)
      Returns true if the transform supports the specified data object.
      boolean supports​(java.lang.Class beanClass)
      Returns true if the transform supports objects of specified type.
      void transform​(Transformable data, MarkupOutput transOut)
      Transforms the data object and appends result to the transOut.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SimpleSubscriptionTransform

        protected SimpleSubscriptionTransform()

    • Method Detail

      • canTransform

        public boolean canTransform​(Transformable data)
        Description copied from interface: Transform
        Checks that the transform supports specified data object and that object is in the state supported by this transform.
        Specified by:
        canTransform in interface Transform
        Returns:
        true if the transform supports specified data object and the object is in the state supported by this transform.

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Specified by:
        getDescription in interface Transform
        Returns:
        The textual description of the transform.

      • getFormalParams

        public FormalParameters getFormalParams()
        Description copied from interface: Transform
        Returns the collection of formal parameters associated with this transform.
        Specified by:
        getFormalParams in interface Transform
        Returns:
        FormalParameters interface, which is a collection of formal parameters.

      • getID

        public java.lang.String getID()
        Description copied from interface: Transform
        Returns the unique name of the component to be used as the ID for its shell
        Specified by:
        getID in interface Transform
        Returns:
        the component's unique id

      • getPreview

        public MarkupOutput getPreview()
                        throws java.lang.UnsupportedOperationException
        Description copied from interface: Transform
        Produces a preview output for this transform.
        Specified by:
        getPreview in interface Transform
        Returns:
        a MarkupOutput containing preview of this transform.
        Throws:
        java.lang.UnsupportedOperationException - in case the transform does not support preview functionality

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Description copied from interface: Transform
        Returns a root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.
        Specified by:
        getSupportedBeanType in interface Transform
        Returns:
        a root class/interface supported by this transform.

      • isPreviewAvailable

        public boolean isPreviewAvailable()
        Description copied from interface: Transform
        Returns true if this transform supports preview functionality, false otherwise.
        Specified by:
        isPreviewAvailable in interface Transform
        Returns:
        true if this transform supports preview functionality, false otherwise.

      • isResolved

        public boolean isResolved()
        Description copied from interface: Transform
        Returns whether each required formal parameter has a value associated with it.
        Specified by:
        isResolved in interface Transform
        Returns:
        whether each required formal parameter has a value.

      • supports

        public boolean supports​(java.lang.Class beanClass)
        Description copied from interface: Transform
        Returns true if the transform supports objects of specified type.
        Specified by:
        supports in interface Transform
        Parameters:
        beanClass - the Java Class object representing bean type.
        Returns:
        true if the transform supports objects of specified type.

      • transform

        public void transform​(Transformable data,
                      MarkupOutput transOut)
               throws java.lang.ClassCastException
        Description copied from interface: Transform
        Transforms the data object and appends result to the transOut.
        Specified by:
        transform in interface Transform
        Parameters:
        data - an object to transform. It must be of proper type supported by the concrete transform this method called on, or ClassCastExcetption will be thrown
        transOut - the MarkupOutput object where the transform result will be added.
        Throws:
        java.lang.ClassCastException - if data is of the wrong type.