ScheduleWidget
implements GuiElement| com.microstrategy.web.app.gui.ScheduleWidget |
This interface is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
Class Overview
Renders a Widget to edit Web Subscriptions.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int | getInitialiIndent() | ||||||||||
| abstract String | getMobileArg() | ||||||||||
| abstract String | getObjectName() | ||||||||||
| abstract String | getRWDFormatArg() | ||||||||||
| abstract String | getReuseMessage() | ||||||||||
| abstract String | getReuseMessageArg() | ||||||||||
| abstract int |
getSubscriptionObjectType()
Returns if the current subscription is for a report or for a document.
| ||||||||||
| abstract String | getTriggerArg() | ||||||||||
| abstract String |
getTriggerId()
Gets the current triggerId
| ||||||||||
| abstract SimpleList |
getTriggers()
Gets the current global list of triggers.
| ||||||||||
| abstract void |
renderObjectName(MarkupOutput out, String name)
Renders the name of the object for which the subscription is being created.
| ||||||||||
| abstract void |
renderTriggerList(MarkupOutput out, SimpleList triggers, String triggerId, String argTrigger)
Renders the list of triggers.
| ||||||||||
| abstract void |
setExecutionFlags(int executionFlags)
sets the execution flags (used to pass on flags from existing schedule).
| ||||||||||
| abstract void |
setInitialiIndent(int value)
Defines the initial indent the widget uses to render the content
| ||||||||||
| abstract void |
setMobileArg(String value)
The name of the "mobile" argument
| ||||||||||
| abstract void |
setObjectName(String value)
Sets the name of the object for which the subscription is created.
| ||||||||||
| abstract void |
setRWDFormatArg(String value)
The name of the "rwdFormatArg" argument
| ||||||||||
| abstract void |
setReuseMessage(String value)
Defines whether the current message should be reused when a new
schedule is triggered
| ||||||||||
| abstract void |
setReuseMessageArg(String value)
The name of the "reuseMessage" argument
| ||||||||||
| abstract void |
setSubscriptionObjectType(int subscriptionObjectType)
Sets if the current subscription is for a report or for a document.
| ||||||||||
| abstract void |
setTriggerArg(String value)
Sets the name of the triggerId argument
| ||||||||||
| abstract void |
setTriggerId(String value)
Sets the current triggerId of the widget.
| ||||||||||
| abstract void |
setTriggers(SimpleList value)
Set the global list of triggers.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.microstrategy.web.app.gui.GuiElement
| |||||||||||
Public Methods
public abstract int getInitialiIndent ()
Returns
- The current base indent use by the widget to render its content.
public abstract String getMobileArg ()
Returns
- the current name of the "mobile" argument.
public abstract String getObjectName ()
Returns
- the name of the object for which the subscription is created.
public abstract String getRWDFormatArg ()
Returns
- the current name of the "reuseMessage" argument.
public abstract String getReuseMessage ()
Returns
- "1" if the current message will be reused when the schedule is trigger and saved in the inbox. Otherwise a new message will be created each time the schedule is triggered.
public abstract String getReuseMessageArg ()
Returns
- the current name of the "reuseMessage" argument.
public abstract int getSubscriptionObjectType ()
Returns if the current subscription is for a report or for a document. The value is specified by the enumeration
EnumWebSubscriptionContentTypes
Returns
- The type of object (report or document) for which we are creating the subscription
public abstract String getTriggerArg ()
Returns
- value the current triggerId argument name
public abstract String getTriggerId ()
Gets the current triggerId
Returns
- the current triggerId
public abstract SimpleList getTriggers ()
Gets the current global list of triggers.
Returns
- a list of triggers
public abstract void renderObjectName (MarkupOutput out, String name)
Renders the name of the object for which the subscription is being created.
This method can be called stand alone by passing the required arguments.
It's also part of the renderElement() method that passes the
global widget values properties as the arguments.
Parameters
| out | Where to write the widget's output |
|---|---|
| name | The name of the object |
public abstract void renderTriggerList (MarkupOutput out, SimpleList triggers, String triggerId, String argTrigger)
Renders the list of triggers. This method is internally called with the
global list of triggers and the current triggerId by the renderElement() method.
It can be called independentaly by passing the list of triggers and the triggerId.
Parameters
| out | where to write the output |
|---|---|
| triggers | the list of triggers to render |
| triggerId | the selected triggerId |
| argTrigger | the name of the triggerId argumetn |
public abstract void setExecutionFlags (int executionFlags)
sets the execution flags (used to pass on flags from existing schedule).
public abstract void setInitialiIndent (int value)
Defines the initial indent the widget uses to render the content
Parameters
| value | the new base indent to use |
|---|
public abstract void setMobileArg (String value)
The name of the "mobile" argument
Parameters
| value | the new name of the argument |
|---|
public abstract void setObjectName (String value)
Sets the name of the object for which the subscription is created.
Parameters
| value | the name of the object for which the subscription is created |
|---|
public abstract void setRWDFormatArg (String value)
The name of the "rwdFormatArg" argument
Parameters
| value | the new name of the argument |
|---|
public abstract void setReuseMessage (String value)
Defines whether the current message should be reused when a new schedule is triggered
Parameters
| value | "1" if the message should be reused. |
|---|
public abstract void setReuseMessageArg (String value)
The name of the "reuseMessage" argument
Parameters
| value | the new name of the argument |
|---|
public abstract void setSubscriptionObjectType (int subscriptionObjectType)
Sets if the current subscription is for a report or for a document. The value is specified by the enumeration
EnumWebSubscriptionContentTypes
Parameters
| subscriptionObjectType | The type of object for which we are creating the subscription |
|---|
public abstract void setTriggerArg (String value)
Sets the name of the triggerId argument
Parameters
| value | the new trigger argument name |
|---|
public abstract void setTriggerId (String value)
Sets the current triggerId of the widget.
Parameters
| value | the new triggerId |
|---|
public abstract void setTriggers (SimpleList value)
Set the global list of triggers.
Parameters
| value | the new list of triggers |
|---|