Package com.microstrategy.web.objects
Interface WebPromptCustomStyles
-
- All Known Implementing Classes:
WebPromptCustomStylesImpl
public interface WebPromptCustomStyles
- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
AQ_PROMPT
static java.lang.String
CONSTANT_PROMPT
static java.lang.String
ELEMENT_PROMPT
static java.lang.String
HIERARCHICAL_PROMPT
static java.lang.String
MQ_PROMPT
static java.lang.String
OBJECT_PROMPT
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCustomStyle(java.lang.String promptType, java.lang.String baseStyle, java.lang.String name, java.lang.String description)
Add a new custom style.WebPromptCustomStyle[]
getAllCustomStyles()
java.lang.String[]
getBaseStyles(java.lang.String promptType)
Returns the base styles referred by custom styles for a certain prompt typeWebPromptCustomStyle[]
getCustomStyles(java.lang.String promptType)
Returns the list of custom styles corresponding to referred prompt typeWebPromptCustomStyle[]
getCustomStyles(java.lang.String promptType, java.lang.String baseStyle)
Returns the list of custom styls corresponding to the referred prompt type and base style.java.lang.String[]
getPromptTypes()
Returns the list of prompt types, for which there is at least one custom styles for.void
removeCustomStyle(java.lang.String promptType, java.lang.String baseStyle, java.lang.String name)
Remove a certain custom style from the repository.
-
-
-
Field Detail
-
CONSTANT_PROMPT
static final java.lang.String CONSTANT_PROMPT
- See Also:
- Constant Field Values
-
OBJECT_PROMPT
static final java.lang.String OBJECT_PROMPT
- See Also:
- Constant Field Values
-
ELEMENT_PROMPT
static final java.lang.String ELEMENT_PROMPT
- See Also:
- Constant Field Values
-
MQ_PROMPT
static final java.lang.String MQ_PROMPT
- See Also:
- Constant Field Values
-
AQ_PROMPT
static final java.lang.String AQ_PROMPT
- See Also:
- Constant Field Values
-
HIERARCHICAL_PROMPT
static final java.lang.String HIERARCHICAL_PROMPT
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAllCustomStyles
WebPromptCustomStyle[] getAllCustomStyles()
-
getCustomStyles
WebPromptCustomStyle[] getCustomStyles(java.lang.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 ofCONSTANT_PROMPT
,OBJECT_PROMPT
,ELEMENT_PROMPT
,MQ_PROMPT
,AQ_PROMPT
andHIERARCHICAL_PROMPT
.- Returns:
- The list of custom styles for this prompt type.
-
getCustomStyles
WebPromptCustomStyle[] getCustomStyles(java.lang.String promptType, java.lang.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 ofCONSTANT_PROMPT
,OBJECT_PROMPT
,ELEMENT_PROMPT
,MQ_PROMPT
,AQ_PROMPT
andHIERARCHICAL_PROMPT
.baseStyle
- The base style this custom style inherited from.- Returns:
- The list of custom styles for this prompt type and this base style.
-
addCustomStyle
void addCustomStyle(java.lang.String promptType, java.lang.String baseStyle, java.lang.String name, java.lang.String description) throws WebObjectsException
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 ofCONSTANT_PROMPT
,OBJECT_PROMPT
,ELEMENT_PROMPT
,MQ_PROMPT
,AQ_PROMPT
andHIERARCHICAL_PROMPT
.baseStyle
- The base style name, which the custom style inherited from.name
- The name of the new custom styledescription
- The description of the new custom style- Throws:
WebObjectsException
- Exception thrown when error happens during the operation.
-
removeCustomStyle
void removeCustomStyle(java.lang.String promptType, java.lang.String baseStyle, java.lang.String name) throws WebObjectsException
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 ofCONSTANT_PROMPT
,OBJECT_PROMPT
,ELEMENT_PROMPT
,MQ_PROMPT
,AQ_PROMPT
andHIERARCHICAL_PROMPT
.baseStyle
- TODOname
- The name of the custom style to be removed.- Throws:
WebObjectsException
- Exception thrown when error happens during the operation.
-
getBaseStyles
java.lang.String[] getBaseStyles(java.lang.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 ofCONSTANT_PROMPT
,OBJECT_PROMPT
,ELEMENT_PROMPT
,MQ_PROMPT
,AQ_PROMPT
andHIERARCHICAL_PROMPT
.- Returns:
- The array of base style names
-
getPromptTypes
java.lang.String[] getPromptTypes()
Returns the list of prompt types, for which there is at least one custom styles for.- Returns:
- The list of prompt types. The value in this array is from
CONSTANT_PROMPT
,OBJECT_PROMPT
,ELEMENT_PROMPT
,MQ_PROMPT
,AQ_PROMPT
andHIERARCHICAL_PROMPT
.
-
-