```
public interface FilterDetailsFormatting
```
This interface governs filter detail formatting properties.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALWAYS`	Always shown/applied.
`static int`	`CLEAR`	Clears the formatting attribute.
`static char`	`DELIMITER`
`static java.lang.String`	`DELIMITER_STR`
`static int`	`FALSE`	Condition is false.
`static java.lang.String`	`KEY_EXPAND_SHORTCUT_FILTERS`
`static java.lang.String`	`KEY_INCLUDE_FORM_NAMES_IN_AQ_CONDITIONS`
`static java.lang.String`	`KEY_LOGICAL_OPERATOR_BETWEEN_CONDITIONS`
`static java.lang.String`	`KEY_NEWLINE_ATTR_NAME`
`static java.lang.String`	`KEY_NEWLINE_BETWEEN_CONDITIONS`
`static java.lang.String`	`KEY_NEWLINE_BETWEEN_ELEMENTS`
`static java.lang.String`	`KEY_OPERATOR_NAME_OR_SYMBOL`
`static java.lang.String`	`KEY_PARENTHESES_AROUND_CONDITIONS`
`static java.lang.String`	`KEY_SHOW_ATTR_NAME_FOR_ELEMENT_PROMPTS`
`static java.lang.String`	`KEY_SHOW_ATTR_NAME_FOR_IN_LIST`
`static java.lang.String`	`KEY_TRIM_ELEMENTS`
`static java.lang.String`	`KEY_USE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES`
`static int`	`MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY`	Metadata object names are only delimited if the name contains special characters.
`static int`	`MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND`	Shows both the name and expansion.
`static int`	`MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY`	Display logical AND operators only.
`static int`	`MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY`	Display logical OR operators only.
`static int`	`MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY`	Newlines are inserted between conditions for different logical operator nodes only.
`static int`	`MODE_OPERATOR_DISPLAY_NAME`	Operators are displayed with their names.
`static int`	`MODE_OPERATOR_DISPLAY_SYMBOL`	Operators are displayed using symbols.
`static int`	`MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY`	Indicates parentheses are enclosed around conditions that are children of the same logical operator node only.
`static int`	`NEVER`	Never shown/applied.
`static int`	`ONCE`	Shown/applied once.
`static int`	`REPEATED`	Item is repeated.
`static int`	`TRUE`	Condition true.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`delimitersAroundMetadataObjectNames()`	When to use delimiters around metadata object names.
`int`	`expandShortcutFilters()`	When to expand shortcut filters.
`int`	`includeFormNamesInAQConditions()`	Whether to include form names in attribute qualification conditions.
`int`	`logicalOperatorBetweenConditions()`	When to display logical operators.
`int`	`newlineAttrName()`	Whether there is a newline after the Attr name.
`int`	`newlineBetweenConditions()`	When newlines are inserted between conditions.
`int`	`newlineBetweenElements()`	Default is `FALSE`.
`int`	`operatorDisplay()`	Describes how operators are displayed, i.e. as symbols or names.
`int`	`parenthesesAroundConditions()`	When parentheses are displayed around conditions.
`void`	`set(java.lang.String key, java.lang.String value)`	Generic approach to setting a value corresponding to a key instead of using the specific setter method
`void`	`setDelimitersAroundMetadataObjectNames(int delimiterCondition)`	Governs when to use delimiters around metadata object names.
`void`	`setExpandShortcutFilters(int mode)`	Governs when to expand shortcut filters.
`void`	`setIncludeFormNamesInAttrQualificationConditions(int includeFormNames)`	Governs whether to include form names in attribute qualification conditions.
`void`	`setLogicalOperatorBetweenConditions(int mode)`	Governs when to display logical operators.
`void`	`setNewlineAttrName(int mode)`	Governs whether there is a newline after the Attr name.
`void`	`setNewlineBetweenConditions(int mode)`	Governs when newlines are inserted between conditions.
`void`	`setNewlineBetweenElements(int mode)`	Governs whether there is a newline between elements.
`void`	`setOperatorDisplay(int mode)`	Governs how operators are displayed, i.e. as symbols or names.
`void`	`setParenthesesAroundConditions(int mode)`	This governs usage of parentheses around conditions.
`void`	`setShowAttrNameForElementPrompts(int mode)`	Whether to show Attr name for Attr element prompts according to specified argument.
`void`	`setShowAttrNameForInList(int mode)`	Whether to show Attr name for in list conditions according to specified argument.
`void`	`setTrimElements(int mode)`	Governs whether whitespaces are trimmed from elements.
`int`	`showAttrNameForElementPrompts()`	Whether to show Attr element names for Attr element prompts.
`int`	`showAttrNameForInList()`	Whether to show Attr names for list conditions.
`int`	`trimElements()`	Whether whitespaces are trimmed from elements.

- Field Detail
  - DELIMITER
```
static final char DELIMITER
```
    See Also:
    
    Constant Field Values
  - DELIMITER_STR
```
static final java.lang.String DELIMITER_STR
```
  - CLEAR
```
static final int CLEAR
```
    Clears the formatting attribute. If this is a RWUnit, then the actual format setting will be inherited from the underlying document. If this is a document format, it will be inherited from the project.
    
    See Also:
    
    Constant Field Values
  - REPEATED
```
static final int REPEATED
```
    Item is repeated. Value = 2.
    
    See Also:
    
    Constant Field Values
  - NEVER
```
static final int NEVER
```
    Never shown/applied. Value = 0.
    
    See Also:
    
    Constant Field Values
  - ALWAYS
```
static final int ALWAYS
```
    Always shown/applied. Value = 1.
    
    See Also:
    
    Constant Field Values
  - ONCE
```
static final int ONCE
```
    Shown/applied once. Value = 1.
    
    See Also:
    
    Constant Field Values
  - FALSE
```
static final int FALSE
```
    Condition is false. Value = 0.
    
    See Also:
    
    Constant Field Values
  - TRUE
```
static final int TRUE
```
    Condition true. Value = 1.
    
    See Also:
    
    Constant Field Values
  - MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY
```
static final int MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY
```
    Indicates parentheses are enclosed around conditions that are children of the same logical operator node only. Value = 2.
    
    See Also:
    
    Constant Field Values
  - MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY
```
static final int MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY
```
    Newlines are inserted between conditions for different logical operator nodes only. Value = 2.
    
    See Also:
    
    Constant Field Values
  - MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY
```
static final int MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY
```
    Display logical AND operators only. Value = 2.
    
    See Also:
    
    Constant Field Values
  - MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY
```
static final int MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY
```
    Display logical OR operators only. Value = 3.
    
    See Also:
    
    Constant Field Values
  - MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND
```
static final int MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND
```
    Shows both the name and expansion.
    
    See Also:
    
    Constant Field Values
  - MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY
```
static final int MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY
```
    Metadata object names are only delimited if the name contains special characters.
    
    See Also:
    
    Constant Field Values
  - MODE_OPERATOR_DISPLAY_SYMBOL
```
static final int MODE_OPERATOR_DISPLAY_SYMBOL
```
    Operators are displayed using symbols.
    
    See Also:
    
    Constant Field Values
  - MODE_OPERATOR_DISPLAY_NAME
```
static final int MODE_OPERATOR_DISPLAY_NAME
```
    Operators are displayed with their names.
    
    See Also:
    
    Constant Field Values
  - KEY_SHOW_ATTR_NAME_FOR_IN_LIST
```
static final java.lang.String KEY_SHOW_ATTR_NAME_FOR_IN_LIST
```
    See Also:
    
    Constant Field Values
  - KEY_SHOW_ATTR_NAME_FOR_ELEMENT_PROMPTS
```
static final java.lang.String KEY_SHOW_ATTR_NAME_FOR_ELEMENT_PROMPTS
```
    See Also:
    
    Constant Field Values
  - KEY_NEWLINE_ATTR_NAME
```
static final java.lang.String KEY_NEWLINE_ATTR_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_NEWLINE_BETWEEN_ELEMENTS
```
static final java.lang.String KEY_NEWLINE_BETWEEN_ELEMENTS
```
    See Also:
    
    Constant Field Values
  - KEY_TRIM_ELEMENTS
