Package de.espirit.firstspirit.webedit.client.api

Interface Report

All Superinterfaces:

org.timepedia.exporter.client.Exportable

public interface Report
extends org.timepedia.exporter.client.Exportable

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	Description
static final String	REPORT_BOOKMARKS	Report identifier: Bookmarks
static final String	REPORT_GPT	Report identifier: GPT
static final String	REPORT_HISTORY	Report identifier: History
static final String	REPORT_MYCHANGES	Report identifier: MyChanges
static final String	REPORT_NOTIFICATIONS	Report identifier: Notifications
static final String	REPORT_RECENTELEMENTS	Report identifier: RecentElements
static final String	REPORT_RELATEDOBJECTS	Report identifier: RelatedObjects
static final String	REPORT_SEARCH	Report identifier: Search
static final String	REPORT_TASKS	Report identifier: Tasks

Method Summary

Modifier and Type	Method	Description
void	refresh(@NotNull String report)	Refreshes the specified report.
void	show(@NotNull String report, @Nullable com.google.gwt.core.client.JavaScriptObject param, boolean restart)	Opens the given report, sets parameters and maybe refreshes it.

Field Details

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_RECENTELEMENTS

static final String REPORT_RECENTELEMENTS

Report identifier: RecentElements

Since:

NEXT_STABLE

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

REPORT_GPT

@Internal
static final String REPORT_GPT

Report identifier: GPT

See Also:

• Constant Field Values

Method Details

show

void show(@NotNull
 @NotNull String report,
 @Nullable
 @Nullable com.google.gwt.core.client.JavaScriptObject param,
 boolean restart)

Opens the given report, sets parameters and maybe refreshes it.

Parameters:

report - The report to be shown, which is either a standard report like "Bookmarks" or the name of the report plugin like "com.example.CustomDataAccessPlugin".

param - map of parameters.

restart - true to restart the report query.

Since:

5.0.106

See Also:

• REPORT_BOOKMARKS
• REPORT_HISTORY

refresh

void refresh(@NotNull
 @NotNull String report)

Refreshes the specified report.

Parameters:

report - The report to be refreshed, which is either a standard report like "Bookmarks" or the name of the report plugin like "com.example.CustomDataAccessPlugin".

Since:

1.58