Query (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.Query

All Implemented Interfaces:

Item
```
public class Query
extends BaseManager
implements Item
```
This class stores a single query.

See Also:
RecordQueriesList, CategoryQueriesList

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 QUERY_COMBINE_OPTION_BROADEN

static int QUERY_COMBINE_OPTION_NARROW

static int QUERY_COMBINE_OPTION_NEW
- Fields inherited from class com.canto.cumulus.prefs.BaseManager
  TYPE_EJP, TYPE_NATIVE

Fields
Modifier and Type	Field and Description
`static int`	`QUERY_COMBINE_OPTION_BROADEN`
`static int`	`QUERY_COMBINE_OPTION_NARROW`
`static int`	`QUERY_COMBINE_OPTION_NEW`

Method Summary

Methods
Modifier and Type	Method and Description
`JPack`	`exportSet()` Exports this query into a `JPack`.
`java.lang.String`	`getAsComplexQuery()` Returns this query as a complex query by converting a simple query into complex format.
`int`	`getCombine()` Returns the mode for combining the found records with the existing collection.
`java.lang.String`	`getDescription(int languageID)` Returns the description for the given language id.
`java.lang.String`	`getDisplayName(int languageID, boolean fallbackToDefaultName)` Returns the display name for the given language id.
`java.lang.String`	`getID()` Returns the UID of the item in the items namespace.
`java.lang.String`	`getName()` Returns the name of this query.
`java.lang.String`	`getQuery()` Returns the query string of this query.
`QueryConditionList`	`getQueryConditionList()` Returns the list of query conditions for this query.
`RestrictionsList`	`getRestrictionsList()` Returns the list of roles and users that are allowed to view this query.
`boolean`	`isComplexQuery()` Returns whether this is a complex query.
`boolean`	`isDefault()` Returns whether this item is the default item.
`boolean`	`isQueryWithConditionList()` Returns whether this is a query using a condition list or a classic query.
`boolean`	`isSharingRestricted()` Returns whether the query visibility is restricted to a group of users or roles.
`boolean`	`resultsInNewCollection()` Returns true if the search result should be shown in a new collection.
`void`	`setCombine(int value)` Sets the mode for combining the found records with the existing collection.
`void`	`setComplexQuery(boolean value)` Configures whether this is a complex query.
`void`	`setDescription(int languageID, java.lang.String description)` Sets the description for the given language.
`void`	`setDisplayName(int languageID, java.lang.String displayName)` Sets the display name for the given language.
`void`	`setQuery(java.lang.String value)` Sets the query string of this query.
`void`	`setResultsInNewCollection(boolean value)` Configures whether the search result should be shown in a new collection.
`void`	`setSharingRestricted(boolean value)` Sets whether the query visibility is restricted to a group of users or roles.

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
  - QUERY_COMBINE_OPTION_NEW
```
public static final int QUERY_COMBINE_OPTION_NEW
```
    See Also:
    Constant Field Values
  - QUERY_COMBINE_OPTION_NARROW
```
public static final int QUERY_COMBINE_OPTION_NARROW
```
    See Also:
    Constant Field Values
  - QUERY_COMBINE_OPTION_BROADEN
```
public static final int QUERY_COMBINE_OPTION_BROADEN
```
    See Also:
    Constant Field Values
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of this query.
    
    Returns:
    name of this query
  - getQuery
```
public java.lang.String getQuery()
```
    Returns the query string of this query.
    
    Returns:
    query string of this query
  - setQuery
```
public void setQuery(java.lang.String value)
```
    Sets the query string of this query.
    
    Parameters:
    value - new query string
  - isComplexQuery
```
public boolean isComplexQuery()
```
    Returns whether this is a complex query.
    
    Returns:
    true if this is a complex query
  - getAsComplexQuery
```
public java.lang.String getAsComplexQuery()
```
    Returns this query as a complex query by converting a simple query into complex format.
    
    Returns:
    query text using complex format
    Since:
    
    9.2
  - setComplexQuery
```
public void setComplexQuery(boolean value)
```
    Configures whether this is a complex query.
    
    Parameters:
    value - set to true if this is a complex query
  - resultsInNewCollection
```
public boolean resultsInNewCollection()
```
    Returns true if the search result should be shown in a new collection.
    
    Returns:
    true if the search result should be shown in a new collection
  - setResultsInNewCollection
```
public void setResultsInNewCollection(boolean value)
```
    Configures whether the search result should be shown in a new collection.
    
    Parameters:
    value - set to true if the search result should be shown in a new collection
  - getCombine
```
public int getCombine()
```
    Returns the mode for combining the found records with the existing collection. Possible values are QUERY_COMBINE_OPTION_NEW, QUERY_COMBINE_OPTION_NARROW and QUERY_COMBINE_OPTION_BROADEN. Defaults to QUERY_COMBINE_OPTION_NEW.
    
    Returns:
    mode for combining the found records with the existing collection
  - setCombine
```
public void setCombine(int value)
```
    Sets the mode for combining the found records with the existing collection. Possible values are QUERY_COMBINE_OPTION_NEW, QUERY_COMBINE_OPTION_NARROW and QUERY_COMBINE_OPTION_BROADEN.
    
    Parameters:
    value - set return mode for combining the found records with the existing collection
  - getQueryConditionList
```
public QueryConditionList getQueryConditionList()
```
    Returns the list of query conditions for this query. This list is available if this query had been constructed using the user filter UI.
    
    Returns:
    list of query conditions for this query
    Since:
    
    8.0
  - isQueryWithConditionList
```
public boolean isQueryWithConditionList()
```
    Returns whether this is a query using a condition list or a classic query.
    
    Returns:
    whether this is a query using a condition list or a classic query
    Since:
    
    8.5.1
  - getID
```
public java.lang.String getID()
```
    Returns the UID of the item in the items namespace.
    
    Specified by:
    
    getID in interface Item
    
    Returns:
    item UID
    Since:
    
    8.6
  - isDefault
```
public boolean isDefault()
```
    Returns whether this item is the default item.
    
    Specified by:
    
    isDefault in interface Item
    
    Returns:
    true if this is the default item
    Since:
    
    8.6
  - getDescription
```
public java.lang.String getDescription(int languageID)
```
    Returns the description for the given language id.
    
    Specified by:
    
    getDescription in interface Item
    
    Parameters:
    languageID - specifying the language for the description
    
    Returns:
    description text
    Since:
    
    8.6
  - setDescription
```
public void setDescription(int languageID,
                  java.lang.String description)
```
    Sets the description for the given language.
    
    Specified by:
    
    setDescription in interface Item
    
    Parameters:
    languageID - the language to set the description for
    description - the new description
    Since:
    
    8.6
  - getDisplayName
```
public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)
```
    Returns the display name for the given language id.
    
    Specified by:
    
    getDisplayName in interface Item
    
    Parameters:
    languageID - specifying the language for the display name
    fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null
    
    Returns:
    display name
    Since:
    
    8.6
  - setDisplayName
```
public void setDisplayName(int languageID,
                  java.lang.String displayName)
```
    Sets the display name for the given language.
    
    Specified by:
    
    setDisplayName in interface Item
    
    Parameters:
    languageID - the language to set the display name for
    displayName - the new display name
    Since:
    
    8.6
  - isSharingRestricted
```
public boolean isSharingRestricted()
```
    Returns whether the query visibility is restricted to a group of users or roles.
    
    Specified by:
    
    isSharingRestricted in interface Item
    
    Returns:
    true if the query visibility is restricted to a group of users or roles
    Since:
    
    8.6
  - setSharingRestricted
```
public void setSharingRestricted(boolean value)
```
    Sets whether the query visibility is restricted to a group of users or roles.
    
    Specified by:
    
    setSharingRestricted in interface Item
    
    Parameters:
    value - set to true if the query visibility should be restricted to a group of users or roles
    Since:
    
    8.6
  - getRestrictionsList
```
public RestrictionsList getRestrictionsList()
```
    Returns the list of roles and users that are allowed to view this query. Only applicable for shared queries and if isSharingRestricted() returns true.
    
    Specified by:
    
    getRestrictionsList in interface Item
    
    Returns:
    list of roles and users that are allowed to view this query
    Since:
    
    8.6
  - exportSet
```
public JPack exportSet()
```
    Exports this query into a JPack.
    
    Specified by:
    
    exportSet in interface Item
    
    Returns:
    exported data as JPack
    Since:
    
    8.1
    
    See Also:
    BaseQueriesList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)

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 Query

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

QUERY_COMBINE_OPTION_NEW

QUERY_COMBINE_OPTION_NARROW

QUERY_COMBINE_OPTION_BROADEN

Method Detail

getName

getQuery

setQuery

isComplexQuery

getAsComplexQuery

setComplexQuery

resultsInNewCollection

setResultsInNewCollection

getCombine

setCombine

getQueryConditionList

isQueryWithConditionList

getID

isDefault

getDescription

setDescription

getDisplayName

setDisplayName

isSharingRestricted

setSharingRestricted

getRestrictionsList

exportSet