```
static final java.lang.String KEY_TRIM_ELEMENTS
```
    See Also:
    
    Constant Field Values
  - KEY_OPERATOR_NAME_OR_SYMBOL
```
static final java.lang.String KEY_OPERATOR_NAME_OR_SYMBOL
```
    See Also:
    
    Constant Field Values
  - KEY_INCLUDE_FORM_NAMES_IN_AQ_CONDITIONS
```
static final java.lang.String KEY_INCLUDE_FORM_NAMES_IN_AQ_CONDITIONS
```
    See Also:
    
    Constant Field Values
  - KEY_PARENTHESES_AROUND_CONDITIONS
```
static final java.lang.String KEY_PARENTHESES_AROUND_CONDITIONS
```
    See Also:
    
    Constant Field Values
  - KEY_NEWLINE_BETWEEN_CONDITIONS
```
static final java.lang.String KEY_NEWLINE_BETWEEN_CONDITIONS
```
    See Also:
    
    Constant Field Values
  - KEY_LOGICAL_OPERATOR_BETWEEN_CONDITIONS
```
static final java.lang.String KEY_LOGICAL_OPERATOR_BETWEEN_CONDITIONS
```
    See Also:
    
    Constant Field Values
  - KEY_EXPAND_SHORTCUT_FILTERS
