CatalogLiveFilterQuery (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.usermanagement.CatalogLiveFilterQuery

```
public class CatalogLiveFilterQuery
extends BaseManager
```
This class manages all query related live filter settings for a single catalog.

See Also:
CatalogLiveFilterQuery

Nested Class Summary
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER`
`static int`	`GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER_RESULT_FOR_RECORD_FILTER`
`static int`	`GLOBAL_FILTER_FLAG_USE_RECORD_FILTER`
`static int`	`RECORD_FILTER_PARAMS_FIND_ABOVE`
`static int`	`RECORD_FILTER_PARAMS_FIND_BELOW`
`static int`	`RECORD_FILTER_PARAMS_FIND_RELATED`

Fields inherited from class com.canto.cumulus.prefs.BaseManager
TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCategoryFilter()` Returns the stored category filter query.
`int`	`getGlobalFilterFlags()` Returns which live filters should be used.
`java.lang.String`	`getRecordFilter()` Returns the current record filter query
`int`	`getRecordFilterParams()` Returns the settings for the record filter in case of a category search to also `RECORD_FILTER_PARAMS_FIND_ABOVE`, `RECORD_FILTER_PARAMS_FIND_BELOW` or `RECORD_FILTER_PARAMS_FIND_RELATED`.
`boolean`	`isCategoryFilterEnabled()` Returns true if the category filter is being used.
`boolean`	`isRecordFilterEnabled()` Returns true if the record filter is being used.
`boolean`	`isRecordFilterParamFindAbove()` Returns whether the record filter query should expand found categories to the categories above the found one.
`boolean`	`isRecordFilterParamFindBelow()` Returns whether the record filter query should expand found categories to the categories below the found one.
`boolean`	`isRecordFilterParamFindRelated()` Returns whether the record filter query should expand found categories to the categories related the found one.
`void`	`setCategoryFilter(java.lang.String value)` Sets the new category filter query
`void`	`setCategoryFilterEnabled(boolean value)` Set whether the category filter should be active.
`void`	`setGlobalFilterFlags(int value)` Sets which live filters should be used.
`void`	`setRecordFilter(java.lang.String value)` Sets the new record filter query.
`void`	`setRecordFilterEnabled(boolean value)` Sets whether the record filter should be used.
`void`	`setRecordFilterParamFindAbove(boolean value)` Sets whether the record filter query should expand found categories to the categories above the found one.
`void`	`setRecordFilterParamFindBelow(boolean value)` Sets whether the record filter query should expand found categories to the categories below the found one.
`void`	`setRecordFilterParamFindRelated(boolean value)` Sets whether the record filter query should expand found categories to the categories related the found one.
`void`	`setRecordFilterParams(int value)` Sets which query settings for the record live filter should be used.
`void`	`setUseCategoryFilterResultsForRecordFilter(boolean value)` Setting this to true overrides the stored record filter but uses a record filter that returns all records that are assigned to the categories found by the category filter.
`boolean`	`useCategoryFilterResultsForRecordFilter()` Returns true if the category filter results are used for the record query.

Methods inherited from class com.canto.cumulus.prefs.BaseManager
addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER
```
public static final int GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER
```
    See Also:
    Constant Field Values
  - GLOBAL_FILTER_FLAG_USE_RECORD_FILTER
```
public static final int GLOBAL_FILTER_FLAG_USE_RECORD_FILTER
```
    See Also:
    Constant Field Values
  - GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER_RESULT_FOR_RECORD_FILTER
```
public static final int GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER_RESULT_FOR_RECORD_FILTER
```
    See Also:
    Constant Field Values
  - RECORD_FILTER_PARAMS_FIND_ABOVE
```
public static final int RECORD_FILTER_PARAMS_FIND_ABOVE
```
    See Also:
    Constant Field Values
  - RECORD_FILTER_PARAMS_FIND_BELOW
```
public static final int RECORD_FILTER_PARAMS_FIND_BELOW
```
    See Also:
    Constant Field Values
  - RECORD_FILTER_PARAMS_FIND_RELATED
```
public static final int RECORD_FILTER_PARAMS_FIND_RELATED
```
    See Also:
    Constant Field Values
- Method Detail
  - getGlobalFilterFlags
```
public int getGlobalFilterFlags()
```
    Returns which live filters should be used. The available values GLOBAL_FILTER_FLAG_USE_RECORD_FILTER, GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER and GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER_RESULT_FOR_RECORD_FILTER are encoded as bits of the returned int.
    For easy access use isRecordFilterEnabled() or isCategoryFilterEnabled() instead.
    
    Returns:
    int value
  - setGlobalFilterFlags
```
public void setGlobalFilterFlags(int value)
```
    Sets which live filters should be used. The available values GLOBAL_FILTER_FLAG_USE_RECORD_FILTER, GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER and GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER_RESULT_FOR_RECORD_FILTER are encoded as bits of the int.
    For easy access use setRecordFilterEnabled(boolean) or setCategoryFilterEnabled(boolean) instead.
    
    Parameters:
    value - the bits OR-ed into a single int
  - setCategoryFilterEnabled
```
public void setCategoryFilterEnabled(boolean value)
```
    Set whether the category filter should be active.
    
    Parameters:
    value - true if the category filter should be used
  - getRecordFilterParams
```
public int getRecordFilterParams()
```
    Returns the settings for the record filter in case of a category search to also RECORD_FILTER_PARAMS_FIND_ABOVE, RECORD_FILTER_PARAMS_FIND_BELOW or RECORD_FILTER_PARAMS_FIND_RELATED.
    For easy access use isRecordFilterParamFindAbove(), isRecordFilterParamFindBelow() or isRecordFilterParamFindRelated() instead.
    
    Returns:
    int with OR-ed bits for the explained settings
  - isRecordFilterParamFindAbove
```
public boolean isRecordFilterParamFindAbove()
```
    Returns whether the record filter query should expand found categories to the categories above the found one.
    
    Returns:
    true if the record filter query should expand found categories to the categories above the found one
  - isRecordFilterParamFindBelow
```
public boolean isRecordFilterParamFindBelow()
```
    Returns whether the record filter query should expand found categories to the categories below the found one.
    
    Returns:
    true if the record filter query should expand found categories to the categories below the found one
  - isRecordFilterParamFindRelated
```
public boolean isRecordFilterParamFindRelated()
```
    Returns whether the record filter query should expand found categories to the categories related the found one.
    
    Returns:
    true if the record filter query should expand found categories to the categories related the found one
  - setRecordFilterParams
```
public void setRecordFilterParams(int value)
```
    Sets which query settings for the record live filter should be used. The available values RECORD_FILTER_PARAMS_FIND_ABOVE, RECORD_FILTER_PARAMS_FIND_BELOW and RECORD_FILTER_PARAMS_FIND_RELATED are encoded as bits of the int.
    For easy access use setRecordFilterParamFindAbove(boolean), setRecordFilterParamFindBelow(boolean) or setRecordFilterParamFindRelated(boolean) instead.
    
    Parameters:
    value - the bits OR-ed into a single int
  - setRecordFilterParamFindAbove
```
public void setRecordFilterParamFindAbove(boolean value)
```
    Sets whether the record filter query should expand found categories to the categories above the found one.
    
    Parameters:
    value - true if the record filter query should expand found categories to the categories above the found one
  - setRecordFilterParamFindBelow
```
public void setRecordFilterParamFindBelow(boolean value)
```
    Sets whether the record filter query should expand found categories to the categories below the found one.
    
    Parameters:
    value - true if the record filter query should expand found categories to the categories below the found one
  - setRecordFilterParamFindRelated
```
public void setRecordFilterParamFindRelated(boolean value)
```
    Sets whether the record filter query should expand found categories to the categories related the found one.
    
    Parameters:
    value - true if the record filter query should expand found categories to the categories related the found one
  - setRecordFilterEnabled
```
public void setRecordFilterEnabled(boolean value)
```
    Sets whether the record filter should be used.
    
    Parameters:
    value - true if the record filter should be used
  - setUseCategoryFilterResultsForRecordFilter
```
public void setUseCategoryFilterResultsForRecordFilter(boolean value)
```
    Setting this to true overrides the stored record filter but uses a record filter that returns all records that are assigned to the categories found by the category filter.
    
    Parameters:
    value - set to true to filter for records assigned to the found categories
  - isCategoryFilterEnabled
```
public boolean isCategoryFilterEnabled()
```
    Returns true if the category filter is being used.
    
    Returns:
    true if the category filter is being used
  - isRecordFilterEnabled
```
public boolean isRecordFilterEnabled()
```
    Returns true if the record filter is being used.
    
    Returns:
    true if the record filter is being used
  - useCategoryFilterResultsForRecordFilter
```
public boolean useCategoryFilterResultsForRecordFilter()
```
    Returns true if the category filter results are used for the record query.
    
    Returns:
    true if the category filter results are used for the record query
  - getCategoryFilter
```
public java.lang.String getCategoryFilter()
```
    Returns the stored category filter query.
    
    Returns:
    the category filter query
  - setCategoryFilter
```
public void setCategoryFilter(java.lang.String value)
```
    Sets the new category filter query
    
    Parameters:
    value - new category filter query
  - getRecordFilter
```
public java.lang.String getRecordFilter()
```
    Returns the current record filter query
    
    Returns:
    the current record filter query
  - setRecordFilter
```
public void setRecordFilter(java.lang.String value)
```
    Sets the new record filter query.
    
    Parameters:
    value - new record filter query

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class CatalogLiveFilterQuery

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

Method Summary

Methods inherited from class com.canto.cumulus.prefs.BaseManager

Methods inherited from class java.lang.Object

Field Detail

GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER

GLOBAL_FILTER_FLAG_USE_RECORD_FILTER

GLOBAL_FILTER_FLAG_USE_CATEGORY_FILTER_RESULT_FOR_RECORD_FILTER

RECORD_FILTER_PARAMS_FIND_ABOVE

RECORD_FILTER_PARAMS_FIND_BELOW

RECORD_FILTER_PARAMS_FIND_RELATED

Method Detail

getGlobalFilterFlags

setGlobalFilterFlags

setCategoryFilterEnabled

getRecordFilterParams

isRecordFilterParamFindAbove

isRecordFilterParamFindBelow

isRecordFilterParamFindRelated

setRecordFilterParams

setRecordFilterParamFindAbove

setRecordFilterParamFindBelow

setRecordFilterParamFindRelated

setRecordFilterEnabled

setUseCategoryFilterResultsForRecordFilter

isCategoryFilterEnabled

isRecordFilterEnabled

useCategoryFilterResultsForRecordFilter

getCategoryFilter

setCategoryFilter

getRecordFilter

setRecordFilter