ReportManager Class Methods
In this section, the ReportManager class methods are presented in alphabetical order.
Syntax
AddSearchFieldCriteria(&SearchAttribute)
Description
Use the AddSearchFieldCriteria method to add an already instantiated and populated SearchAttribute object to the search.
Parameters
|
Field or Control |
Definition |
|---|---|
| &SearchAttribute |
Specify an already instantiated and populated SearchAttribute object. |
Returns
A Boolean, true if the criteria was added successfully, false otherwise.
Example
Local PSXP_REPORTMGR:SearchAttribute &oSearch;
Local integer &compOpSrch;
&CompOpSrch = oRptMgr.PSXP_SrchBegins;
&oSearch = create PSXP_REPORTMGR:SearchAttribute(&sAttrname, &sAttrVal, &compOpSrch);
&bResult = &oRptMgr.addSearchFieldCriteria(&oSearch);Syntax
GetReportList()
Description
Use the GetReportList method to return a list of the report objects that satisfy all the criteria you specified with the other methods associated with the ReportManager object.
Parameters
None.
Returns
An array of Report objects.
Syntax
SetBurstFieldCriteria(BurstFld, BurstOp, BurstValue)
Description
Use the SetBurstFieldCriteria method to specify the burst criteria to be used with searching report definitions.
Parameters
|
Field or Control |
Definition |
|---|---|
| BurstField |
Specify the name of the burst field used to generate the report, as a string. |
| BusrtOp |
Specify the search operator to be used BurstField, as a string. |
| BurstValue |
Specify the pattern string to be matched with burst field value using BurstOp. |
Returns
A Boolean value, true if the method completes successfully, false otherwise.
Syntax
SetCaseSensitive(IsCaseSensitive)
Description
Use the SetCaseSensitive method to specify the case sensitivity flag applicable to search field and bursting criteria for searching reports.
Parameters
|
Field or Control |
Definition |
|---|---|
| IsCaseSensitive |
Specify a Boolean value: true to make the search case sensitive, false to make it case insensitive. |
Returns
None.
Syntax
SetDateCriteria(createdDate, createdLastVal, createdUnit)
Description
Use the SetDateCriteria method to specify the creation date criteria for searching reports.
Parameters
|
Field or Control |
Definition |
|---|---|
| createdDate |
Specify a date used to search for reports generated on and after this date. You should specify a null value (" ") for this parameter if using createdLastVal and createdUnit. |
| createdLastVal |
Specify a value to be used n conjunction with createdUnit, as a number. If you specify a value, it is used and any value given for createdDateis ignored. If you are not using this search criteria, you should specify a null value (" ") for this parameter. |
| createdUnit |
Specify a value to be used for reports generated during last n number of periodic units. This value is used with createdLasVal. For example, if createdLastVal is set to 10, and createdUnit is set to 1, the reports generated in the last ten days are returned. Valid values are: |
|
Value |
Description |
|---|---|
|
1 |
Days |
|
2 |
Hours |
|
3 |
Minutes |
Returns
None.
Syntax
SetFolderCriteria(FolderName)
Description
Use the SetFolderCriteria method to specify the folder criteria for searching reports.
Parameters
|
Field or Control |
Definition |
|---|---|
| FolderName |
Specify the name of the folder the report is posted in, as a string. |
Returns
A Boolean value, true if the search criteria is added successfully, false otherwise.
Syntax
SetProcessInstanceCriteria(FromPID, ToPID)
Description
Use the SetProcessInstanceCriteria method to specify the process instance range criteria for searching reports.
Parameters
|
Field or Control |
Definition |
|---|---|
| FromPID |
Specify a process instance ID to be used as the starting range from which to search, as a number. This value must be less than or equal to ToPID. You can specify a null value for this parameter, that is, (" "). |
| ToPID |
Specify a process instance ID to be used as the ending range from which to search, as a number. This value must be greater than or equal to FromPID. You can specify a null value for this parameter, that is, (" "). |
Returns
A Boolean value: true if the search criteria is added successfully, false otherwise.
Syntax
SetReportIDCriteria(ReportId)
Description
Use the SetReportIDCriteria method to specify a report ID for searching reports.
Parameters
|
Field or Control |
Definition |
|---|---|
| ReportId |
Specify a report ID to be used for searching for report definitions. |
Returns
A Boolean value: true if the search criteria was set successfully, false otherwise.
Syntax
SetUserIdCriteria(UserId)
Description
Use the SetUserIdCriteria method to specify a user ID to be used for searching reports intended to be accessed by that recipient.
Parameters
|
Field or Control |
Definition |
|---|---|
| UserId |
Specify the user ID to be matched with the intended recipient of the report. |
Returns
A Boolean: true if the search criteria is set successfully, false otherwise.