IQuery

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public interface IQuery
```
Defines the interface to use for implementing an IBM Cognos query.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Locale`	`getContentLocale()` Returns the preferred content locale for the session.
`java.util.Locale`	`getProductLocale()` Returns the preferred product locale for the session.
`java.lang.String[]`	`getProperties()` Returns the properties of this query object.
`IQueryOption`	`getQueryOption()` Returns information about the query options set for this query.
`ISearchExpression`	`getSearchExpression()` Returns the search expression of this query object.
`ISortProperty[]`	`getSortProperties()` Returns information about the sorting properties of this query.

- Method Detail
  - getSearchExpression
```
ISearchExpression getSearchExpression()
```
    Returns the search expression of this query object.
    
    Returns:
    
    The search expression.
  - getProperties
```
java.lang.String[] getProperties()
```
    Returns the properties of this query object.
    
    Returns:
    
    An array containing the properties of this query.
  - getSortProperties
```
ISortProperty[] getSortProperties()
```
    Returns information about the sorting properties of this query. Returns null if no sorting properties are specified.
    
    Returns:
    
    An array of the sorting properties specified in this query.
  - getQueryOption
```
IQueryOption getQueryOption()
```
    Returns information about the query options set for this query. Returns null if there are no options specified.
    
    Returns:
    
    The query options for this query.
  - getProductLocale
```
java.util.Locale getProductLocale()
```
    Returns the preferred product locale for the session. The product locale determines the the language and data format for the user interface of IBM Cognos.
    
    Returns:
    
    The product locale for the session.
  - getContentLocale
```
java.util.Locale getContentLocale()
```
    Returns the preferred content locale for the session. The content locale determines the language and data format of reports and queries in IBM Cognos.
    
    Returns:
    
    The content locale for the session.