```
static final java.lang.String KEY_EXPAND_SHORTCUT_FILTERS
```
    See Also:
    
    Constant Field Values
  - KEY_USE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES
```
static final java.lang.String KEY_USE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - set
```
void set(java.lang.String key,
         java.lang.String value)
```
    Generic approach to setting a value corresponding to a key instead of using the specific setter method
    
    Parameters:
    
    key - a name from the list enumerated on this interface
    
    value - value corresponding to the key
  - showAttrNameForInList
```
int showAttrNameForInList()
```
    Whether to show Attr names for list conditions.
    
    Returns:
    
    one of the following: ONCE, NEVER, REPEATED, CLEAR.
  - setShowAttrNameForInList
```
void setShowAttrNameForInList(int mode)
```
    Whether to show Attr name for in list conditions according to specified argument.
    
    Parameters:
    
    mode - one of the following: ONCE, NEVER, REPEATED, CLEAR.
  - showAttrNameForElementPrompts
```
int showAttrNameForElementPrompts()
```
    Whether to show Attr element names for Attr element prompts.
    
    Returns:
    
    options: ONCE, NEVER, REPEATED, CLEAR.
  - setShowAttrNameForElementPrompts
```
void setShowAttrNameForElementPrompts(int mode)
```
    Whether to show Attr name for Attr element prompts according to specified argument.
    
    Parameters:
    
    mode - options: ONCE, NEVER, REPEATED, CLEAR.
  - newlineAttrName
```
int newlineAttrName()
```
    Whether there is a newline after the Attr name. Default is FALSE.
    
    Returns:
    
    options: TRUE, FALSE, CLEAR.
  - setNewlineAttrName
```
void setNewlineAttrName(int mode)
```
    Governs whether there is a newline after the Attr name.
    
    Parameters:
    
    mode - options: TRUE, FALSE, CLEAR
  - newlineBetweenElements
```
int newlineBetweenElements()
```
    Default is FALSE.
    
    Returns:
    
    options: TRUE, FALSE, CLEAR.
  - setNewlineBetweenElements
```
void setNewlineBetweenElements(int mode)
```
    Governs whether there is a newline between elements.
    
    Parameters:
    
    mode - options: TRUE, FALSE, CLEAR
  - trimElements
```
int trimElements()
```
    Whether whitespaces are trimmed from elements.
    
    Returns:
    
    options: TRUE, FALSE, CLEAR.
  - setTrimElements
```
void setTrimElements(int mode)
```
    Governs whether whitespaces are trimmed from elements.
    
    Parameters:
    
    mode - options: TRUE, FALSE, CLEAR
  - operatorDisplay
```
int operatorDisplay()
```
    Describes how operators are displayed, i.e. as symbols or names.
    
    Returns:
    
    options: MODE_OPERATOR_DISPLAY_SYMBOL, MODE_OPERATOR_DISPLAY_NAME, CLEAR.
  - setOperatorDisplay
```
void setOperatorDisplay(int mode)
```
    Governs how operators are displayed, i.e. as symbols or names.
    
    Parameters:
    
    mode - options: MODE_OPERATOR_DISPLAY_SYMBOL, MODE_OPERATOR_DISPLAY_NAME, CLEAR.
  - includeFormNamesInAQConditions
```
int includeFormNamesInAQConditions()
```
    Whether to include form names in attribute qualification conditions.
    
    Returns:
    
    options: TRUE, FALSE, CLEAR.
  - setIncludeFormNamesInAttrQualificationConditions
```
void setIncludeFormNamesInAttrQualificationConditions(int includeFormNames)
```
    Governs whether to include form names in attribute qualification conditions.
    
    Parameters:
    
    includeFormNames - mode options: TRUE, FALSE, CLEAR
  - parenthesesAroundConditions
```
int parenthesesAroundConditions()
```
    When parentheses are displayed around conditions.
    
    Returns:
    
    options: NEVER, ALWAYS, MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY, CLEAR.
  - setParenthesesAroundConditions
```
void setParenthesesAroundConditions(int mode)
```
    This governs usage of parentheses around conditions.
    
    Parameters:
    
    mode - options: NEVER, ALWAYS, MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY.
  - newlineBetweenConditions
```
int newlineBetweenConditions()
```
    When newlines are inserted between conditions.
    
    Returns:
    
    options: NEVER, ALWAYS, MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY, CLEAR.
  - setNewlineBetweenConditions
```
void setNewlineBetweenConditions(int mode)
```
    Governs when newlines are inserted between conditions.
    
    Parameters:
    
    mode - options: NEVER, ALWAYS, MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY.
  - logicalOperatorBetweenConditions
```
int logicalOperatorBetweenConditions()
```
    When to display logical operators.
    
    Returns:
    
    options: NEVER, ALWAYS, MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY, MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY, CLEAR.
  - setLogicalOperatorBetweenConditions
```
void setLogicalOperatorBetweenConditions(int mode)
```
    Governs when to display logical operators.
    
    Parameters:
    
    mode - options: NEVER, ALWAYS, MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY, MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY, CLEAR.
  - expandShortcutFilters
```
int expandShortcutFilters()
```
    When to expand shortcut filters.
    
    Returns:
    
    options: TRUE, FALSE, MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND, CLEAR.
  - setExpandShortcutFilters
```
void setExpandShortcutFilters(int mode)
```
    Governs when to expand shortcut filters.
    
    Parameters:
    
    mode - options: TRUE, FALSE, MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND, CLEAR.
  - delimitersAroundMetadataObjectNames
```
int delimitersAroundMetadataObjectNames()
```
    When to use delimiters around metadata object names.
    
    Returns:
    
    options: NEVER, ALWAYS, MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY, CLEAR.
  - setDelimitersAroundMetadataObjectNames
```
void setDelimitersAroundMetadataObjectNames(int delimiterCondition)
```
    Governs when to use delimiters around metadata object names.
    
    Parameters:
    
    delimiterCondition - options: NEVER, ALWAYS, MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY, CLEAR.

Interface FilterDetailsFormatting

Field Summary

Method Summary

Field Detail

DELIMITER

DELIMITER_STR

CLEAR

REPEATED

NEVER

ALWAYS

ONCE

FALSE

TRUE

MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY

MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY

MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY

MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY

MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND

MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY

MODE_OPERATOR_DISPLAY_SYMBOL

MODE_OPERATOR_DISPLAY_NAME

KEY_SHOW_ATTR_NAME_FOR_IN_LIST

KEY_SHOW_ATTR_NAME_FOR_ELEMENT_PROMPTS

KEY_NEWLINE_ATTR_NAME

KEY_NEWLINE_BETWEEN_ELEMENTS

KEY_TRIM_ELEMENTS

KEY_OPERATOR_NAME_OR_SYMBOL

KEY_INCLUDE_FORM_NAMES_IN_AQ_CONDITIONS

KEY_PARENTHESES_AROUND_CONDITIONS

KEY_NEWLINE_BETWEEN_CONDITIONS

KEY_LOGICAL_OPERATOR_BETWEEN_CONDITIONS

KEY_EXPAND_SHORTCUT_FILTERS

KEY_USE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES

Method Detail

set

showAttrNameForInList

setShowAttrNameForInList

showAttrNameForElementPrompts

setShowAttrNameForElementPrompts

newlineAttrName

setNewlineAttrName

newlineBetweenElements

setNewlineBetweenElements

trimElements

setTrimElements

operatorDisplay

setOperatorDisplay

includeFormNamesInAQConditions

setIncludeFormNamesInAttrQualificationConditions

parenthesesAroundConditions

setParenthesesAroundConditions

newlineBetweenConditions

setNewlineBetweenConditions

logicalOperatorBetweenConditions

setLogicalOperatorBetweenConditions

expandShortcutFilters

setExpandShortcutFilters

delimitersAroundMetadataObjectNames

setDelimitersAroundMetadataObjectNames