Report (FirstSpirit Developer-API)

public interface Report

FirstSpirit WebEdit Javascript Report API, accessible via

    WE_API.Report

Examples:

WE_API.Report.show("MyReport", {"pattern": "searchThis"}, true);   // search some text

Since:: 5.0.106

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`REPORT_BOOKMARKS` Report identifier: `Bookmarks`
`static String`	`REPORT_HISTORY` Report identifier: `History`
`static String`	`REPORT_MYCHANGES` Report identifier: `MyChanges`
`static String`	`REPORT_NOTIFICATIONS` Report identifier: `Notifications`
`static String`	`REPORT_RELATEDOBJECTS` Report identifier: `RelatedObjects`
`static String`	`REPORT_SEARCH` Report identifier: `Search`
`static String`	`REPORT_TASKS` Report identifier: `Tasks`

Method Summary

Methods
Modifier and Type Method and Description

void show(String report, JavaScriptObject param, boolean restart)
Opens the given report, sets parameters and maybe refreshs it.

Methods
Modifier and Type	Method and Description
`void`	`show(String report, JavaScriptObject param, boolean restart)` Opens the given report, sets parameters and maybe refreshs it.

- Field Detail
  - REPORT_BOOKMARKS
```
static final String REPORT_BOOKMARKS
```
    Report identifier: Bookmarks
    
    Since:
    
    5.0.203
    
    See Also:
    Constant Field Values
  - REPORT_HISTORY
```
static final String REPORT_HISTORY
```
    Report identifier: History
    
    Since:
    
    5.0.203
    
    See Also:
    Constant Field Values
  - REPORT_MYCHANGES
```
static final String REPORT_MYCHANGES
```
    Report identifier: MyChanges
    
    Since:
    
    5.0.203
    
    See Also:
    Constant Field Values
  - REPORT_NOTIFICATIONS
```
static final String REPORT_NOTIFICATIONS
```
    Report identifier: Notifications
    
    Since:
    
    5.0.203
    
    See Also:
    Constant Field Values
  - REPORT_RELATEDOBJECTS
```
static final String REPORT_RELATEDOBJECTS
```
    Report identifier: RelatedObjects
    
    Since:
    
    5.0.203
    
    See Also:
    Constant Field Values
  - REPORT_SEARCH
```
static final String REPORT_SEARCH
```
    Report identifier: Search
    
    Since:
    
    5.0.203
    
    See Also:
    Constant Field Values
  - REPORT_TASKS
```
static final String REPORT_TASKS
```
    Report identifier: Tasks
    
    Since:
    
    5.0.203
    
    See Also:
    Constant Field Values
- Method Detail
  - show
```
void show(@NotNull
        String report,
        @Nullable
        JavaScriptObject param,
        boolean restart)
```
    Opens the given report, sets parameters and maybe refreshs it.
    
    Parameters:
    report - report uid.
    param - map of parameters.
    restart - true to restart the report query.
    Since:
    
    5.0.106
    
    See Also:
    REPORT_BOOKMARKS, REPORT_HISTORY

Interface Report

Field Summary

Method Summary

Field Detail

REPORT_BOOKMARKS

REPORT_HISTORY

REPORT_MYCHANGES

REPORT_NOTIFICATIONS

REPORT_RELATEDOBJECTS

REPORT_SEARCH

REPORT_TASKS

Method Detail

show