Package com.microstrategy.web.objects

Class WebPromptCustomStylesImpl

java.lang.Object

com.microstrategy.web.objects.WebPromptCustomStylesImpl

All Implemented Interfaces:

WebPromptCustomStyles

public class WebPromptCustomStylesImpl
extends java.lang.Object
implements WebPromptCustomStyles

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	customStylepropName
static java.lang.String	customStylePropSetName

Fields inherited from interface com.microstrategy.web.objects.WebPromptCustomStyles

AQ_PROMPT, CONSTANT_PROMPT, ELEMENT_PROMPT, HIERARCHICAL_PROMPT, MQ_PROMPT, OBJECT_PROMPT

Constructor Summary

Constructors

Constructor	Description
WebPromptCustomStylesImpl(WebIServerSession session)

Method Summary

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 type
WebPromptCustomStyle[]	getCustomStyles(java.lang.String promptType)	Returns the list of custom styles corresponding to referred prompt type
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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

customStylePropSetName

public static final java.lang.String customStylePropSetName

See Also:

Constant Field Values

customStylepropName

public static final java.lang.String customStylepropName

See Also:

Constant Field Values

Constructor Detail

WebPromptCustomStylesImpl

public WebPromptCustomStylesImpl(WebIServerSession session)

Method Detail

addCustomStyle

public void addCustomStyle(java.lang.String promptType,
                           java.lang.String baseStyle,
                           java.lang.String name,
                           java.lang.String description)
                    throws WebObjectsException

Description copied from interface: WebPromptCustomStyles

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

Specified by:

addCustomStyle in interface WebPromptCustomStyles

Parameters:

promptType - The type of prompt this style is for. This is a value of WebPromptCustomStyles.CONSTANT_PROMPT, WebPromptCustomStyles.OBJECT_PROMPT, WebPromptCustomStyles.ELEMENT_PROMPT, WebPromptCustomStyles.MQ_PROMPT, WebPromptCustomStyles.AQ_PROMPT and WebPromptCustomStyles.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.

getAllCustomStyles

public WebPromptCustomStyle[] getAllCustomStyles()

Specified by:

getAllCustomStyles in interface WebPromptCustomStyles

getCustomStyles

public WebPromptCustomStyle[] getCustomStyles(java.lang.String promptType)

Description copied from interface: WebPromptCustomStyles

Returns the list of custom styles corresponding to referred prompt type

Specified by:

getCustomStyles in interface WebPromptCustomStyles

Parameters:

promptType - The prompt type which the returned custom styles defined for. This is a value of WebPromptCustomStyles.CONSTANT_PROMPT, WebPromptCustomStyles.OBJECT_PROMPT, WebPromptCustomStyles.ELEMENT_PROMPT, WebPromptCustomStyles.MQ_PROMPT, WebPromptCustomStyles.AQ_PROMPT and WebPromptCustomStyles.HIERARCHICAL_PROMPT.

Returns:

The list of custom styles for this prompt type.

getCustomStyles

public WebPromptCustomStyle[] getCustomStyles(java.lang.String promptType,
                                              java.lang.String baseStyle)

Description copied from interface: WebPromptCustomStyles

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

Specified by:

getCustomStyles in interface WebPromptCustomStyles

Parameters:

promptType - The prompt type which the returned custom styles defined for. This is a value of WebPromptCustomStyles.CONSTANT_PROMPT, WebPromptCustomStyles.OBJECT_PROMPT, WebPromptCustomStyles.ELEMENT_PROMPT, WebPromptCustomStyles.MQ_PROMPT, WebPromptCustomStyles.AQ_PROMPT and WebPromptCustomStyles.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.

getBaseStyles

public java.lang.String[] getBaseStyles(java.lang.String promptType)

Description copied from interface: WebPromptCustomStyles

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

Specified by:

getBaseStyles in interface WebPromptCustomStyles

Parameters:

promptType - the type of prompt this style is for. This is a value of WebPromptCustomStyles.CONSTANT_PROMPT, WebPromptCustomStyles.OBJECT_PROMPT, WebPromptCustomStyles.ELEMENT_PROMPT, WebPromptCustomStyles.MQ_PROMPT, WebPromptCustomStyles.AQ_PROMPT and WebPromptCustomStyles.HIERARCHICAL_PROMPT.

Returns:

The array of base style names

getPromptTypes

public java.lang.String[] getPromptTypes()

Description copied from interface: WebPromptCustomStyles

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

Specified by:

getPromptTypes in interface WebPromptCustomStyles

Returns:

The list of prompt types. The value in this array is from WebPromptCustomStyles.CONSTANT_PROMPT, WebPromptCustomStyles.OBJECT_PROMPT, WebPromptCustomStyles.ELEMENT_PROMPT, WebPromptCustomStyles.MQ_PROMPT, WebPromptCustomStyles.AQ_PROMPT and WebPromptCustomStyles.HIERARCHICAL_PROMPT.

removeCustomStyle

public void removeCustomStyle(java.lang.String promptType,
                              java.lang.String baseStyle,
                              java.lang.String name)
                       throws WebObjectsException

Description copied from interface: WebPromptCustomStyles

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

Specified by:

removeCustomStyle in interface WebPromptCustomStyles

Parameters:

promptType - The type of prompt this style is for. This is a value of WebPromptCustomStyles.CONSTANT_PROMPT, WebPromptCustomStyles.OBJECT_PROMPT, WebPromptCustomStyles.ELEMENT_PROMPT, WebPromptCustomStyles.MQ_PROMPT, WebPromptCustomStyles.AQ_PROMPT and WebPromptCustomStyles.HIERARCHICAL_PROMPT.

baseStyle - TODO

name - The name of the custom style to be removed.

Throws:

WebObjectsException - Exception thrown when error happens during the operation.