public interface

WebPromptCustomStyles

com.microstrategy.web.objects.WebPromptCustomStyles
Known Indirect Subclasses

Summary

Constants
String AQ_PROMPT
String CONSTANT_PROMPT
String ELEMENT_PROMPT
String HIERARCHICAL_PROMPT
String MQ_PROMPT
String OBJECT_PROMPT
Public Methods
abstract void addCustomStyle(String promptType, String baseStyle, String name, String description)
Add a new custom style.
abstract WebPromptCustomStyle[] getAllCustomStyles()
abstract String[] getBaseStyles(String promptType)
Returns the base styles referred by custom styles for a certain prompt type
abstract WebPromptCustomStyle[] getCustomStyles(String promptType)
Returns the list of custom styles corresponding to referred prompt type
abstract WebPromptCustomStyle[] getCustomStyles(String promptType, String baseStyle)
Returns the list of custom styls corresponding to the referred prompt type and base style.
abstract String[] getPromptTypes()
Returns the list of prompt types, for which there is at least one custom styles for.
abstract void removeCustomStyle(String promptType, String baseStyle, String name)
Remove a certain custom style from the repository.

Constants

public static final String AQ_PROMPT

Constant Value: "Attribute Qualification"

public static final String CONSTANT_PROMPT

Constant Value: "Constant"

public static final String ELEMENT_PROMPT

Constant Value: "Element"

public static final String HIERARCHICAL_PROMPT

Constant Value: "Hierarchical"

public static final String MQ_PROMPT

Constant Value: "Metric Qualification"

public static final String OBJECT_PROMPT

Constant Value: "Object"

Public Methods

public abstract 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
Throws
WebObjectsException Exception thrown when error happens during the operation.

public abstract WebPromptCustomStyle[] getAllCustomStyles ()

public abstract 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 abstract 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 abstract 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 abstract String[] getPromptTypes ()

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

Returns

public abstract 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.
Throws
WebObjectsException Exception thrown when error happens during the operation.