public class

WebPromptCustomStylesImpl

extends Object
implements WebPromptCustomStyles
java.lang.Object
   ↳ com.microstrategy.web.objects.WebPromptCustomStylesImpl

Summary

Constants
String customStylePropSetName
String customStylepropName
[Expand]
Inherited Constants
From interface com.microstrategy.web.objects.WebPromptCustomStyles
Public Constructors
WebPromptCustomStylesImpl(WebIServerSession session)
Public Methods
void addCustomStyle(String promptType, String baseStyle, String name, String description)
Add a new custom style.
WebPromptCustomStyle[] getAllCustomStyles()
String[] getBaseStyles(String promptType)
Returns the base styles referred by custom styles for a certain prompt type
WebPromptCustomStyle[] getCustomStyles(String promptType, String baseStyle)
Returns the list of custom styls corresponding to the referred prompt type and base style.
WebPromptCustomStyle[] getCustomStyles(String promptType)
Returns the list of custom styles corresponding to referred prompt type
String[] getPromptTypes()
Returns the list of prompt types, for which there is at least one custom styles for.
void removeCustomStyle(String promptType, String baseStyle, String name)
Remove a certain custom style from the repository.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.objects.WebPromptCustomStyles

Constants

public static final String customStylePropSetName

Constant Value: "WebProperties"

public static final String customStylepropName

Constant Value: "WebPromptAvailableCustomStyles"

Public Constructors

public WebPromptCustomStylesImpl (WebIServerSession session)

Public Methods

public void addCustomStyle (String promptType, String baseStyle, String name, String description)

Add a new custom style. The change will be saved into metadata immediately

Parameters
promptType The type of prompt this style is for. This is a value of CONSTANT_PROMPT, OBJECT_PROMPT, ELEMENT_PROMPT, MQ_PROMPT, AQ_PROMPT and HIERARCHICAL_PROMPT.
baseStyle The base style name, which the custom style inherited from.
name The name of the new custom style
description The description of the new custom style

public WebPromptCustomStyle[] getAllCustomStyles ()

public String[] getBaseStyles (String promptType)

Returns the base styles referred by custom styles for a certain prompt type

Parameters
promptType the type of prompt this style is for. This is a value of CONSTANT_PROMPT, OBJECT_PROMPT, ELEMENT_PROMPT, MQ_PROMPT, AQ_PROMPT and HIERARCHICAL_PROMPT.
Returns
  • The array of base style names

public WebPromptCustomStyle[] getCustomStyles (String promptType, String baseStyle)

Returns the list of custom styls corresponding to the referred prompt type and base style.

Parameters
promptType The prompt type which the returned custom styles defined for. This is a value of CONSTANT_PROMPT, OBJECT_PROMPT, ELEMENT_PROMPT, MQ_PROMPT, AQ_PROMPT and HIERARCHICAL_PROMPT.
baseStyle The base style this custom style inherited from.
Returns
  • The list of custom styles for this prompt type and this base style.

public WebPromptCustomStyle[] getCustomStyles (String promptType)

Returns the list of custom styles corresponding to referred prompt type

Parameters
promptType The prompt type which the returned custom styles defined for. This is a value of CONSTANT_PROMPT, OBJECT_PROMPT, ELEMENT_PROMPT, MQ_PROMPT, AQ_PROMPT and HIERARCHICAL_PROMPT.
Returns
  • The list of custom styles for this prompt type.

public String[] getPromptTypes ()

Returns the list of prompt types, for which there is at least one custom styles for.

Returns

public void removeCustomStyle (String promptType, String baseStyle, String name)

Remove a certain custom style from the repository. The change will be saved to metadata immediately.

Parameters
promptType The type of prompt this style is for. This is a value of CONSTANT_PROMPT, OBJECT_PROMPT, ELEMENT_PROMPT, MQ_PROMPT, AQ_PROMPT and HIERARCHICAL_PROMPT.
baseStyle TODO
name The name of the custom style to be removed.