IQueryOption

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public interface IQueryOption
```
Describes the interface to use for accessing IBM Cognos query options.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getMaxCount()` Returns the maximum number of objects to retrieve when generating the result set.
`java.lang.String[]`	`getRefProps(java.lang.String thePropertyName)` Returns the names of properties to be retrieved for objects referred to by the specified property.
`long`	`getSkipCount()` Returns the number of objects to skip when generating the result set.

- Method Detail
  - getMaxCount
```
long getMaxCount()
```
    Returns the maximum number of objects to retrieve when generating the result set.
    
    Returns:
    
    The maximum number of objects to retrieve.
  - getSkipCount
```
long getSkipCount()
```
    Returns the number of objects to skip when generating the result set.
    
    Returns:
    
    The number of objects to skip.
  - getRefProps
```
java.lang.String[] getRefProps(java.lang.String thePropertyName)
```
    Returns the names of properties to be retrieved for objects referred to by the specified property. For example, if the property specified is a group, it may refer to accounts which in turn have properties that should be retrieved. Returns null if there are no additional properties.
    
    Parameters:
    
    thePropertyName - The name of the property for which to return properties of referenced objects.
    
    Returns:
    
    An array of names of properties belonging to the objects referenced by the specified property.