|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.application.SearchController
public class SearchController
This object is used to perform searches on the data in the report. Search results are stored in a
Rowset object.
| Method Summary | |
|---|---|
SearchResultCursor |
createCursor(IGroupPath groupPath,
IRowsetMetaData selectedFields,
IFilter filter,
boolean recursiveGroupSearch)
Creates a cursor that allows for easy access to records in a search result. |
java.util.Locale |
getProductLocale()
|
Alerts |
getTriggeredAlerts()
Returns an array of triggered alerts. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public SearchResultCursor createCursor(IGroupPath groupPath,
IRowsetMetaData selectedFields,
IFilter filter,
boolean recursiveGroupSearch)
throws ReportSDKException
Creates a cursor that allows for easy access to records in a search result. Search results
are stored in the Rowset object. Use the RowsetSearchCursor
object's getRowset() method to retrieve the rowset.
groupPath - The group path that indicates which rowset should be searched. Use
null to specify no group path. Use an empty group path to indicate
that the search should begin at the root node.selectedFields - The fields that will be searched. These fields determine the columns
that are available in the rowset. If no group path is specified, then the result
fields and the group condition fields are used as data fields.filter - This defines the parameters for the search. That is, it specifies how the
search algorithm should match items you are looking for. Add search parameters to
the filter using the
setFilterItems
method.recursiveGroupSearch - Specify true to search subgroups in addition to
the specified group, and false to search only the current group.
RowsetSearchCursor that allows you to access records in a search
result.
ReportSDKException
public Alerts getTriggeredAlerts()
throws ReportSDKException
Returns an array of triggered alerts. This method returns the alerts that were triggered the last time the report was refreshed. To get the most current data, refresh the report before calling this method.
Alerts object containing an array of triggered alerts.
ReportSDKExceptionpublic java.util.Locale getProductLocale()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||