protected static class

AbstractMobileSubscriptionTask.SimpleSubscriptionTransform

extends Object
implements Transform
java.lang.Object
   ↳ com.microstrategy.web.app.tasks.AbstractMobileSubscriptionTask.SimpleSubscriptionTransform

Summary

Protected Constructors
SimpleSubscriptionTransform()
Public Methods
boolean canTransform(Transformable data)
Checks that the transform supports specified data object and that object is in the state supported by this transform.
String getDescription()
Returns a textual description of the transform.
FormalParameters getFormalParams()
Returns the collection of formal parameters associated with this transform.
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.
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(Class beanClass)
Returns true if the transform supports objects of specified type.
boolean supports(Transformable data)
Returns true if the transform supports the specified data object.
void transform(Transformable data, MarkupOutput transOut)
Transforms the data object and appends result to the transOut.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

Protected Constructors

protected SimpleSubscriptionTransform ()

Public Methods

public boolean canTransform (Transformable data)

Checks that the transform supports specified data object and that object is in the state supported by this transform.

Returns
  • true if the transform supports specified data object and the object is in the state supported by this transform.

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public FormalParameters getFormalParams ()

Returns the collection of formal parameters associated with this transform.

Returns
  • FormalParameters interface, which is a collection of formal parameters.

public String getID ()

Returns the unique name of the component to be used as the ID for its shell

Returns
  • the component's unique id

public MarkupOutput getPreview ()

Produces a preview output for this transform.

Returns
  • a MarkupOutput containing preview of this transform.
Throws
UnsupportedOperationException

public Class getSupportedBeanType ()

Returns a root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.

Returns
  • a root class/interface supported by this transform.

public boolean isPreviewAvailable ()

Returns true if this transform supports preview functionality, false otherwise.

Returns
  • true if this transform supports preview functionality, false otherwise.

public boolean isResolved ()

Returns whether each required formal parameter has a value associated with it.

Returns
  • whether each required formal parameter has a value.

public boolean supports (Class beanClass)

Returns true if the transform supports objects of specified type.

Parameters
beanClass the Java Class object representing bean type.
Returns
  • true if the transform supports objects of specified type.

public boolean supports (Transformable data)

Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.

Parameters
data a transformable object
Returns
  • true if the transform supports the data object, false otherwise.

public void transform (Transformable data, MarkupOutput transOut)

Transforms the data object and appends result to the transOut.

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
ClassCastException